Skip to main content

Bulkprocessstatus

Holds information about the status of a bulk process

errors object[]

List of errors

  • Array [
  • errorCodeinteger<int32>

    Numeric value associated to the error reason

    errorReasonstring

    For more information on your error message, refer to API Response and Error Codes

    errorSourcestring

    Details about the error

    externalIdstring

    Optional field populated only when request payload contains an externalId

    indexInRequestinteger<int32>

    The index of the entity/item from bulk request that failed on processing

  • ]
  • processedItems object[]

    List of successful processed items

  • Array [
  • externalIdstring

    Optional field populated only when request payload contains an externalId

    idstring

    Unique identifier for the newly created resource

    indexInRequestinteger<int32>

    The index of the entity/item from bulk request that failed on processing

  • ]
  • statusstring

    Represents the execution status of a background process

    Possible values: [QUEUED, IN_PROGRESS, COMPLETE, NOT_FOUND, CANCEL, TO_BE_CANCELED, TIMED_OUT, ERROR, TRANSIENT_ERROR, OVERRIDDEN, RECOVERABLE_ERROR]

    Bulkprocessstatus
    {
    "errors": [
    {
    "errorCode": 0,
    "errorReason": "string",
    "errorSource": "string",
    "externalId": "string",
    "indexInRequest": 0
    }
    ],
    "processedItems": [
    {
    "externalId": "string",
    "id": "string",
    "indexInRequest": 0
    }
    ],
    "status": "QUEUED"
    }