Fetch Background Job Entries API

If you want to get the status of the individual entries supplied to the background job you can do so with this api

Response

_data field returns an array of background job entries

_meta returns meta information like total entries and the path for the next page of data

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
  "_data": [
    {
      "id": "e9bc853c-0af7-414c-bc7b-ccc7a40aa510",
      "createdAt": 1617966536310,
      "updatedAt": 1617966539528,
      "data": {
        "apiData": {
          "processId": "1e50dd73-9ce6-405b-932a-9c4c5e7b5599",
          "procedureId": "f3eb37a9-b54e-4088-bc5f-948d37f8aa62",
          "processUpdate": {
            "data": {
              "lead_id": "100"
            }
          }
        },
        "apiType": "process:ext-update"
      },
      "validationStatus": "SUCCESS",
      "validationMessage": "",
      "validationResult": null,
      "completionStatus": "SUCCESS",
      "completionMessage": "",
      "completionResult": null,
      "team": "d3e64510-b75a-43a0-8ae5-dde78dac56c0",
      "backgroundJob": "19632427-908f-4bf3-a6f5-69b9a0bbfc63",
      "createdBy": "5acc9b3b-9850-422b-81ce-22b01cb74356"
    },
    {
      "id": "8bbaa9b5-14d9-4594-b68f-053e362ff5b3",
      "createdAt": 1617966536310,
      "updatedAt": 1617966537260,
      "data": {
        "apiData": {
          "processId": "1e50dd73-9ce6-405b-932a-9c4c5e7b5599",
          "procedureId": "f3eb37a9-b54e-4088-bc5f-948d37f8aa62",
          "processUpdate": {
            "data": {
              "lead_id": "100"
            }
          }
        },
        "apiType": "process:ext-update"
      },
      "validationStatus": "SUCCESS",
      "validationMessage": "",
      "validationResult": null,
      "completionStatus": "ERROR",
      "completionMessage": "",
      "completionResult": null,
      "team": "d3e64510-b75a-43a0-8ae5-dde78dac56c0",
      "backgroundJob": "19632427-908f-4bf3-a6f5-69b9a0bbfc63",
      "createdBy": "5acc9b3b-9850-422b-81ce-22b01cb74356"
    }
  ],
  "_meta": {
    "total": 770,
    "next": "/v1/ext/background-job/19632427-908f-4bf3-a6f5-69b9a0bbfc63/entries?skip=2limit=2"
  }
}

Fetch Background Job Entries API

Response#

Request

Request Code Samples

Responses

Response