EPCIS Capture

EPCIS capture collection manages the execution and monitoring of EPCIS data capture requests, handling the processing and ingestion of supply chain event data with error handling and status tracking.

The epcis_capture Object

EPCIS capture collection tracks batch processing jobs for ingesting EPCIS event data, providing execution status, timing information, and error handling capabilities for reliable data capture operations.

Field Name	Type	Description
id	string	Primary key. Unique identifier for the EPCIS capture job (UUID format).
date_created	datetime	Timestamp when the capture job was created.
date_updated	datetime	Timestamp when the capture job was last updated.
date_finished	datetime	Timestamp when the capture job finished execution (null if still running).
running	boolean	Flag indicating if the capture job is currently running.
success	boolean	Flag indicating if the capture job completed successfully.
capture_error_behaviour	string	Error handling behavior for the capture process. Default: "proceed". Values: "proceed", "rollback".
errors	string	Error messages and details if the capture job encountered issues during processing.
context	object	JSON object containing the JSON-LD header context for the capture job.

---

List EPCIS Capture Jobs

List existing EPCIS capture jobs.

REST

GET /items/epcis_capture

GraphQL

query {
  epcis_capture {
    id
    date_created
    date_updated
    date_finished
    running
    success
    capture_error_behaviour
    errors
  }
}

Query Parameters

Supports all global query parameters.

Returns

An array of up to limit EPCIS capture objects. If no items are available, data will be an empty array.

---

Retrieve an EPCIS Capture Job

Retrieve a specific EPCIS capture job by ID.

REST

GET /items/epcis_capture/:id

GraphQL

query {
  epcis_capture_by_id(id: "epcis_capture_id") {
    id
    date_created
    date_updated
    date_finished
    running
    success
    capture_error_behaviour
    errors
  }
}

Returns

Returns an EPCIS capture object if a valid primary key was provided.

---

Sample Data

Example JSON response for a capture record query

{
    "data": {
        "id": "0a50da0d-20d6-4063-95b0-1d5876f7756d",
        "date_created": "2025-06-19T05:48:06.000Z",
        "date_updated": "2025-06-19T05:48:06.000Z",
        "date_finished": "2025-06-19T05:48:06.000Z",
        "running": false,
        "success": true,
        "capture_error_behaviour": "proceed",
        "errors": null
    }
}