Get current details of an async event job.

Request

Get current details of an async event job

Security

Bearer

Bodyapplication/jsonrequired

companyIdstringrequired

Company Id for which job was created.

Example:"c5977a9b-095a-40be-a1bb-b9d3c894e4a5"

filtersobject(AsyncJobFilter)

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/jobs/status \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyId": "c5977a9b-095a-40be-a1bb-b9d3c894e4a5",
    "filters": {
      "filterType": "JOB_ID_FILTER",
      "jobId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"
    }
  }'

Responses

Async job details.

Bodyapplication/json

jobIdstring, (uuid)

Job Id for the async event job.

Example:"f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"

referenceIdstring

Reference Id associated with the job.

Example:"8859676988"

typestring(EventJobType)

Job type.

Enum:"PUBLISH""MODIFY""CANCEL""SEND_INVITE"

Example:"PUBLISH"

statusstring(EventJobStatus)

Job status.

Enum:"IN PROGRESS""COMPLETED"

Example:"COMPLETED"

totalItemsinteger

Total number of items which are being processed by the job.

Example:42

successCountinteger

Success item count.

Example:41

failureCountinteger

Failure item count.

Example:1

jobItemsArray of objects(JobItem)

Failed item array.

createdAtobject(DateTimeOffset)

Created date time for an job.

completedAtobject(DateTimeOffset)

Updated date time for an job.

Response

{
  "jobId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
  "referenceId": "8859676988",
  "type": "PUBLISH",
  "status": "COMPLETED",
  "totalItems": 42,
  "successCount": 41,
  "failureCount": 1,
  "jobItems": [
    { … }
  ],
  "createdAt": {
    "iso8601": "2017-07-21T17:32Z"
  },
  "completedAt": {
    "iso8601": "2017-07-21T17:32Z"
  }
}