Skip to main content
GET
Get capture job

Authorizations

X-API-Key
string
header
required

Path Parameters

capture_id
string
required

The captureID returned by POST /capture.

Response

OK

202 response body for an accepted EPCIS capture (C-5404).

Mirrors the GS1 EPCIS 2.0 capture-job resource: running and success are the two booleans the standard specifies, and reading them together is what lets a client distinguish "not finished yet" from "finished and failed". The same body is returned by GET /capture/{captureID}, so a client can treat the POST response as its first poll.

errors carries RFC 9457 problem objects. Each has sequenceInEPCISDoc — the indices of the offending events in the document you submitted — which is what makes a rejection on a large file actionable rather than merely true.

captureID
string
required

Identifier of the capture job; poll GET /capture/{captureID}.

createdAt
string
required

ISO-8601 timestamp the job was accepted.

running
boolean
required

True while the job is still processing.

success
boolean
required

True only when every event in the document was captured. False while running — a job that has not finished is not a success yet.

captureErrorBehaviour
string
required

Behaviour applied: rollback (default) or proceed, from GS1-Capture-Error-Behaviour.

finishedAt
string | null

ISO-8601 timestamp processing ended; null while running.

errors
Errors · object[]

RFC 9457 problem objects, each carrying sequenceInEPCISDoc.