Reference Guide

SupportAssist Enterprise
32 REST API Guide – SupportAssist Enterprise
The following is an example of a JSON for editing the device details.
Request body:
{
"id":"<device_id_to_be_update>",
“credentialAccountId”:”<Credential_account_to_update>”,
"friendlyName":"<provided_name_to_Update>",
"address":"<IP Address/hostname>",
"deviceGroupInformation":{"name":"<group name>"}
}
Response format (Accepted – response code 202):
{
"operationId": "<operation_id>",
"operationType": "DiscoverDevice",
"status": "QUEUED",
"additionalInfo": null
}
Job success status response
{
"operationId": "<operation_id>",",
"operationType": "EditDevice",
"status": "SUCCESS",
"additionalInfo": [
{
"errorCode": "SA-90100",
"message": "Operation successful.",
"additionalInfo": "<device_id>","
}
]
}
Note: A device group would only be assigned if the devices are not in the Staging area.
2.6.3 Delete devices
The following resource URI is used to delete devices:
https://<BASE_URI>/SupportAssist/api/v1/Device/{<Device_Id>}
Note: You can delete only one device in a single operation.
Method: DELETE
Headers:
Content-Type: application/json
Authorization: Bearer <Authentication_Token>
Response format (success – response code 204): none