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.

query GetStatus {
  getStatus(id: 108) {
    id
    status
    updatedAt
    totalRecordCount
    successRecordCount
    failureRecordCount
    details
  }
}

Properties

Name Type Description Required or Optional Available Version
id Integer The unique identifier of the asynchronous job. This ID is returned by mutations such as upsertCI when an asynchronous operation is initiated. Required 66.0

Response

JSON example

This example is a sample response from the getStatus query.

{
  "data": {
    "getStatus": {
      "id": 108,
      "status": "Completed",
      "updatedAt": "2025-11-14T10:16:05.123456Z",
      "details": "Job completed - Upsert CI - Canonical API (5 items)",
      "totalRecordCount": 5,
      "successRecordCount": 5,
      "failureRecordCount": 0
    }
  }
}

Properties

Name Type Description Available Version
id Integer The ID of the job or operation. 66.0
status String The current status of the job. 66.0
updatedAt String The date and time when the job status was last updated, in YYYY-MM-DDTHH:MM:SSZ format. 66.0
details String User message that provides additional context about the job status or completion. 66.0
totalRecordCount Integer The total number of records processed in the job. 66.0
successRecordCount Integer The number of records that were successfully processed. 66.0
failureRecordCount Integer The number of records that failed to process. 66.0