Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
lookupManagement

Get the status of an async job.

Retrieve the status of a previously made request. If the request was successful, the status of the response object will be Success.

get/v1/lookupTables/jobs/{jobId}/status

Path parameters

jobIdstring required
Example:0000000001C41AA3

An identifier returned in response to an asynchronous request.

Response

The status of async job with given identifier.

jobIdstring required

An identifier returned in response to an asynchronous request.

statusstring required

Whether or not the request is pending (Pending), in progress (InProgress), has completed successfully (Success), has completed partially with warnings (PartialSuccess) or has completed with an error (Failed).

statusMessagesstring[]

Additional status messages generated if any if the status is Success.

lookupContentIdstring required

Content id of lookup table on which this operation was performed.

lookupNamestring required

Name of lookup table on which this operation was performed.

lookupContentPathstring required

Content path of lookup table on which this operation was performed.

requestTypestring

Type of asynchronous request made:

  • BulkMerge
  • BulkReplace
  • Truncate
userIdstring required

User id of user who initiated this operation.

createdAtstring date-time required

Creation time of this job in UTC.

modifiedAtstring date-time required

Timestamp in UTC when status was last updated.

Example response

{
  "jobId": "0000000001C41EF2",
  "errors": [
    {
      "code": "auth:password_too_short",
      "message": "Your password was too short.",
      "detail": "Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.",
      "meta": {
        "minLength": 12,
        "actualLength": 5
      }
    }
  ],
  "warnings": [
    {
      "message": "60 rows were dropped.",
      "cause": "Primary key values were duplicate."
    }
  ],
  "lookupContentId": "0000000001C41EE4",
  "lookupName": "sampleLookup",
  "lookupContentPath": "/Library/Users/xyz@demo.com/sampleLookup",
  "requestType": "BulkMerge",
  "userId": "0000000006743FDD",
  "createdAt": "2018-10-16T09:10:00Z",
  "modifiedAt": "2018-10-16T09:10:00Z"
}