Batch Item

A record associated with a batch in which a particular action was performed.

createdAt
string <date-time>

The time the batch_item was created at.

data
string <= 16777215 characters

The data requested to execute the batch item.

failed
boolean

Whether this batch item failed during processing.

info
string <= 767 characters

A description of the failure if one exists.

state
string <= 255 characters

The current state of the batch item.

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "data": "string",
  • "failed": true,
  • "info": "string",
  • "state": "string"
}

Batch Item Relationships

data (object) or links (object) (batch)

The batch associated with this record.

{
  • "batch": {
    }
}

⌵ Batch Item Actions

Get a Collection of Batch Items

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/batchItems
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Get a Batch Item by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/batchItems/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}