Sign in

v1

latestOpenAPI 3.1.02026-08-0624411242.2 KB
Events

Get current details of an async event job.

Get current details of an async event job

post/v2/events/jobs/status

Request body

companyIdstring required

Company Id for which job was created.

Example request

{
  "companyId": "c5977a9b-095a-40be-a1bb-b9d3c894e4a5",
  "filters": {
    "jobId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"
  }
}

Response

Async job details.

jobIdstring uuid

Job Id for the async event job.

referenceIdstring

Reference Id associated with the job.

type'PUBLISH' | 'MODIFY' | 'CANCEL' | 'SEND_INVITE'

Event job type enum.

status'IN PROGRESS' | 'COMPLETED'

Event job status enum.

totalItemsinteger

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

successCountinteger

Success item count.

failureCountinteger

Failure item count.

Example response

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