Get Status of Operation

Retrieve the status of a previously submitted asynchronous job. For example, upsertCI a bulk upsert operation. Use this query to check the progress and completion status of the asynchronous operations.

Special Access Rules 

To query an operation status, you must have the following user permissions:

  • IT Service Configuration Item Type Manager
  • IT Service Configuration Item Owner

Request 

JSON example 

This example shows a sample request to get the status of an asynchronous job.

1query GetStatus {
2  getStatus(id: 108) {
3    id
4    status
5    updatedAt
6    totalRecordCount
7    successRecordCount
8    failureRecordCount
9    details
10  }
11}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
idIntegerThe unique identifier of the asynchronous job. This ID is returned by mutations such as upsertCI when an asynchronous operation is initiated.Required66.0

Response 

JSON example 

This example is a sample response from the getStatus query.

1{
2  "data": {
3    "getStatus": {
4      "id": 108,
5      "status": "Completed",
6      "updatedAt": "2025-11-14T10:16:05.123456Z",
7      "details": "Job completed - Upsert CI - Canonical API (5 items)",
8      "totalRecordCount": 5,
9      "successRecordCount": 5,
10      "failureRecordCount": 0
11    }
12  }
13}

Properties 

NameTypeDescriptionAvailable Version
idIntegerThe ID of the job or operation.66.0
statusStringThe current status of the job.66.0
updatedAtStringThe date and time when the job status was last updated, in YYYY-MM-DDTHH:MM:SSZ format.66.0
detailsStringUser message that provides additional context about the job status or completion.66.0
totalRecordCountIntegerThe total number of records processed in the job.66.0
successRecordCountIntegerThe number of records that were successfully processed.66.0
failureRecordCountIntegerThe number of records that failed to process.66.0