Skip to content
/Jobs

Jobs

Inspect asynchronous operation status and results.

Operations

Get job

Request

Read an initiated operation after checking its underlying workflow authority.

Security
bearerAuth
Path
idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/engage/openapi/v1/jobs/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Current resource or page.

Headers
X-Request-Idstring, (uuid)required

Identifier for tracing this response.

Bodyapplication/json
idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
commandstringrequired
resourceIdstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
statestringrequired
Enum:"queued""running""waiting_for_approval""succeeded""partially_failed""failed""cancelling""cancelled""recovery_required"
createdAtstringrequired
updatedAtstringrequired
resultobject or nullrequired
Any of:
pollAfterSecondsnumberrequired
Response
{
  "id": "string",
  "command": "string",
  "resourceId": "string",
  "state": "queued",
  "createdAt": "string",
  "updatedAt": "string",
  "result": {
    "resourceId": "string",
    "revision": "string",
    "insertedTotal": -9007199254740991,
    "updatedTotal": -9007199254740991,
    "deletedTotal": -9007199254740991,
    "items": [ … ],
    "succeeded": 0,
    "failed": 0,
    "secretAvailable": false
  },
  "pollAfterSeconds": 0
}