Check process status

Returns the status of one or more processes started by the Mindtickle user APIs, by process ID.

View as Markdown

Prerequisites

Authentication and setup: A valid access token.
Users: A user API call that returned process IDs.

Endpoint

POST /services/data/v2.0/status

Base URL: the standard REST host for your region. See Base URLs.

Headers: Authorization: Bearer ACCESS_TOKEN, Content-Type: application/json.

Request

Parameter	Type	Required	Description
`processIds`	Array[string]	Required	ID of the process. Send each ID as a separate string in the JSON array.

Request example

{
  "processIds": ["1234567890123456101", "1234567890123456102", "1234567890123456103"]
}

Send the request

Set BASE_URL to the standard REST host for your region and ACCESS_TOKEN to your access token. Replace PROCESS_ID with a process ID returned by the original request:

curl --request POST \
  --url "${BASE_URL:?Set BASE_URL}/services/data/v2.0/status" \
  --header "Authorization: Bearer ${ACCESS_TOKEN:?Set ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{"processIds":["PROCESS_ID"]}'

Read status[PROCESS_ID] in the response. QUEUED and RUNNING mean processing is incomplete; check again while respecting the rate limits. SUCCESS and FAILED are final states. The top-level taskCompleted flag describes the status-check request, not the original operation.

Response

Field	Type	Description
`requestId`	string or null	Request identifier. The response examples return `null`.
`responseCode`	integer	Special response codes from the server.
`responseType`	string	Type of response from the server.
`taskCompleted`	boolean	Completion flag for the status-check request. Read each entry in `status` to determine whether the original process has finished.
`status`	StatusMap	Process ID and the corresponding status: `QUEUED`, `RUNNING`, `SUCCESS`, or `FAILED`.

Response example

{
  "requestId": null,
  "responseCode": 0,
  "responseType": "STATUS_CHECK_RESPONSE",
  "taskCompleted": true,
  "status": {
    "1234567890123456101": "SUCCESS",
    "1234567890123456102": "SUCCESS",
    "1234567890123456103": "SUCCESS"
  }
}