API REFERENCE · SCHEMA
BatchDetail schema
Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.
All endpoints and schemasidRequired- string
Format: uuid.
nameRequired- string
environmentRequired- string
Values: "sandbox", "production".
statusRequired- string
Values: "importing", "pending", "processing", "completed", "cancelled", "failed".
totalRequired- integer
Minimum: 0.
completedRequired- integer
Minimum: 0.
failedRequired- integer
Minimum: 0.
created_atRequired- string
Format: date-time.
cancelled_atRequired- string or null
May be null.
cancelled_at fields and rules
Allowed alternatives
- string
Format: date-time.
- null
May be null.
- string
rowsRequired- object[]
Current row outcomes for this page, ordered by one-based row_number. A failed row contains error; retrieve completed evidence using screening_id.
rows item fields
Each array item: object.
rows[]Required.row_number - integer
Minimum: 1.
rows[]Required.status - string
Values: "pending", "completed", "failed", "cancelled".
rows[]Required.screening_id - string or null
May be null.
rows[].screening_id fields and rules
Allowed alternatives
- string
Format: uuid.
- null
May be null.
- string
rows[]Required.error - object or null
May be null.
rows[].error fields and rules
Allowed alternatives
- Provide rows[].error.code and rows[].error.message.
rows[]Required.error .code - string
rows[]Required.error .message - string
- null
May be null.
- Provide rows[].error.code and rows[].error.message.
nextOffsetRequired- integer or null
Pass this integer as the next offset. Null means all currently counted rows were returned; an importing batch may not have its final total yet.
May be null.
nextOffset fields and rules
Allowed alternatives
- integer
Minimum: 0.
- null
May be null.
- integer