Reference Guide

SupportAssist Enterprise
27 REST API Guide – SupportAssist Enterprise
2.5 Retrieve Job status
The following resource URI is used to retrieve the status of asynchronous operations:
https://<BASE_URI>/SupportAssist/api/v1/OperationStatus/<operation_Id>
Note: The following are the types of Asynchronous operations: “add device”, “edit device”, “restore device and
groups”, “assign profile”, “execute discovery rule”, and “collection”.
{
"type" : "object",
"id" : "OperationStatus",
"properties" : {
"operationId" : {
"type" : "string"
},
"operationType" : {
"type" : "string",
"enum" : ["DiscoverDevice", "ExecuteDeviceDiscoveryRule",
"AssignDevicesToProfile", "EditDevice", "RunDiagnostics", "ImportDevice"]
},
"status" : {
"type" : "string",
"enum" : ["SUCCESS", "QUEUED", "INPROGRESS", "COMPLETED", "FAILED"]
"additionalInfo" : {
"type" : "array"
}
}
}
Method: GET
Headers:
Authorization: Bearer <Authentication_Token>
Request body: none required
Response format (success – response code 200):
{
"operationId": "<operation_id>",
"operationType": "DiscoverDevice",
"status": "QUEUED",
"additionalInfo": null
}
Note: The additionalInfo object contains details about the failure and success status. For a failure status, the
object contains the map of the error code and error messages. For a success status, the object contains the list of
entity IDs.
Note: The related Job status examples are described along with the response format in the relevant sections of
this document.