{
"opencollection": "1.0.0",
"info": {
"name": "EPCIS 2.0 REST Bindings",
"version": "2.0.1"
},
"items": [
{
"info": {
"name": "Discovery",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns the list of top level resources available for this EPCIS repository.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
}
]
},
"docs": "This endpoint returns all the top-level resources currently available in the repository.\n"
},
{
"info": {
"name": "Query server settings, EPCIS version(s) and related vocabularies/standards.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/"
},
"docs": "`OPTIONS` on the root path gives the client an overview of the server's EPCIS-related configurations.\n"
},
{
"info": {
"name": "Discover the settings of the capture interface.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/capture",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
]
},
"docs": "The `OPTIONS` method is used as a discovery service for `/capture`. It describes\n- which EPCIS and CBV versions are supported,\n- the EPCIS and CBV extensions,\n- the maximum payload size as count of EPCIS events (`GS1-EPCIS-Capture-Limit` header) or as a maximum payload size in bytes (`GS1-EPCIS-Capture-File-Size-Limit` header)\n- what the server will do if an error occurred during capture (`GS1-Capture-Error-Behaviour` header).\nThe list of headers is not exhaustive. It only describes the function"
},
{
"info": {
"name": "Query the metadata of the capture job endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/capture/:captureID",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "captureID",
"value": "id9261379075",
"type": "path",
"description": "A unique value identifying a capture job generated by the server."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used for a given capture job.\n"
},
{
"info": {
"name": "Query metadata for the EPCIS events endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query metadata for the endpoint to access an individual EPCIS event.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/events/:eventID",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "eventID",
"value": "ni:///sha-256;df7bb3c352fef055578554f09f5e2aa41782150ced7bd0b8af24dd3ccb30ba69?ver=CBV2.0",
"type": "path",
"description": "The ID of an EPCIS event. An EPCIS event ID must be unique across all events in the system.\n"
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query metadata for the EPCIS event types endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/eventTypes",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query metadata of the EPCIS event type endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/eventTypes/:eventType",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "eventType",
"value": "ObjectEvent",
"type": "path",
"description": "Names of EPCIS event types.\n"
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the endpoint to access EPCIS events by event type.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/eventTypes/:eventType/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "eventType",
"value": "ObjectEvent",
"type": "path",
"description": "Names of EPCIS event types.\n"
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query metadata related to the electronic product codes endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/epcs",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query metadata of the electronic product code.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/epcs/:epc",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "epc",
"value": "urn:epc:id:sgtin:0614141.107346.2018",
"type": "path",
"description": "An electronic product code value."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the endpoint to access EPCIS events by EPC in a URN or constrained GS1 Digital Link form (URL encoded).",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/epcs/:epc/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "epc",
"value": "urn:epc:id:sgtin:0614141.107346.2018",
"type": "path",
"description": "An electronic product code value."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query metadata related to the business steps endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/bizSteps",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query metadata of the endpoint to access an individual business step.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/bizSteps/:bizStep",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "bizStep",
"value": "urn:epcglobal:cbv:bizstep:receiving",
"type": "path",
"description": "A business step value."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the endpoint to access EPCIS events by business step.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/bizSteps/:bizStep/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "bizStep",
"value": "urn:epcglobal:cbv:bizstep:receiving",
"type": "path",
"description": "A business step value."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata related to the business locations endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/bizLocations",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the endpoint to access an individual business location.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/bizLocations/:bizLocation",
"params": [
{
"name": "bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.0",
"type": "path",
"description": "A business location value."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the endpoint to access EPCIS events by business location.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/bizLocations/:bizLocation/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.0",
"type": "path",
"description": "A business location value."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata related to the read points endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/readPoints",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the endpoint to access an individual read point.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/readPoints/:readPoint",
"params": [
{
"name": "readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "path",
"description": "A read point value."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the endpoint to access EPCIS events by read point.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/readPoints/:readPoint/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "path",
"description": "A read point value."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata related to the dispositions endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/dispositions",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the endpoint to access an individual disposition.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/dispositions/:disposition",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "disposition",
"value": "in_progress",
"type": "path",
"description": "A disposition value."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the endpoint to access EPCIS events by disposition.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/dispositions/:disposition/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "disposition",
"value": "in_progress",
"type": "path",
"description": "A disposition value."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the EPCIS queries endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/queries",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the named queries endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/queries/:queryName",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "queryName",
"value": "",
"type": "path",
"description": "The name of an EPCIS event query."
}
]
},
"docs": "EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions\nof EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV\nversions are used.\n"
},
{
"info": {
"name": "Query the metadata of the subscriptions endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/queries/:queryName/subscriptions",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "queryName",
"value": "",
"type": "path",
"description": "The name of an EPCIS event query."
}
]
},
"docs": "The `OPTIONS` method is used as a discovery service for query subscriptions.\n"
},
{
"info": {
"name": "Query the metadata of the endpoint for an individual subscription.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/queries/:queryName/subscriptions/:subscriptionID",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "queryName",
"value": "",
"type": "path",
"description": "The name of an EPCIS event query."
},
{
"name": "subscriptionID",
"value": "df5a33e3-5aa3-4403-ae01-99b83234e27b",
"type": "path"
}
]
},
"docs": "The `OPTIONS` method is used to discover capabilities for a query subscription.\n"
},
{
"info": {
"name": "Query the metadata of the EPCIS events query result endpoint.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/queries/:queryName/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "queryName",
"value": "",
"type": "path",
"description": "The name of an EPCIS event query."
}
]
},
"docs": "The `OPTIONS` method is used to discover capabilities for named queries. It describes which EPCIS and CBV\nversions are used in the query result supported as well as EPCIS and CBV extensions.\n"
}
]
},
{
"info": {
"name": "Capture",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns a list of capture jobs.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/capture",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
}
],
"params": [
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
}
]
},
"docs": "When EPCIS events are added through the capture interface, the capture process can run asynchronously. If the payload\nis syntactically correct and the client is allowed to call `/capture`, the server returns a `202` HTTP response code. \nThis endpoint returns all capture jobs that were created\nand supports pagination.\n"
},
{
"info": {
"name": "Asynchronous capture endpoint for one or more EPCIS events.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/capture",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Version",
"value": ""
},
{
"name": "GS1-CBV-Version",
"value": ""
},
{
"name": "GS1-Capture-Error-Behaviour",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "EPCIS events are added in bulk using the capture interface. Four design considerations were made to remain compatible with EPCIS 1.2:\n- EPCIS 2.0 keeps event IDs optional. If event IDs are missing, the server should populate the event ID with a unique value.\nOtherwise, it won't be possible to retrieve these events by eventID.\n- By default, EPCIS events are only stored if the entire capture job was successful. This behaviour can be changed with the `GS1-Capture-Error-Behaviour` header.\n- EPCIS ma"
},
{
"info": {
"name": "Returns information about the capture job.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/capture/:captureID",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
}
],
"params": [
{
"name": "captureID",
"value": "id9261379075",
"type": "path",
"description": "A unique value identifying a capture job generated by the server."
}
]
},
"docs": "When EPCIS events are added through the capture interface, the capture process can run asynchronously. If the payload\nis syntactically correct and the client is allowed to call `/capture`, the server returns a `202` HTTP response code. \nThis endpoint exposes the state of the capture job to the client.\n"
},
{
"info": {
"name": "Synchronous capture interface for a single EPCIS event.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Version",
"value": ""
},
{
"name": "GS1-CBV-Version",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "An individual EPCIS event can be created by making a `POST` request on the `/events` resource. Alternatively, the client can also use the `/capture`\ninterface and capture a single event.\n"
}
]
},
{
"info": {
"name": "Top-level",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns all EPCIS events available in the EPCIS repository.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "eventType",
"value": "ObjectEvent",
"type": "query",
"description": "If specified, the result will only include events whose `type` matches one of the types specified in the parameter value. Each element of the parameter value may be one of the following strings: `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent` or `AssociationEvent`. An element of the parameter value may also be the name of an extension event type. If omitted, all event types will be considered for inclusion in the result."
},
{
"name": "GE_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `LT_eventTime` parameter)."
},
{
"name": "LT_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `GE_eventTime` parameter)."
},
{
"name": "GE_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` greater than or equal to the specified value will be returned. The automatic limitation based on event record time (section 8.2.5.2) may implicitly provide a constraint similar to this parameter. If omitted, events are included regardless of their `recordTime`, other than automatic limitation based on event record time"
},
{
"name": "LT_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` less than the specified value will be returned. If omitted, events are included regardless of their `recordTime` (unless constrained by the `GE_recordTime` parameter or the automatic limitation based on event record time)"
},
{
"name": "EQ_action",
"value": "OBSERVE",
"type": "query",
"description": "If specified, the result will only include events that (a) have an `action` field; and where (b) the value of the `action` field matches one of the specified values. The properties of the value of this parameter each must be one of the strings `ADD`, `OBSERVE`, or `DELETE`; if not, the implementation SHALL raise a `QueryParameterException`. If omitted, events are included regardless of their `action` field."
},
{
"name": "EQ_bizStep",
"value": "shipping",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizStep` field; and where (b) the value of the `bizStep` field matches one of the specified values. - see CBV BizStep for standard values. Standard values should be expressed as bare words, e.g. `shipping`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `bizStep` field or whether the `bizStep` field exists at all."
},
{
"name": "EQ_disposition",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `disposition` field; and where (b) the value of the `disposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `disposition` field or whether the `disposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_set",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `set` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `set` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_unset",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `unset` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `unset` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs. If this parameter and `WD_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "WD_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "EQ_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs. If this parameter and `WD_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "WD_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "EQ_transformationID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `transformationID` field (that is, `TransformationEvent`s or extension event type that extend `TransformationEvent`); and where (b) the `transformationID` field is equal to one of the values specified in this parameter."
},
{
"name": "MATCH_epc",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` or a `childEPCs` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `epcList` or `childEPCs` field (depending on event type) matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `epcList` or `childEPCs` field or whether the `epcList` or `childEPCs` field exists."
},
{
"name": "MATCH_parentID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `parentID` field (that is, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `parentID` field matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `parentID` field or whether the `parentID` field exists."
},
{
"name": "MATCH_inputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `inputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `inputEPCList` field or whether the `inputEPCList` field exists."
},
{
"name": "MATCH_outputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `outputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `outputEPCList` field or whether the `outputEPCList` field exists."
},
{
"name": "MATCH_anyEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` field, a `childEPCs` field, a `parentID` field, an `inputEPCList` field, or an `outputEPCList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) the `parentID` field or one of the EPCs listed in the `epcList`, `childEPCs`, `inputEPCList`, or `outputEPCList` field (depending on event type) matches one of URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_epcClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList` or a `childQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in the `quantityList` or `childQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The result will also include QuantityEvents whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_inputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `inputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_outputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `outputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_anyEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList`, `childQuantityList`, `inputQuantityList`, or `outputQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in any of those fields matches one of the EPC patterns or URIs specified in this parameter. The result will also include `QuantityEvent`s whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "EQ_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is equal to the specified parameter."
},
{
"name": "GT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than the specified parameter."
},
{
"name": "GE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than or equal to the specified parameter."
},
{
"name": "LT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than the specified parameter."
},
{
"name": "LE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than or equal to the specified parameter."
},
{
"name": "EQ_eventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a non-null `eventID` field; and where (b) the `eventID` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `eventID` field or whether the `eventID` field exists at all."
},
{
"name": "EXISTS_errorDeclaration",
"value": "",
"type": "query",
"description": "If this parameter is specified (and has a value of true), the result will only include events that contain an `ErrorDeclaration`. If this parameter is omitted (or has a value of false), events are returned regardless of whether they contain an `ErrorDeclaration`."
},
{
"name": "GE_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is greater than or equal to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "LT_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is less than to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "EQ_errorReason",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the error declaration contains a non-null `reason` field; and where (c) the `reason` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `reason` field is."
},
{
"name": "EQ_correctiveEventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) one of the elements of the `correctiveEventIDs` list is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or the contents of the `correctiveEventIDs` list."
},
{
"name": "orderBy",
"value": "",
"type": "query",
"description": "If specified, names a single field that will be used to order the results. The `orderDirection` field specifies whether the ordering is in ascending sequence or descending sequence. Events included in the result that lack the specified field altogether may occur in any position within the result event list. The value of this parameter SHALL be one of: `eventTime`, `recordTime`, or the fully qualified name of an extension field whose type is Int, Float, Time, or String. A fully qualified fieldname is constructed as for the `EQ_fieldname` parameter. In the case of a field of type String, sorting SHALL be according to their case-sensitive lexical ordering, considering UTF-8/ASCII code values of each successive character. If omitted, no order is specified. The implementation MAY order the results in any order it chooses, and that order MAY differ even when the same query is executed twice on the same data. (In EPCIS 1.0, the value `quantity` was also permitted, but its use is deprecated in EPCIS 1.1.)"
},
{
"name": "orderDirection",
"value": "",
"type": "query",
"description": "If specified and `orderBy` is also specified, specifies whether the results are ordered in ascending or descending sequence according to the key specified by `orderBy`. The value of this parameter must be one of `ASC` (for ascending order) or `DESC` (for descending order); if not, the implementation SHALL raise a `QueryParameterException`. If omitted, defaults to `DESC`."
},
{
"name": "eventCountLimit",
"value": "",
"type": "query",
"description": "If specified, the results will only include the first N events that match the other criteria, where N is the value of this parameter. The ordering specified by the `orderBy` and `orderDirection` parameters determine the meaning of “first” for this purpose. If omitted, all events matching the specified criteria will be included in the results. This parameter and `maxEventCount` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. This parameter may only be used when `orderBy` is specified; if `orderBy` is omitted and `eventCountLimit` is specified, a `QueryParameterException` SHALL be raised. This parameter differs from `maxEventCount` in that this parameter limits the amount of data returned, whereas `maxEventCount` causes an exception to be thrown if the limit is exceeded. Explanation (non-normative): A common use of the `orderBy`, `orderDirection`, and `eventCountLimit` parameters is for extremal queries. For example, to select the most recent event matching some criteria, the query would include parameters that select events matching the desired criteria, and set `orderBy` to `eventTime`, `orderDirection` to `DESC`, and `eventCountLimit` to 1."
},
{
"name": "maxEventCount",
"value": "",
"type": "query",
"description": "If specified, at most this many events will be included in the query result. If the query would otherwise return more than this number of events, a `QueryTooLargeException` SHALL be raised instead of a normal query result. This parameter and `eventCountLimit` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. If this parameter is omitted, any number of events may be included in the query result. Note, however, that the EPCIS implementation is free to raise a `QueryTooLargeException` regardless of the setting of this parameter (see section 8.2.3)."
},
{
"name": "GE_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `LT_startTime` parameter)."
},
{
"name": "LT_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `GE_startTime` parameter)."
},
{
"name": "GE_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `LT_endTime` parameter)."
},
{
"name": "LT_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `GE_endTime` parameter)."
},
{
"name": "EQ_type",
"value": "Temperature",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate one or more `sensorElement` fields; and where (b) the `type` attribute in one of these `sensorElement` fields is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `type` attribute or whether a `sensorElement` field exists at all. Standard values for `type` are defined at https://ref.gs1.org/voc/MeasurementType. Standard values SHALL be expressed as bare words, e.g. `Temperature`."
},
{
"name": "EQ_deviceID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `deviceID` attribute; and where (b) the `deviceID` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `deviceID` attribute or whether the `deviceID` attribute exists at all."
},
{
"name": "EQ_dataProcessingMethod",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `dataProcessingMethod` attribute; and where (b) the `dataProcessingMethod` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `dataProcessingMethod` attribute or whether the `dataProcessingMethod` attribute exists at all."
},
{
"name": "EQ_microorganism",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `microorganism` attribute; and where (b) the `microorganism` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `microorganism` attribute or whether the `microorganism` attribute exists at all."
},
{
"name": "EQ_chemicalSubstance",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `chemicalSubstance` attribute; and where (b) the `chemicalSubstance` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `chemicalSubstance` attribute or whether the `chemicalSubstance` attribute exists at all."
},
{
"name": "EQ_bizRules",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `bizRules` attribute; and where (b) the `bizRules` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `bizRules` attribute or whether the `bizRules` attribute exists at all."
},
{
"name": "EQ_stringValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `stringValue` attribute; and where (b) the `stringValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `stringValue` attribute or whether the `stringValue` attribute exists at all."
},
{
"name": "EQ_hexBinaryValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `hexBinaryValue` attribute; and where (b) the `hexBinaryValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `hexBinaryValue` attribute or whether the `hexBinaryValue` attribute exists at all."
},
{
"name": "EQ_uriValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `uriValue` attribute; and where (b) the `uriValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `uriValue` attribute or whether the `uriValue` attribute exists at all."
},
{
"name": "EQ_booleanValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `booleanValue` attribute; and where (b) the `booleanValue` attribute is equal to the specified value (i.e. `true` or `false`). If this parameter is omitted, events are returned regardless of the value of the `booleanValue` attribute or whether the `booleanValue` attribute exists at all"
}
]
},
"docs": "This endpoint allows querying EPCIS events that are currently in the repository. \nEvents can be filtered through URL query string parameters as specified by the EPCIS Query Language. \nAn EPCIS 2.0 query body using the REST interface SHALL be serialised as a JSON object. The value of the query key within that JSON object SHALL validate against the schema defined at: https://ref.gs1.org/standards/epcis/2.0.1/query-schema.json.\nAn EPCIS 2.0 query may also be expressed via parameters in the URI que"
},
{
"info": {
"name": "Returns all EPCIS event types currently available in the EPCIS repository.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/eventTypes",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
}
],
"params": [
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
}
]
},
"docs": "EPCIS event types specify the schema of an event. This endpoint returns the 5 standard event types as well as any custom event types supported by this repository."
},
{
"info": {
"name": "Returns all sub-resources of an EPCIS event type.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/eventTypes/:eventType",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
}
],
"params": [
{
"name": "eventType",
"value": "ObjectEvent",
"type": "path",
"description": "Names of EPCIS event types.\n"
}
]
},
"docs": "This endpoint returns all sub-resources of an EPCIS event type (for HATEOAS discovery), which includes at least `events`. A server may\nadd additional endpoints, for example `schema` to access the EPCIS event type schema.\n"
},
{
"info": {
"name": "Returns known electronic product codes.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/epcs",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
}
],
"params": [
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
}
]
},
"docs": "An endpoint to list all electronic product codes known to this repository."
},
{
"info": {
"name": "Returns all sub-resources of an electronic product code.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/epcs/:epc",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "epc",
"value": "urn:epc:id:sgtin:0614141.107346.2018",
"type": "path",
"description": "An electronic product code value."
}
]
},
"docs": "This endpoint returns all sub-resources of an electronic product code (for HATEOAS discovery), which includes at least `events`.\n"
},
{
"info": {
"name": "Returns known business steps.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/bizSteps",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
}
]
},
"docs": "This endpoint returns the CBV standard business steps as well as any custom business steps supported by this repository."
},
{
"info": {
"name": "Returns all sub-resources of a business step.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/bizSteps/:bizStep",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "bizStep",
"value": "urn:epcglobal:cbv:bizstep:receiving",
"type": "path",
"description": "A business step value."
}
]
},
"docs": "This endpoint returns all sub-resources of a business step (for HATEOAS discovery), which includes at least `events`.\n"
},
{
"info": {
"name": "Returns known business locations.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/bizLocations",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
}
],
"params": [
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
}
]
},
"docs": "An endpoint to list all the business locations known to this repository.\n"
},
{
"info": {
"name": "Returns all sub-resources of a business location.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/bizLocations/:bizLocation",
"params": [
{
"name": "bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.0",
"type": "path",
"description": "A business location value."
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
}
]
},
"docs": "This endpoint returns all sub-resources of a business location (for HATEOAS discovery), which includes at least `events`.\n"
},
{
"info": {
"name": "Returns known read points.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/readPoints",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
}
],
"params": [
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
}
]
},
"docs": "An endpoint to list all read points known to this repository."
},
{
"info": {
"name": "Returns all sub-resources of a read point.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/readPoints/:readPoint",
"params": [
{
"name": "readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "path",
"description": "A read point value."
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
}
]
},
"docs": "This endpoint returns all sub-resources of a read point (for HATEOAS discovery), which includes at least `events`.\n"
},
{
"info": {
"name": "Returns known dispositions.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/dispositions",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
}
]
},
"docs": "This endpoint returns the CBV standard dispositions as well as any custom dispositions supported by this repository.\n"
},
{
"info": {
"name": "Returns all sub-resources of a disposition.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/dispositions/:disposition",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "disposition",
"value": "in_progress",
"type": "path",
"description": "A disposition value."
}
]
},
"docs": "This endpoint returns all sub-resources of a disposition (for HATEOAS discovery), which includes at least `events`.\n"
}
]
},
{
"info": {
"name": "Events",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns an individual EPCIS event.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/events/:eventID",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "eventID",
"value": "ni:///sha-256;df7bb3c352fef055578554f09f5e2aa41782150ced7bd0b8af24dd3ccb30ba69?ver=CBV2.0",
"type": "path",
"description": "The ID of an EPCIS event. An EPCIS event ID must be unique across all events in the system.\n"
}
]
},
"docs": "This endpoint accesses individual events using their unique identifier. The response body is an `EPCISQueryDocument` \nenclosing the unique event and error declarations.\n"
},
{
"info": {
"name": "Returns EPCIS events of a given an EPCIS event type.\n",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/eventTypes/:eventType/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "eventType",
"value": "ObjectEvent",
"type": "path",
"description": "Names of EPCIS event types.\n"
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "GE_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `LT_eventTime` parameter)."
},
{
"name": "LT_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `GE_eventTime` parameter)."
},
{
"name": "GE_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` greater than or equal to the specified value will be returned. The automatic limitation based on event record time (section 8.2.5.2) may implicitly provide a constraint similar to this parameter. If omitted, events are included regardless of their `recordTime`, other than automatic limitation based on event record time"
},
{
"name": "LT_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` less than the specified value will be returned. If omitted, events are included regardless of their `recordTime` (unless constrained by the `GE_recordTime` parameter or the automatic limitation based on event record time)"
},
{
"name": "EQ_action",
"value": "OBSERVE",
"type": "query",
"description": "If specified, the result will only include events that (a) have an `action` field; and where (b) the value of the `action` field matches one of the specified values. The properties of the value of this parameter each must be one of the strings `ADD`, `OBSERVE`, or `DELETE`; if not, the implementation SHALL raise a `QueryParameterException`. If omitted, events are included regardless of their `action` field."
},
{
"name": "EQ_bizStep",
"value": "shipping",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizStep` field; and where (b) the value of the `bizStep` field matches one of the specified values. - see CBV BizStep for standard values. Standard values should be expressed as bare words, e.g. `shipping`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `bizStep` field or whether the `bizStep` field exists at all."
},
{
"name": "EQ_disposition",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `disposition` field; and where (b) the value of the `disposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `disposition` field or whether the `disposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_set",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `set` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `set` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_unset",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `unset` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `unset` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs. If this parameter and `WD_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "WD_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "EQ_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs. If this parameter and `WD_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "WD_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "EQ_transformationID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `transformationID` field (that is, `TransformationEvent`s or extension event type that extend `TransformationEvent`); and where (b) the `transformationID` field is equal to one of the values specified in this parameter."
},
{
"name": "MATCH_epc",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` or a `childEPCs` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `epcList` or `childEPCs` field (depending on event type) matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `epcList` or `childEPCs` field or whether the `epcList` or `childEPCs` field exists."
},
{
"name": "MATCH_parentID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `parentID` field (that is, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `parentID` field matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `parentID` field or whether the `parentID` field exists."
},
{
"name": "MATCH_inputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `inputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `inputEPCList` field or whether the `inputEPCList` field exists."
},
{
"name": "MATCH_outputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `outputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `outputEPCList` field or whether the `outputEPCList` field exists."
},
{
"name": "MATCH_anyEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` field, a `childEPCs` field, a `parentID` field, an `inputEPCList` field, or an `outputEPCList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) the `parentID` field or one of the EPCs listed in the `epcList`, `childEPCs`, `inputEPCList`, or `outputEPCList` field (depending on event type) matches one of URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_epcClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList` or a `childQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in the `quantityList` or `childQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The result will also include QuantityEvents whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_inputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `inputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_outputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `outputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_anyEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList`, `childQuantityList`, `inputQuantityList`, or `outputQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in any of those fields matches one of the EPC patterns or URIs specified in this parameter. The result will also include `QuantityEvent`s whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "EQ_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is equal to the specified parameter."
},
{
"name": "GT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than the specified parameter."
},
{
"name": "GE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than or equal to the specified parameter."
},
{
"name": "LT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than the specified parameter."
},
{
"name": "LE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than or equal to the specified parameter."
},
{
"name": "EQ_eventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a non-null `eventID` field; and where (b) the `eventID` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `eventID` field or whether the `eventID` field exists at all."
},
{
"name": "EXISTS_errorDeclaration",
"value": "",
"type": "query",
"description": "If this parameter is specified (and has a value of true), the result will only include events that contain an `ErrorDeclaration`. If this parameter is omitted (or has a value of false), events are returned regardless of whether they contain an `ErrorDeclaration`."
},
{
"name": "GE_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is greater than or equal to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "LT_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is less than to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "EQ_errorReason",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the error declaration contains a non-null `reason` field; and where (c) the `reason` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `reason` field is."
},
{
"name": "EQ_correctiveEventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) one of the elements of the `correctiveEventIDs` list is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or the contents of the `correctiveEventIDs` list."
},
{
"name": "orderBy",
"value": "",
"type": "query",
"description": "If specified, names a single field that will be used to order the results. The `orderDirection` field specifies whether the ordering is in ascending sequence or descending sequence. Events included in the result that lack the specified field altogether may occur in any position within the result event list. The value of this parameter SHALL be one of: `eventTime`, `recordTime`, or the fully qualified name of an extension field whose type is Int, Float, Time, or String. A fully qualified fieldname is constructed as for the `EQ_fieldname` parameter. In the case of a field of type String, sorting SHALL be according to their case-sensitive lexical ordering, considering UTF-8/ASCII code values of each successive character. If omitted, no order is specified. The implementation MAY order the results in any order it chooses, and that order MAY differ even when the same query is executed twice on the same data. (In EPCIS 1.0, the value `quantity` was also permitted, but its use is deprecated in EPCIS 1.1.)"
},
{
"name": "orderDirection",
"value": "",
"type": "query",
"description": "If specified and `orderBy` is also specified, specifies whether the results are ordered in ascending or descending sequence according to the key specified by `orderBy`. The value of this parameter must be one of `ASC` (for ascending order) or `DESC` (for descending order); if not, the implementation SHALL raise a `QueryParameterException`. If omitted, defaults to `DESC`."
},
{
"name": "eventCountLimit",
"value": "",
"type": "query",
"description": "If specified, the results will only include the first N events that match the other criteria, where N is the value of this parameter. The ordering specified by the `orderBy` and `orderDirection` parameters determine the meaning of “first” for this purpose. If omitted, all events matching the specified criteria will be included in the results. This parameter and `maxEventCount` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. This parameter may only be used when `orderBy` is specified; if `orderBy` is omitted and `eventCountLimit` is specified, a `QueryParameterException` SHALL be raised. This parameter differs from `maxEventCount` in that this parameter limits the amount of data returned, whereas `maxEventCount` causes an exception to be thrown if the limit is exceeded. Explanation (non-normative): A common use of the `orderBy`, `orderDirection`, and `eventCountLimit` parameters is for extremal queries. For example, to select the most recent event matching some criteria, the query would include parameters that select events matching the desired criteria, and set `orderBy` to `eventTime`, `orderDirection` to `DESC`, and `eventCountLimit` to 1."
},
{
"name": "maxEventCount",
"value": "",
"type": "query",
"description": "If specified, at most this many events will be included in the query result. If the query would otherwise return more than this number of events, a `QueryTooLargeException` SHALL be raised instead of a normal query result. This parameter and `eventCountLimit` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. If this parameter is omitted, any number of events may be included in the query result. Note, however, that the EPCIS implementation is free to raise a `QueryTooLargeException` regardless of the setting of this parameter (see section 8.2.3)."
},
{
"name": "GE_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `LT_startTime` parameter)."
},
{
"name": "LT_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `GE_startTime` parameter)."
},
{
"name": "GE_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `LT_endTime` parameter)."
},
{
"name": "LT_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `GE_endTime` parameter)."
},
{
"name": "EQ_type",
"value": "Temperature",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate one or more `sensorElement` fields; and where (b) the `type` attribute in one of these `sensorElement` fields is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `type` attribute or whether a `sensorElement` field exists at all. Standard values for `type` are defined at https://ref.gs1.org/voc/MeasurementType. Standard values SHALL be expressed as bare words, e.g. `Temperature`."
},
{
"name": "EQ_deviceID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `deviceID` attribute; and where (b) the `deviceID` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `deviceID` attribute or whether the `deviceID` attribute exists at all."
},
{
"name": "EQ_dataProcessingMethod",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `dataProcessingMethod` attribute; and where (b) the `dataProcessingMethod` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `dataProcessingMethod` attribute or whether the `dataProcessingMethod` attribute exists at all."
},
{
"name": "EQ_microorganism",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `microorganism` attribute; and where (b) the `microorganism` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `microorganism` attribute or whether the `microorganism` attribute exists at all."
},
{
"name": "EQ_chemicalSubstance",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `chemicalSubstance` attribute; and where (b) the `chemicalSubstance` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `chemicalSubstance` attribute or whether the `chemicalSubstance` attribute exists at all."
},
{
"name": "EQ_bizRules",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `bizRules` attribute; and where (b) the `bizRules` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `bizRules` attribute or whether the `bizRules` attribute exists at all."
},
{
"name": "EQ_stringValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `stringValue` attribute; and where (b) the `stringValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `stringValue` attribute or whether the `stringValue` attribute exists at all."
},
{
"name": "EQ_hexBinaryValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `hexBinaryValue` attribute; and where (b) the `hexBinaryValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `hexBinaryValue` attribute or whether the `hexBinaryValue` attribute exists at all."
},
{
"name": "EQ_uriValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `uriValue` attribute; and where (b) the `uriValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `uriValue` attribute or whether the `uriValue` attribute exists at all."
},
{
"name": "EQ_booleanValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `booleanValue` attribute; and where (b) the `booleanValue` attribute is equal to the specified value (i.e. `true` or `false`). If this parameter is omitted, events are returned regardless of the value of the `booleanValue` attribute or whether the `booleanValue` attribute exists at all"
}
]
},
"docs": "This endpoint returns all EPCIS events of a specific EPCIS event type up to the amount defined in `perPage`.\nThe server returns a 'Link' header to point to the remaining results.\nThe client can further restrict the list of events returned by filtering events using the EPCIS query\nlanguage using URL query string parameters as specified by the EPCIS Query Language.\nThe parameter `eventCountLimit` is used to restrict the maximum number of\nevents to be returned in total, whereas `perPage` restricts "
},
{
"info": {
"name": "Returns EPCIS events matching the specified electronic product code.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/epcs/:epc/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "epc",
"value": "urn:epc:id:sgtin:0614141.107346.2018",
"type": "path",
"description": "An electronic product code value."
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "eventType",
"value": "ObjectEvent",
"type": "query",
"description": "If specified, the result will only include events whose `type` matches one of the types specified in the parameter value. Each element of the parameter value may be one of the following strings: `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent` or `AssociationEvent`. An element of the parameter value may also be the name of an extension event type. If omitted, all event types will be considered for inclusion in the result."
},
{
"name": "GE_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `LT_eventTime` parameter)."
},
{
"name": "LT_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `GE_eventTime` parameter)."
},
{
"name": "GE_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` greater than or equal to the specified value will be returned. The automatic limitation based on event record time (section 8.2.5.2) may implicitly provide a constraint similar to this parameter. If omitted, events are included regardless of their `recordTime`, other than automatic limitation based on event record time"
},
{
"name": "LT_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` less than the specified value will be returned. If omitted, events are included regardless of their `recordTime` (unless constrained by the `GE_recordTime` parameter or the automatic limitation based on event record time)"
},
{
"name": "EQ_action",
"value": "OBSERVE",
"type": "query",
"description": "If specified, the result will only include events that (a) have an `action` field; and where (b) the value of the `action` field matches one of the specified values. The properties of the value of this parameter each must be one of the strings `ADD`, `OBSERVE`, or `DELETE`; if not, the implementation SHALL raise a `QueryParameterException`. If omitted, events are included regardless of their `action` field."
},
{
"name": "EQ_bizStep",
"value": "shipping",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizStep` field; and where (b) the value of the `bizStep` field matches one of the specified values. - see CBV BizStep for standard values. Standard values should be expressed as bare words, e.g. `shipping`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `bizStep` field or whether the `bizStep` field exists at all."
},
{
"name": "EQ_disposition",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `disposition` field; and where (b) the value of the `disposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `disposition` field or whether the `disposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_set",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `set` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `set` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_unset",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `unset` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `unset` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs. If this parameter and `WD_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "WD_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "EQ_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs. If this parameter and `WD_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "WD_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "EQ_transformationID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `transformationID` field (that is, `TransformationEvent`s or extension event type that extend `TransformationEvent`); and where (b) the `transformationID` field is equal to one of the values specified in this parameter."
},
{
"name": "MATCH_epc",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` or a `childEPCs` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `epcList` or `childEPCs` field (depending on event type) matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `epcList` or `childEPCs` field or whether the `epcList` or `childEPCs` field exists."
},
{
"name": "MATCH_parentID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `parentID` field (that is, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `parentID` field matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `parentID` field or whether the `parentID` field exists."
},
{
"name": "MATCH_inputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `inputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `inputEPCList` field or whether the `inputEPCList` field exists."
},
{
"name": "MATCH_outputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `outputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `outputEPCList` field or whether the `outputEPCList` field exists."
},
{
"name": "MATCH_epcClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList` or a `childQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in the `quantityList` or `childQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The result will also include QuantityEvents whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_inputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `inputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_outputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `outputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_anyEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList`, `childQuantityList`, `inputQuantityList`, or `outputQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in any of those fields matches one of the EPC patterns or URIs specified in this parameter. The result will also include `QuantityEvent`s whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "EQ_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is equal to the specified parameter."
},
{
"name": "GT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than the specified parameter."
},
{
"name": "GE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than or equal to the specified parameter."
},
{
"name": "LT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than the specified parameter."
},
{
"name": "LE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than or equal to the specified parameter."
},
{
"name": "EQ_eventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a non-null `eventID` field; and where (b) the `eventID` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `eventID` field or whether the `eventID` field exists at all."
},
{
"name": "EXISTS_errorDeclaration",
"value": "",
"type": "query",
"description": "If this parameter is specified (and has a value of true), the result will only include events that contain an `ErrorDeclaration`. If this parameter is omitted (or has a value of false), events are returned regardless of whether they contain an `ErrorDeclaration`."
},
{
"name": "GE_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is greater than or equal to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "LT_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is less than to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "EQ_errorReason",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the error declaration contains a non-null `reason` field; and where (c) the `reason` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `reason` field is."
},
{
"name": "EQ_correctiveEventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) one of the elements of the `correctiveEventIDs` list is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or the contents of the `correctiveEventIDs` list."
},
{
"name": "orderBy",
"value": "",
"type": "query",
"description": "If specified, names a single field that will be used to order the results. The `orderDirection` field specifies whether the ordering is in ascending sequence or descending sequence. Events included in the result that lack the specified field altogether may occur in any position within the result event list. The value of this parameter SHALL be one of: `eventTime`, `recordTime`, or the fully qualified name of an extension field whose type is Int, Float, Time, or String. A fully qualified fieldname is constructed as for the `EQ_fieldname` parameter. In the case of a field of type String, sorting SHALL be according to their case-sensitive lexical ordering, considering UTF-8/ASCII code values of each successive character. If omitted, no order is specified. The implementation MAY order the results in any order it chooses, and that order MAY differ even when the same query is executed twice on the same data. (In EPCIS 1.0, the value `quantity` was also permitted, but its use is deprecated in EPCIS 1.1.)"
},
{
"name": "orderDirection",
"value": "",
"type": "query",
"description": "If specified and `orderBy` is also specified, specifies whether the results are ordered in ascending or descending sequence according to the key specified by `orderBy`. The value of this parameter must be one of `ASC` (for ascending order) or `DESC` (for descending order); if not, the implementation SHALL raise a `QueryParameterException`. If omitted, defaults to `DESC`."
},
{
"name": "eventCountLimit",
"value": "",
"type": "query",
"description": "If specified, the results will only include the first N events that match the other criteria, where N is the value of this parameter. The ordering specified by the `orderBy` and `orderDirection` parameters determine the meaning of “first” for this purpose. If omitted, all events matching the specified criteria will be included in the results. This parameter and `maxEventCount` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. This parameter may only be used when `orderBy` is specified; if `orderBy` is omitted and `eventCountLimit` is specified, a `QueryParameterException` SHALL be raised. This parameter differs from `maxEventCount` in that this parameter limits the amount of data returned, whereas `maxEventCount` causes an exception to be thrown if the limit is exceeded. Explanation (non-normative): A common use of the `orderBy`, `orderDirection`, and `eventCountLimit` parameters is for extremal queries. For example, to select the most recent event matching some criteria, the query would include parameters that select events matching the desired criteria, and set `orderBy` to `eventTime`, `orderDirection` to `DESC`, and `eventCountLimit` to 1."
},
{
"name": "maxEventCount",
"value": "",
"type": "query",
"description": "If specified, at most this many events will be included in the query result. If the query would otherwise return more than this number of events, a `QueryTooLargeException` SHALL be raised instead of a normal query result. This parameter and `eventCountLimit` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. If this parameter is omitted, any number of events may be included in the query result. Note, however, that the EPCIS implementation is free to raise a `QueryTooLargeException` regardless of the setting of this parameter (see section 8.2.3)."
},
{
"name": "GE_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `LT_startTime` parameter)."
},
{
"name": "LT_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `GE_startTime` parameter)."
},
{
"name": "GE_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `LT_endTime` parameter)."
},
{
"name": "LT_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `GE_endTime` parameter)."
},
{
"name": "EQ_type",
"value": "Temperature",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate one or more `sensorElement` fields; and where (b) the `type` attribute in one of these `sensorElement` fields is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `type` attribute or whether a `sensorElement` field exists at all. Standard values for `type` are defined at https://ref.gs1.org/voc/MeasurementType. Standard values SHALL be expressed as bare words, e.g. `Temperature`."
},
{
"name": "EQ_deviceID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `deviceID` attribute; and where (b) the `deviceID` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `deviceID` attribute or whether the `deviceID` attribute exists at all."
},
{
"name": "EQ_dataProcessingMethod",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `dataProcessingMethod` attribute; and where (b) the `dataProcessingMethod` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `dataProcessingMethod` attribute or whether the `dataProcessingMethod` attribute exists at all."
},
{
"name": "EQ_microorganism",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `microorganism` attribute; and where (b) the `microorganism` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `microorganism` attribute or whether the `microorganism` attribute exists at all."
},
{
"name": "EQ_chemicalSubstance",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `chemicalSubstance` attribute; and where (b) the `chemicalSubstance` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `chemicalSubstance` attribute or whether the `chemicalSubstance` attribute exists at all."
},
{
"name": "EQ_bizRules",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `bizRules` attribute; and where (b) the `bizRules` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `bizRules` attribute or whether the `bizRules` attribute exists at all."
},
{
"name": "EQ_stringValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `stringValue` attribute; and where (b) the `stringValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `stringValue` attribute or whether the `stringValue` attribute exists at all."
},
{
"name": "EQ_hexBinaryValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `hexBinaryValue` attribute; and where (b) the `hexBinaryValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `hexBinaryValue` attribute or whether the `hexBinaryValue` attribute exists at all."
},
{
"name": "EQ_uriValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `uriValue` attribute; and where (b) the `uriValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `uriValue` attribute or whether the `uriValue` attribute exists at all."
},
{
"name": "EQ_booleanValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `booleanValue` attribute; and where (b) the `booleanValue` attribute is equal to the specified value (i.e. `true` or `false`). If this parameter is omitted, events are returned regardless of the value of the `booleanValue` attribute or whether the `booleanValue` attribute exists at all"
}
]
},
"docs": "This endpoint helps to navigate EPCIS events by electronic product codes. It returns\nEPCIS events up to the amount defined in `perPage`. If applicable, the server returns a `Link` header to point to the remaining\nresults. Optionally, EPCIS events can be further filtered using the EPCIS Query Language as query string parameters.\nExample 1 - EPC in a URN form with EPCIS Query Language filtering\n```\nhttps://example.com/epcs/urn:epc:id:sgtin:0614141.107346.2018?EQ_bizStep=shipping%7Cdecommissioning&"
},
{
"info": {
"name": "Returns all EPCIS events related to the business step.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/bizSteps/:bizStep/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "bizStep",
"value": "urn:epcglobal:cbv:bizstep:receiving",
"type": "path",
"description": "A business step value."
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "eventType",
"value": "ObjectEvent",
"type": "query",
"description": "If specified, the result will only include events whose `type` matches one of the types specified in the parameter value. Each element of the parameter value may be one of the following strings: `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent` or `AssociationEvent`. An element of the parameter value may also be the name of an extension event type. If omitted, all event types will be considered for inclusion in the result."
},
{
"name": "GE_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `LT_eventTime` parameter)."
},
{
"name": "LT_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `GE_eventTime` parameter)."
},
{
"name": "GE_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` greater than or equal to the specified value will be returned. The automatic limitation based on event record time (section 8.2.5.2) may implicitly provide a constraint similar to this parameter. If omitted, events are included regardless of their `recordTime`, other than automatic limitation based on event record time"
},
{
"name": "LT_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` less than the specified value will be returned. If omitted, events are included regardless of their `recordTime` (unless constrained by the `GE_recordTime` parameter or the automatic limitation based on event record time)"
},
{
"name": "EQ_action",
"value": "OBSERVE",
"type": "query",
"description": "If specified, the result will only include events that (a) have an `action` field; and where (b) the value of the `action` field matches one of the specified values. The properties of the value of this parameter each must be one of the strings `ADD`, `OBSERVE`, or `DELETE`; if not, the implementation SHALL raise a `QueryParameterException`. If omitted, events are included regardless of their `action` field."
},
{
"name": "EQ_disposition",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `disposition` field; and where (b) the value of the `disposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `disposition` field or whether the `disposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_set",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `set` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `set` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_unset",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `unset` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `unset` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs. If this parameter and `WD_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "WD_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "EQ_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs. If this parameter and `WD_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "WD_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "EQ_transformationID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `transformationID` field (that is, `TransformationEvent`s or extension event type that extend `TransformationEvent`); and where (b) the `transformationID` field is equal to one of the values specified in this parameter."
},
{
"name": "MATCH_epc",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` or a `childEPCs` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `epcList` or `childEPCs` field (depending on event type) matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `epcList` or `childEPCs` field or whether the `epcList` or `childEPCs` field exists."
},
{
"name": "MATCH_parentID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `parentID` field (that is, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `parentID` field matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `parentID` field or whether the `parentID` field exists."
},
{
"name": "MATCH_inputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `inputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `inputEPCList` field or whether the `inputEPCList` field exists."
},
{
"name": "MATCH_outputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `outputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `outputEPCList` field or whether the `outputEPCList` field exists."
},
{
"name": "MATCH_anyEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` field, a `childEPCs` field, a `parentID` field, an `inputEPCList` field, or an `outputEPCList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) the `parentID` field or one of the EPCs listed in the `epcList`, `childEPCs`, `inputEPCList`, or `outputEPCList` field (depending on event type) matches one of URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_epcClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList` or a `childQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in the `quantityList` or `childQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The result will also include QuantityEvents whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_inputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `inputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_outputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `outputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_anyEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList`, `childQuantityList`, `inputQuantityList`, or `outputQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in any of those fields matches one of the EPC patterns or URIs specified in this parameter. The result will also include `QuantityEvent`s whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "EQ_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is equal to the specified parameter."
},
{
"name": "GT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than the specified parameter."
},
{
"name": "GE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than or equal to the specified parameter."
},
{
"name": "LT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than the specified parameter."
},
{
"name": "LE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than or equal to the specified parameter."
},
{
"name": "EQ_eventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a non-null `eventID` field; and where (b) the `eventID` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `eventID` field or whether the `eventID` field exists at all."
},
{
"name": "EXISTS_errorDeclaration",
"value": "",
"type": "query",
"description": "If this parameter is specified (and has a value of true), the result will only include events that contain an `ErrorDeclaration`. If this parameter is omitted (or has a value of false), events are returned regardless of whether they contain an `ErrorDeclaration`."
},
{
"name": "GE_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is greater than or equal to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "LT_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is less than to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "EQ_errorReason",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the error declaration contains a non-null `reason` field; and where (c) the `reason` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `reason` field is."
},
{
"name": "EQ_correctiveEventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) one of the elements of the `correctiveEventIDs` list is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or the contents of the `correctiveEventIDs` list."
},
{
"name": "orderBy",
"value": "",
"type": "query",
"description": "If specified, names a single field that will be used to order the results. The `orderDirection` field specifies whether the ordering is in ascending sequence or descending sequence. Events included in the result that lack the specified field altogether may occur in any position within the result event list. The value of this parameter SHALL be one of: `eventTime`, `recordTime`, or the fully qualified name of an extension field whose type is Int, Float, Time, or String. A fully qualified fieldname is constructed as for the `EQ_fieldname` parameter. In the case of a field of type String, sorting SHALL be according to their case-sensitive lexical ordering, considering UTF-8/ASCII code values of each successive character. If omitted, no order is specified. The implementation MAY order the results in any order it chooses, and that order MAY differ even when the same query is executed twice on the same data. (In EPCIS 1.0, the value `quantity` was also permitted, but its use is deprecated in EPCIS 1.1.)"
},
{
"name": "orderDirection",
"value": "",
"type": "query",
"description": "If specified and `orderBy` is also specified, specifies whether the results are ordered in ascending or descending sequence according to the key specified by `orderBy`. The value of this parameter must be one of `ASC` (for ascending order) or `DESC` (for descending order); if not, the implementation SHALL raise a `QueryParameterException`. If omitted, defaults to `DESC`."
},
{
"name": "eventCountLimit",
"value": "",
"type": "query",
"description": "If specified, the results will only include the first N events that match the other criteria, where N is the value of this parameter. The ordering specified by the `orderBy` and `orderDirection` parameters determine the meaning of “first” for this purpose. If omitted, all events matching the specified criteria will be included in the results. This parameter and `maxEventCount` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. This parameter may only be used when `orderBy` is specified; if `orderBy` is omitted and `eventCountLimit` is specified, a `QueryParameterException` SHALL be raised. This parameter differs from `maxEventCount` in that this parameter limits the amount of data returned, whereas `maxEventCount` causes an exception to be thrown if the limit is exceeded. Explanation (non-normative): A common use of the `orderBy`, `orderDirection`, and `eventCountLimit` parameters is for extremal queries. For example, to select the most recent event matching some criteria, the query would include parameters that select events matching the desired criteria, and set `orderBy` to `eventTime`, `orderDirection` to `DESC`, and `eventCountLimit` to 1."
},
{
"name": "maxEventCount",
"value": "",
"type": "query",
"description": "If specified, at most this many events will be included in the query result. If the query would otherwise return more than this number of events, a `QueryTooLargeException` SHALL be raised instead of a normal query result. This parameter and `eventCountLimit` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. If this parameter is omitted, any number of events may be included in the query result. Note, however, that the EPCIS implementation is free to raise a `QueryTooLargeException` regardless of the setting of this parameter (see section 8.2.3)."
},
{
"name": "GE_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `LT_startTime` parameter)."
},
{
"name": "LT_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `GE_startTime` parameter)."
},
{
"name": "GE_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `LT_endTime` parameter)."
},
{
"name": "LT_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `GE_endTime` parameter)."
},
{
"name": "EQ_type",
"value": "Temperature",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate one or more `sensorElement` fields; and where (b) the `type` attribute in one of these `sensorElement` fields is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `type` attribute or whether a `sensorElement` field exists at all. Standard values for `type` are defined at https://ref.gs1.org/voc/MeasurementType. Standard values SHALL be expressed as bare words, e.g. `Temperature`."
},
{
"name": "EQ_deviceID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `deviceID` attribute; and where (b) the `deviceID` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `deviceID` attribute or whether the `deviceID` attribute exists at all."
},
{
"name": "EQ_dataProcessingMethod",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `dataProcessingMethod` attribute; and where (b) the `dataProcessingMethod` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `dataProcessingMethod` attribute or whether the `dataProcessingMethod` attribute exists at all."
},
{
"name": "EQ_microorganism",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `microorganism` attribute; and where (b) the `microorganism` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `microorganism` attribute or whether the `microorganism` attribute exists at all."
},
{
"name": "EQ_chemicalSubstance",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `chemicalSubstance` attribute; and where (b) the `chemicalSubstance` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `chemicalSubstance` attribute or whether the `chemicalSubstance` attribute exists at all."
},
{
"name": "EQ_bizRules",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `bizRules` attribute; and where (b) the `bizRules` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `bizRules` attribute or whether the `bizRules` attribute exists at all."
},
{
"name": "EQ_stringValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `stringValue` attribute; and where (b) the `stringValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `stringValue` attribute or whether the `stringValue` attribute exists at all."
},
{
"name": "EQ_hexBinaryValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `hexBinaryValue` attribute; and where (b) the `hexBinaryValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `hexBinaryValue` attribute or whether the `hexBinaryValue` attribute exists at all."
},
{
"name": "EQ_uriValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `uriValue` attribute; and where (b) the `uriValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `uriValue` attribute or whether the `uriValue` attribute exists at all."
},
{
"name": "EQ_booleanValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `booleanValue` attribute; and where (b) the `booleanValue` attribute is equal to the specified value (i.e. `true` or `false`). If this parameter is omitted, events are returned regardless of the value of the `booleanValue` attribute or whether the `booleanValue` attribute exists at all"
}
]
},
"docs": "This endpoint helps to navigate EPCIS events by business steps. It returns\nEPCIS events up to the amount defined in `perPage`. The server returns a `Link` header to point to the\nremaining results. Optionally, EPCIS events can be further filtered using the EPCIS Query Language in as query\nstring parameters.\nExample:\n```\nhttps://example.com/bizSteps/receiving?GE_eventTime=2015-03-15T00%3A00%3A00.000-04%3A00\n```\nAn EPCIS 2.0 query may also be expressed via the URI query string. The query paramete"
},
{
"info": {
"name": "Returns all EPCIS events related to the business location.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/bizLocations/:bizLocation/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.0",
"type": "path",
"description": "A business location value."
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "eventType",
"value": "ObjectEvent",
"type": "query",
"description": "If specified, the result will only include events whose `type` matches one of the types specified in the parameter value. Each element of the parameter value may be one of the following strings: `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent` or `AssociationEvent`. An element of the parameter value may also be the name of an extension event type. If omitted, all event types will be considered for inclusion in the result."
},
{
"name": "GE_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `LT_eventTime` parameter)."
},
{
"name": "LT_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `GE_eventTime` parameter)."
},
{
"name": "GE_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` greater than or equal to the specified value will be returned. The automatic limitation based on event record time (section 8.2.5.2) may implicitly provide a constraint similar to this parameter. If omitted, events are included regardless of their `recordTime`, other than automatic limitation based on event record time"
},
{
"name": "LT_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` less than the specified value will be returned. If omitted, events are included regardless of their `recordTime` (unless constrained by the `GE_recordTime` parameter or the automatic limitation based on event record time)"
},
{
"name": "EQ_action",
"value": "OBSERVE",
"type": "query",
"description": "If specified, the result will only include events that (a) have an `action` field; and where (b) the value of the `action` field matches one of the specified values. The properties of the value of this parameter each must be one of the strings `ADD`, `OBSERVE`, or `DELETE`; if not, the implementation SHALL raise a `QueryParameterException`. If omitted, events are included regardless of their `action` field."
},
{
"name": "EQ_bizStep",
"value": "shipping",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizStep` field; and where (b) the value of the `bizStep` field matches one of the specified values. - see CBV BizStep for standard values. Standard values should be expressed as bare words, e.g. `shipping`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `bizStep` field or whether the `bizStep` field exists at all."
},
{
"name": "EQ_disposition",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `disposition` field; and where (b) the value of the `disposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `disposition` field or whether the `disposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_set",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `set` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `set` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_unset",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `unset` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `unset` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs. If this parameter and `WD_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "WD_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "WD_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "EQ_transformationID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `transformationID` field (that is, `TransformationEvent`s or extension event type that extend `TransformationEvent`); and where (b) the `transformationID` field is equal to one of the values specified in this parameter."
},
{
"name": "MATCH_epc",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` or a `childEPCs` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `epcList` or `childEPCs` field (depending on event type) matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `epcList` or `childEPCs` field or whether the `epcList` or `childEPCs` field exists."
},
{
"name": "MATCH_parentID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `parentID` field (that is, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `parentID` field matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `parentID` field or whether the `parentID` field exists."
},
{
"name": "MATCH_inputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `inputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `inputEPCList` field or whether the `inputEPCList` field exists."
},
{
"name": "MATCH_outputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `outputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `outputEPCList` field or whether the `outputEPCList` field exists."
},
{
"name": "MATCH_anyEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` field, a `childEPCs` field, a `parentID` field, an `inputEPCList` field, or an `outputEPCList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) the `parentID` field or one of the EPCs listed in the `epcList`, `childEPCs`, `inputEPCList`, or `outputEPCList` field (depending on event type) matches one of URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_epcClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList` or a `childQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in the `quantityList` or `childQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The result will also include QuantityEvents whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_inputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `inputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_outputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `outputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_anyEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList`, `childQuantityList`, `inputQuantityList`, or `outputQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in any of those fields matches one of the EPC patterns or URIs specified in this parameter. The result will also include `QuantityEvent`s whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "EQ_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is equal to the specified parameter."
},
{
"name": "GT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than the specified parameter."
},
{
"name": "GE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than or equal to the specified parameter."
},
{
"name": "LT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than the specified parameter."
},
{
"name": "LE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than or equal to the specified parameter."
},
{
"name": "EQ_eventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a non-null `eventID` field; and where (b) the `eventID` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `eventID` field or whether the `eventID` field exists at all."
},
{
"name": "EXISTS_errorDeclaration",
"value": "",
"type": "query",
"description": "If this parameter is specified (and has a value of true), the result will only include events that contain an `ErrorDeclaration`. If this parameter is omitted (or has a value of false), events are returned regardless of whether they contain an `ErrorDeclaration`."
},
{
"name": "GE_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is greater than or equal to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "LT_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is less than to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "EQ_errorReason",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the error declaration contains a non-null `reason` field; and where (c) the `reason` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `reason` field is."
},
{
"name": "EQ_correctiveEventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) one of the elements of the `correctiveEventIDs` list is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or the contents of the `correctiveEventIDs` list."
},
{
"name": "orderBy",
"value": "",
"type": "query",
"description": "If specified, names a single field that will be used to order the results. The `orderDirection` field specifies whether the ordering is in ascending sequence or descending sequence. Events included in the result that lack the specified field altogether may occur in any position within the result event list. The value of this parameter SHALL be one of: `eventTime`, `recordTime`, or the fully qualified name of an extension field whose type is Int, Float, Time, or String. A fully qualified fieldname is constructed as for the `EQ_fieldname` parameter. In the case of a field of type String, sorting SHALL be according to their case-sensitive lexical ordering, considering UTF-8/ASCII code values of each successive character. If omitted, no order is specified. The implementation MAY order the results in any order it chooses, and that order MAY differ even when the same query is executed twice on the same data. (In EPCIS 1.0, the value `quantity` was also permitted, but its use is deprecated in EPCIS 1.1.)"
},
{
"name": "orderDirection",
"value": "",
"type": "query",
"description": "If specified and `orderBy` is also specified, specifies whether the results are ordered in ascending or descending sequence according to the key specified by `orderBy`. The value of this parameter must be one of `ASC` (for ascending order) or `DESC` (for descending order); if not, the implementation SHALL raise a `QueryParameterException`. If omitted, defaults to `DESC`."
},
{
"name": "eventCountLimit",
"value": "",
"type": "query",
"description": "If specified, the results will only include the first N events that match the other criteria, where N is the value of this parameter. The ordering specified by the `orderBy` and `orderDirection` parameters determine the meaning of “first” for this purpose. If omitted, all events matching the specified criteria will be included in the results. This parameter and `maxEventCount` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. This parameter may only be used when `orderBy` is specified; if `orderBy` is omitted and `eventCountLimit` is specified, a `QueryParameterException` SHALL be raised. This parameter differs from `maxEventCount` in that this parameter limits the amount of data returned, whereas `maxEventCount` causes an exception to be thrown if the limit is exceeded. Explanation (non-normative): A common use of the `orderBy`, `orderDirection`, and `eventCountLimit` parameters is for extremal queries. For example, to select the most recent event matching some criteria, the query would include parameters that select events matching the desired criteria, and set `orderBy` to `eventTime`, `orderDirection` to `DESC`, and `eventCountLimit` to 1."
},
{
"name": "maxEventCount",
"value": "",
"type": "query",
"description": "If specified, at most this many events will be included in the query result. If the query would otherwise return more than this number of events, a `QueryTooLargeException` SHALL be raised instead of a normal query result. This parameter and `eventCountLimit` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. If this parameter is omitted, any number of events may be included in the query result. Note, however, that the EPCIS implementation is free to raise a `QueryTooLargeException` regardless of the setting of this parameter (see section 8.2.3)."
},
{
"name": "GE_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `LT_startTime` parameter)."
},
{
"name": "LT_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `GE_startTime` parameter)."
},
{
"name": "GE_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `LT_endTime` parameter)."
},
{
"name": "LT_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `GE_endTime` parameter)."
},
{
"name": "EQ_type",
"value": "Temperature",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate one or more `sensorElement` fields; and where (b) the `type` attribute in one of these `sensorElement` fields is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `type` attribute or whether a `sensorElement` field exists at all. Standard values for `type` are defined at https://ref.gs1.org/voc/MeasurementType. Standard values SHALL be expressed as bare words, e.g. `Temperature`."
},
{
"name": "EQ_deviceID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `deviceID` attribute; and where (b) the `deviceID` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `deviceID` attribute or whether the `deviceID` attribute exists at all."
},
{
"name": "EQ_dataProcessingMethod",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `dataProcessingMethod` attribute; and where (b) the `dataProcessingMethod` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `dataProcessingMethod` attribute or whether the `dataProcessingMethod` attribute exists at all."
},
{
"name": "EQ_microorganism",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `microorganism` attribute; and where (b) the `microorganism` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `microorganism` attribute or whether the `microorganism` attribute exists at all."
},
{
"name": "EQ_chemicalSubstance",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `chemicalSubstance` attribute; and where (b) the `chemicalSubstance` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `chemicalSubstance` attribute or whether the `chemicalSubstance` attribute exists at all."
},
{
"name": "EQ_bizRules",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `bizRules` attribute; and where (b) the `bizRules` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `bizRules` attribute or whether the `bizRules` attribute exists at all."
},
{
"name": "EQ_stringValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `stringValue` attribute; and where (b) the `stringValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `stringValue` attribute or whether the `stringValue` attribute exists at all."
},
{
"name": "EQ_hexBinaryValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `hexBinaryValue` attribute; and where (b) the `hexBinaryValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `hexBinaryValue` attribute or whether the `hexBinaryValue` attribute exists at all."
},
{
"name": "EQ_uriValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `uriValue` attribute; and where (b) the `uriValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `uriValue` attribute or whether the `uriValue` attribute exists at all."
},
{
"name": "EQ_booleanValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `booleanValue` attribute; and where (b) the `booleanValue` attribute is equal to the specified value (i.e. `true` or `false`). If this parameter is omitted, events are returned regardless of the value of the `booleanValue` attribute or whether the `booleanValue` attribute exists at all"
}
]
},
"docs": "This endpoint helps to navigate EPCIS events by business locations. It returns\nEPCIS events up to the amount defined in `perPage`. The server returns a `Link` header to point to the remaining\nresults.\nOptionally, EPCIS events can be further filtered using the EPCIS Query Language as query string parameters.\nExample:\n```\nhttps://example.com/bizLocations/urn:epc:id:sgln:0012345.11111.400?GE_eventTime=2015-03-15T00%3A00%3A00.000-04%3A00\n```\nAn EPCIS 2.0 query may also be expressed via the URI query"
},
{
"info": {
"name": "Returns all EPCIS events related to the read point.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/readPoints/:readPoint/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "path",
"description": "A read point value."
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "eventType",
"value": "ObjectEvent",
"type": "query",
"description": "If specified, the result will only include events whose `type` matches one of the types specified in the parameter value. Each element of the parameter value may be one of the following strings: `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent` or `AssociationEvent`. An element of the parameter value may also be the name of an extension event type. If omitted, all event types will be considered for inclusion in the result."
},
{
"name": "GE_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `LT_eventTime` parameter)."
},
{
"name": "LT_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `GE_eventTime` parameter)."
},
{
"name": "GE_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` greater than or equal to the specified value will be returned. The automatic limitation based on event record time (section 8.2.5.2) may implicitly provide a constraint similar to this parameter. If omitted, events are included regardless of their `recordTime`, other than automatic limitation based on event record time"
},
{
"name": "LT_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` less than the specified value will be returned. If omitted, events are included regardless of their `recordTime` (unless constrained by the `GE_recordTime` parameter or the automatic limitation based on event record time)"
},
{
"name": "EQ_action",
"value": "OBSERVE",
"type": "query",
"description": "If specified, the result will only include events that (a) have an `action` field; and where (b) the value of the `action` field matches one of the specified values. The properties of the value of this parameter each must be one of the strings `ADD`, `OBSERVE`, or `DELETE`; if not, the implementation SHALL raise a `QueryParameterException`. If omitted, events are included regardless of their `action` field."
},
{
"name": "EQ_bizStep",
"value": "shipping",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizStep` field; and where (b) the value of the `bizStep` field matches one of the specified values. - see CBV BizStep for standard values. Standard values should be expressed as bare words, e.g. `shipping`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `bizStep` field or whether the `bizStep` field exists at all."
},
{
"name": "EQ_disposition",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `disposition` field; and where (b) the value of the `disposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `disposition` field or whether the `disposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_set",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `set` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `set` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_unset",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `unset` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `unset` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "WD_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "EQ_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs. If this parameter and `WD_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "WD_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "EQ_transformationID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `transformationID` field (that is, `TransformationEvent`s or extension event type that extend `TransformationEvent`); and where (b) the `transformationID` field is equal to one of the values specified in this parameter."
},
{
"name": "MATCH_epc",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` or a `childEPCs` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `epcList` or `childEPCs` field (depending on event type) matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `epcList` or `childEPCs` field or whether the `epcList` or `childEPCs` field exists."
},
{
"name": "MATCH_parentID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `parentID` field (that is, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `parentID` field matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `parentID` field or whether the `parentID` field exists."
},
{
"name": "MATCH_inputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `inputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `inputEPCList` field or whether the `inputEPCList` field exists."
},
{
"name": "MATCH_outputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `outputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `outputEPCList` field or whether the `outputEPCList` field exists."
},
{
"name": "MATCH_anyEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` field, a `childEPCs` field, a `parentID` field, an `inputEPCList` field, or an `outputEPCList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) the `parentID` field or one of the EPCs listed in the `epcList`, `childEPCs`, `inputEPCList`, or `outputEPCList` field (depending on event type) matches one of URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_epcClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList` or a `childQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in the `quantityList` or `childQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The result will also include QuantityEvents whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_inputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `inputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_outputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `outputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_anyEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList`, `childQuantityList`, `inputQuantityList`, or `outputQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in any of those fields matches one of the EPC patterns or URIs specified in this parameter. The result will also include `QuantityEvent`s whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "EQ_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is equal to the specified parameter."
},
{
"name": "GT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than the specified parameter."
},
{
"name": "GE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than or equal to the specified parameter."
},
{
"name": "LT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than the specified parameter."
},
{
"name": "LE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than or equal to the specified parameter."
},
{
"name": "EQ_eventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a non-null `eventID` field; and where (b) the `eventID` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `eventID` field or whether the `eventID` field exists at all."
},
{
"name": "EXISTS_errorDeclaration",
"value": "",
"type": "query",
"description": "If this parameter is specified (and has a value of true), the result will only include events that contain an `ErrorDeclaration`. If this parameter is omitted (or has a value of false), events are returned regardless of whether they contain an `ErrorDeclaration`."
},
{
"name": "GE_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is greater than or equal to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "LT_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is less than to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "EQ_errorReason",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the error declaration contains a non-null `reason` field; and where (c) the `reason` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `reason` field is."
},
{
"name": "EQ_correctiveEventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) one of the elements of the `correctiveEventIDs` list is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or the contents of the `correctiveEventIDs` list."
},
{
"name": "orderBy",
"value": "",
"type": "query",
"description": "If specified, names a single field that will be used to order the results. The `orderDirection` field specifies whether the ordering is in ascending sequence or descending sequence. Events included in the result that lack the specified field altogether may occur in any position within the result event list. The value of this parameter SHALL be one of: `eventTime`, `recordTime`, or the fully qualified name of an extension field whose type is Int, Float, Time, or String. A fully qualified fieldname is constructed as for the `EQ_fieldname` parameter. In the case of a field of type String, sorting SHALL be according to their case-sensitive lexical ordering, considering UTF-8/ASCII code values of each successive character. If omitted, no order is specified. The implementation MAY order the results in any order it chooses, and that order MAY differ even when the same query is executed twice on the same data. (In EPCIS 1.0, the value `quantity` was also permitted, but its use is deprecated in EPCIS 1.1.)"
},
{
"name": "orderDirection",
"value": "",
"type": "query",
"description": "If specified and `orderBy` is also specified, specifies whether the results are ordered in ascending or descending sequence according to the key specified by `orderBy`. The value of this parameter must be one of `ASC` (for ascending order) or `DESC` (for descending order); if not, the implementation SHALL raise a `QueryParameterException`. If omitted, defaults to `DESC`."
},
{
"name": "eventCountLimit",
"value": "",
"type": "query",
"description": "If specified, the results will only include the first N events that match the other criteria, where N is the value of this parameter. The ordering specified by the `orderBy` and `orderDirection` parameters determine the meaning of “first” for this purpose. If omitted, all events matching the specified criteria will be included in the results. This parameter and `maxEventCount` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. This parameter may only be used when `orderBy` is specified; if `orderBy` is omitted and `eventCountLimit` is specified, a `QueryParameterException` SHALL be raised. This parameter differs from `maxEventCount` in that this parameter limits the amount of data returned, whereas `maxEventCount` causes an exception to be thrown if the limit is exceeded. Explanation (non-normative): A common use of the `orderBy`, `orderDirection`, and `eventCountLimit` parameters is for extremal queries. For example, to select the most recent event matching some criteria, the query would include parameters that select events matching the desired criteria, and set `orderBy` to `eventTime`, `orderDirection` to `DESC`, and `eventCountLimit` to 1."
},
{
"name": "maxEventCount",
"value": "",
"type": "query",
"description": "If specified, at most this many events will be included in the query result. If the query would otherwise return more than this number of events, a `QueryTooLargeException` SHALL be raised instead of a normal query result. This parameter and `eventCountLimit` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. If this parameter is omitted, any number of events may be included in the query result. Note, however, that the EPCIS implementation is free to raise a `QueryTooLargeException` regardless of the setting of this parameter (see section 8.2.3)."
},
{
"name": "GE_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `LT_startTime` parameter)."
},
{
"name": "LT_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `GE_startTime` parameter)."
},
{
"name": "GE_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `LT_endTime` parameter)."
},
{
"name": "LT_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `GE_endTime` parameter)."
},
{
"name": "EQ_type",
"value": "Temperature",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate one or more `sensorElement` fields; and where (b) the `type` attribute in one of these `sensorElement` fields is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `type` attribute or whether a `sensorElement` field exists at all. Standard values for `type` are defined at https://ref.gs1.org/voc/MeasurementType. Standard values SHALL be expressed as bare words, e.g. `Temperature`."
},
{
"name": "EQ_deviceID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `deviceID` attribute; and where (b) the `deviceID` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `deviceID` attribute or whether the `deviceID` attribute exists at all."
},
{
"name": "EQ_dataProcessingMethod",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `dataProcessingMethod` attribute; and where (b) the `dataProcessingMethod` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `dataProcessingMethod` attribute or whether the `dataProcessingMethod` attribute exists at all."
},
{
"name": "EQ_microorganism",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `microorganism` attribute; and where (b) the `microorganism` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `microorganism` attribute or whether the `microorganism` attribute exists at all."
},
{
"name": "EQ_chemicalSubstance",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `chemicalSubstance` attribute; and where (b) the `chemicalSubstance` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `chemicalSubstance` attribute or whether the `chemicalSubstance` attribute exists at all."
},
{
"name": "EQ_bizRules",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `bizRules` attribute; and where (b) the `bizRules` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `bizRules` attribute or whether the `bizRules` attribute exists at all."
},
{
"name": "EQ_stringValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `stringValue` attribute; and where (b) the `stringValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `stringValue` attribute or whether the `stringValue` attribute exists at all."
},
{
"name": "EQ_hexBinaryValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `hexBinaryValue` attribute; and where (b) the `hexBinaryValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `hexBinaryValue` attribute or whether the `hexBinaryValue` attribute exists at all."
},
{
"name": "EQ_uriValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `uriValue` attribute; and where (b) the `uriValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `uriValue` attribute or whether the `uriValue` attribute exists at all."
},
{
"name": "EQ_booleanValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `booleanValue` attribute; and where (b) the `booleanValue` attribute is equal to the specified value (i.e. `true` or `false`). If this parameter is omitted, events are returned regardless of the value of the `booleanValue` attribute or whether the `booleanValue` attribute exists at all"
}
]
},
"docs": "This endpoint helps to navigate EPCIS events by read points. It returns\nEPCIS events up to the amount defined in `perPage`. The server returns a `Link` header to point to the remaining\nresults.\nOptionally, EPCIS events can be further filtered using the EPCIS Query Language as query string parameters.\nExample:\n```\nhttps://example.com/readPoints/urn:epc:id:sgln:0012345.11111.400?GE_eventTime=2015-03-15T00%3A00%3A00.000-04%3A00\n```\nAn EPCIS 2.0 query may also be expressed via the URI query string. "
},
{
"info": {
"name": "Returns all EPCIS events related to the disposition.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/dispositions/:disposition/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "disposition",
"value": "in_progress",
"type": "path",
"description": "A disposition value."
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "eventType",
"value": "ObjectEvent",
"type": "query",
"description": "If specified, the result will only include events whose `type` matches one of the types specified in the parameter value. Each element of the parameter value may be one of the following strings: `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent` or `AssociationEvent`. An element of the parameter value may also be the name of an extension event type. If omitted, all event types will be considered for inclusion in the result."
},
{
"name": "GE_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `LT_eventTime` parameter)."
},
{
"name": "LT_eventTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `eventTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `eventTime` (unless constrained by the `GE_eventTime` parameter)."
},
{
"name": "GE_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` greater than or equal to the specified value will be returned. The automatic limitation based on event record time (section 8.2.5.2) may implicitly provide a constraint similar to this parameter. If omitted, events are included regardless of their `recordTime`, other than automatic limitation based on event record time"
},
{
"name": "LT_recordTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If provided, only events with `recordTime` less than the specified value will be returned. If omitted, events are included regardless of their `recordTime` (unless constrained by the `GE_recordTime` parameter or the automatic limitation based on event record time)"
},
{
"name": "EQ_action",
"value": "OBSERVE",
"type": "query",
"description": "If specified, the result will only include events that (a) have an `action` field; and where (b) the value of the `action` field matches one of the specified values. The properties of the value of this parameter each must be one of the strings `ADD`, `OBSERVE`, or `DELETE`; if not, the implementation SHALL raise a `QueryParameterException`. If omitted, events are included regardless of their `action` field."
},
{
"name": "EQ_bizStep",
"value": "shipping",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizStep` field; and where (b) the value of the `bizStep` field matches one of the specified values. - see CBV BizStep for standard values. Standard values should be expressed as bare words, e.g. `shipping`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `bizStep` field or whether the `bizStep` field exists at all."
},
{
"name": "EQ_disposition",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `disposition` field; and where (b) the value of the `disposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `disposition` field or whether the `disposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_set",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `set` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `set` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_persistentDisposition_unset",
"value": "in_transit",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `persistentDisposition` field; and where (b) the value of the `unset` field within the value of the `persistentDisposition` field matches one of the specified values. - see CBV Disposition for standard values. Standard values should be expressed as bare words, e.g. `in_transit`, whereas custom values should be expressed as URIs or CURIEs for which the namespace prefix is defined. If this parameter is omitted, events are returned regardless of the value of the `unset` field within `persistentDisposition` field or whether the `persistentDisposition` field exists at all."
},
{
"name": "EQ_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs. If this parameter and `WD_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "WD_readPoint",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `readPoint` field; and where (b) the value of the `readPoint` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_readPoint` are both omitted, events are returned regardless of the value of the `readPoint` field or whether the `readPoint` field exists at all."
},
{
"name": "EQ_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs. If this parameter and `WD_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "WD_bizLocation",
"value": "urn:epc:id:sgln:0012345.11111.400",
"type": "query",
"description": "If specified, the result will only include events that (a) have a non-null `bizLocation` field; and where (b) the value of the `bizLocation` field matches one of the specified URIs, or is a direct or indirect descendant of one of the specified values. The meaning of 'direct or indirect descendant' is specified by master data, as described in section 6.5. (WD is an abbreviation for 'with descendants.') If this parameter and `EQ_bizLocation` are both omitted, events are returned regardless of the value of the `bizLocation` field or whether the `bizLocation` field exists at all."
},
{
"name": "EQ_transformationID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `transformationID` field (that is, `TransformationEvent`s or extension event type that extend `TransformationEvent`); and where (b) the `transformationID` field is equal to one of the values specified in this parameter."
},
{
"name": "MATCH_epc",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` or a `childEPCs` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `epcList` or `childEPCs` field (depending on event type) matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `epcList` or `childEPCs` field or whether the `epcList` or `childEPCs` field exists."
},
{
"name": "MATCH_parentID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `parentID` field (that is, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPCs listed in the `parentID` field matches one of the URIs specified in this parameter, where the meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `parentID` field or whether the `parentID` field exists."
},
{
"name": "MATCH_inputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `inputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `inputEPCList` field or whether the `inputEPCList` field exists."
},
{
"name": "MATCH_outputEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputEPCList` (that is, `TransformationEvent` or an extension event type that extends `TransformationEvent`); and where (b) one of the EPCs listed in the `outputEPCList` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1. If this parameter is omitted, events are included regardless of their `outputEPCList` field or whether the `outputEPCList` field exists."
},
{
"name": "MATCH_anyEPC",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `epcList` field, a `childEPCs` field, a `parentID` field, an `inputEPCList` field, or an `outputEPCList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) the `parentID` field or one of the EPCs listed in the `epcList`, `childEPCs`, `inputEPCList`, or `outputEPCList` field (depending on event type) matches one of URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_epcClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList` or a `childQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in the `quantityList` or `childQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The result will also include QuantityEvents whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "MATCH_inputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `inputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `inputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_outputEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have an `outputQuantityList` field (that is, `TransformationEvent` or extension event types that extend it); and where (b) one of the EPC classes listed in the `outputQuantityList` field (depending on event type) matches one of the EPC patterns or URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1"
},
{
"name": "MATCH_anyEPCClass",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a `quantityList`, `childQuantityList`, `inputQuantityList`, or `outputQuantityList` field (that is, `ObjectEvent`, `AggregationEvent`, `TransactionEvent`, `TransformationEvent`, `AssociationEvent` or extension event types that extend one of those event types); and where (b) one of the EPC classes listed in any of those fields matches one of the EPC patterns or URIs specified in this parameter. The result will also include `QuantityEvent`s whose `epcClass` field matches one of the URIs specified in this parameter. The meaning of 'matches' is as specified in section 8.2.7.1.1."
},
{
"name": "EQ_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is equal to the specified parameter."
},
{
"name": "GT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than the specified parameter."
},
{
"name": "GE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is greater than or equal to the specified parameter."
},
{
"name": "LT_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than the specified parameter."
},
{
"name": "LE_quantity",
"value": "",
"type": "query",
"description": "(DEPCRECATED in EPCIS 1.1, REPURPOSED in EPCIS 2.0) If this parameter is specified, the result will only include events that (a) have a `quantity` field as part of a `QuantityElement`; and where (b) the `quantity` field is less than or equal to the specified parameter."
},
{
"name": "EQ_eventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) have a non-null `eventID` field; and where (b) the `eventID` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `eventID` field or whether the `eventID` field exists at all."
},
{
"name": "EXISTS_errorDeclaration",
"value": "",
"type": "query",
"description": "If this parameter is specified (and has a value of true), the result will only include events that contain an `ErrorDeclaration`. If this parameter is omitted (or has a value of false), events are returned regardless of whether they contain an `ErrorDeclaration`."
},
{
"name": "GE_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is greater than or equal to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "LT_errorDeclarationTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the value of the `errorDeclarationTime` field is less than to the specified value. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `errorDeclarationTime` field is."
},
{
"name": "EQ_errorReason",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) the error declaration contains a non-null `reason` field; and where (c) the `reason` field is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or what the value of the `reason` field is."
},
{
"name": "EQ_correctiveEventID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) contain an `ErrorDeclaration`; and where (b) one of the elements of the `correctiveEventIDs` list is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of whether they contain an `ErrorDeclaration` or the contents of the `correctiveEventIDs` list."
},
{
"name": "orderBy",
"value": "",
"type": "query",
"description": "If specified, names a single field that will be used to order the results. The `orderDirection` field specifies whether the ordering is in ascending sequence or descending sequence. Events included in the result that lack the specified field altogether may occur in any position within the result event list. The value of this parameter SHALL be one of: `eventTime`, `recordTime`, or the fully qualified name of an extension field whose type is Int, Float, Time, or String. A fully qualified fieldname is constructed as for the `EQ_fieldname` parameter. In the case of a field of type String, sorting SHALL be according to their case-sensitive lexical ordering, considering UTF-8/ASCII code values of each successive character. If omitted, no order is specified. The implementation MAY order the results in any order it chooses, and that order MAY differ even when the same query is executed twice on the same data. (In EPCIS 1.0, the value `quantity` was also permitted, but its use is deprecated in EPCIS 1.1.)"
},
{
"name": "orderDirection",
"value": "",
"type": "query",
"description": "If specified and `orderBy` is also specified, specifies whether the results are ordered in ascending or descending sequence according to the key specified by `orderBy`. The value of this parameter must be one of `ASC` (for ascending order) or `DESC` (for descending order); if not, the implementation SHALL raise a `QueryParameterException`. If omitted, defaults to `DESC`."
},
{
"name": "eventCountLimit",
"value": "",
"type": "query",
"description": "If specified, the results will only include the first N events that match the other criteria, where N is the value of this parameter. The ordering specified by the `orderBy` and `orderDirection` parameters determine the meaning of “first” for this purpose. If omitted, all events matching the specified criteria will be included in the results. This parameter and `maxEventCount` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. This parameter may only be used when `orderBy` is specified; if `orderBy` is omitted and `eventCountLimit` is specified, a `QueryParameterException` SHALL be raised. This parameter differs from `maxEventCount` in that this parameter limits the amount of data returned, whereas `maxEventCount` causes an exception to be thrown if the limit is exceeded. Explanation (non-normative): A common use of the `orderBy`, `orderDirection`, and `eventCountLimit` parameters is for extremal queries. For example, to select the most recent event matching some criteria, the query would include parameters that select events matching the desired criteria, and set `orderBy` to `eventTime`, `orderDirection` to `DESC`, and `eventCountLimit` to 1."
},
{
"name": "maxEventCount",
"value": "",
"type": "query",
"description": "If specified, at most this many events will be included in the query result. If the query would otherwise return more than this number of events, a `QueryTooLargeException` SHALL be raised instead of a normal query result. This parameter and `eventCountLimit` are mutually exclusive; if both are specified, a `QueryParameterException` SHALL be raised. If this parameter is omitted, any number of events may be included in the query result. Note, however, that the EPCIS implementation is free to raise a `QueryTooLargeException` regardless of the setting of this parameter (see section 8.2.3)."
},
{
"name": "GE_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `LT_startTime` parameter)."
},
{
"name": "LT_startTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `startTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `startTime` (unless constrained by the `GE_startTime` parameter)."
},
{
"name": "GE_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` greater than or equal to the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `LT_endTime` parameter)."
},
{
"name": "LT_endTime",
"value": "2022-06-30T00:15:47.000-05:00",
"type": "query",
"description": "If specified, only events with `endTime` less than the specified value will be included in the result. If omitted, events are included regardless of their `endTime` (unless constrained by the `GE_endTime` parameter)."
},
{
"name": "EQ_type",
"value": "Temperature",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate one or more `sensorElement` fields; and where (b) the `type` attribute in one of these `sensorElement` fields is equal to one of the values specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `type` attribute or whether a `sensorElement` field exists at all. Standard values for `type` are defined at https://ref.gs1.org/voc/MeasurementType. Standard values SHALL be expressed as bare words, e.g. `Temperature`."
},
{
"name": "EQ_deviceID",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `deviceID` attribute; and where (b) the `deviceID` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `deviceID` attribute or whether the `deviceID` attribute exists at all."
},
{
"name": "EQ_dataProcessingMethod",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `dataProcessingMethod` attribute; and where (b) the `dataProcessingMethod` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `dataProcessingMethod` attribute or whether the `dataProcessingMethod` attribute exists at all."
},
{
"name": "EQ_microorganism",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `microorganism` attribute; and where (b) the `microorganism` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `microorganism` attribute or whether the `microorganism` attribute exists at all."
},
{
"name": "EQ_chemicalSubstance",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `chemicalSubstance` attribute; and where (b) the `chemicalSubstance` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `chemicalSubstance` attribute or whether the `chemicalSubstance` attribute exists at all."
},
{
"name": "EQ_bizRules",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `bizRules` attribute; and where (b) the `bizRules` attribute is equal to one of the URIs specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `bizRules` attribute or whether the `bizRules` attribute exists at all."
},
{
"name": "EQ_stringValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `stringValue` attribute; and where (b) the `stringValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `stringValue` attribute or whether the `stringValue` attribute exists at all."
},
{
"name": "EQ_hexBinaryValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `hexBinaryValue` attribute; and where (b) the `hexBinaryValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `hexBinaryValue` attribute or whether the `hexBinaryValue` attribute exists at all."
},
{
"name": "EQ_uriValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `uriValue` attribute; and where (b) the `uriValue` attribute is equal to one of the strings specified in this parameter. If this parameter is omitted, events are returned regardless of the value of the `uriValue` attribute or whether the `uriValue` attribute exists at all."
},
{
"name": "EQ_booleanValue",
"value": "",
"type": "query",
"description": "If this parameter is specified, the result will only include events that (a) accommodate a `booleanValue` attribute; and where (b) the `booleanValue` attribute is equal to the specified value (i.e. `true` or `false`). If this parameter is omitted, events are returned regardless of the value of the `booleanValue` attribute or whether the `booleanValue` attribute exists at all"
}
]
},
"docs": "This endpoint helps to navigate EPCIS events by dispositions. It returns\nEPCIS events up to the amount defined in `perPage`. The server returns a `Link` header to point to the remaining\nresults.\nOptionally, EPCIS events can be further filtered using the EPCIS Query Language as query string parameters.\nExample:\n```\nhttps://example.com/dispositions/in_progress?GE_eventTime=2015-03-15T00%3A00%3A00.000-04%3A00\n```\nAn EPCIS 2.0 query may also be expressed via the URI query string. The query paramete"
}
]
},
{
"info": {
"name": "Queries",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns a list of queries available.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/queries",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
}
],
"params": [
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
}
]
},
"docs": "An endpoint to list named queries.\nThis endpoint supports pagination.\n"
},
{
"info": {
"name": "Creates a named EPCIS events query.\n",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/queries",
"headers": [
{
"name": "GS1-EPCIS-Version",
"value": ""
},
{
"name": "GS1-CBV-Version",
"value": ""
},
{
"name": "GS1-Extensions",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creating a named query creates a view on the events in the repository, accessible through its events resource.\nTo obtain the named query results, the client can use the URL in the `Location` header. The client can also use this URL to start a query subscription immediately after creating the query.\n"
},
{
"info": {
"name": "Returns the query definition.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/queries/:queryName",
"headers": [
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "queryName",
"value": "",
"type": "path",
"description": "The name of an EPCIS event query."
}
]
},
"docs": "Returns the query definition."
},
{
"info": {
"name": "Removes a named query and forcibly unsubscribes all active subscriptions, whether by WebSockets or Webhooks",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/queries/:queryName",
"params": [
{
"name": "queryName",
"value": "",
"type": "path",
"description": "The name of an EPCIS event query."
}
]
},
"docs": "Removes a named query and forcibly unsubscribes all active subscriptions, whether by WebSockets or Webhooks"
},
{
"info": {
"name": "Returns active subscriptions with the option to use pagination if needed.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/queries/:queryName/subscriptions",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
}
],
"params": [
{
"name": "queryName",
"value": "",
"type": "path",
"description": "The name of an EPCIS event query."
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
}
]
},
"docs": "The `GET` endpoint is to list all active subscriptions on that query.\n"
},
{
"info": {
"name": "Creates a query subscription.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/queries/:queryName/subscriptions",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "GS1-EPCIS-Version",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "queryName",
"value": "",
"type": "path",
"description": "The name of an EPCIS event query."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "EPCIS 2.0 implementations must support Webhook subscriptions. \nCreating a query subscription requires the client to provide a single endpoint to which the\nserver will send events (as `EPCISQueryDocument`) and an optional string `signatureToken`. \nThis `signatureToken` must be generated by the client and is used by the server to authenticate itself and sign messages when sending events. The signature must be contained on the `GS1-Signature` HTTP header of the server request. \n\nThe choice of signa"
},
{
"info": {
"name": "Returns the details of a subscription. This method is useful to verify if a subscription is still active.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/queries/:queryName/subscriptions/:subscriptionID",
"headers": [
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-Extensions",
"value": ""
}
],
"params": [
{
"name": "queryName",
"value": "",
"type": "path",
"description": "The name of an EPCIS event query."
},
{
"name": "subscriptionID",
"value": "df5a33e3-5aa3-4403-ae01-99b83234e27b",
"type": "path"
}
]
},
"docs": "Returns the details of a subscription. This method is useful to verify if a subscription is still active."
},
{
"info": {
"name": "Unsubscribes a client by deleting the query subscription.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/queries/:queryName/subscriptions/:subscriptionID",
"params": [
{
"name": "queryName",
"value": "",
"type": "path",
"description": "The name of an EPCIS event query."
},
{
"name": "subscriptionID",
"value": "df5a33e3-5aa3-4403-ae01-99b83234e27b",
"type": "path"
}
]
},
"docs": "Unsubscribes a client by deleting the query subscription."
},
{
"info": {
"name": "Returns EPCIS events with the option to use pagination if needed. This endpoint supports query subscriptions\nusing WebSockets.\n",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/queries/:queryName/events",
"headers": [
{
"name": "GS1-Extensions",
"value": ""
},
{
"name": "Upgrade",
"value": ""
},
{
"name": "Connection",
"value": ""
},
{
"name": "GS1-CBV-Min",
"value": ""
},
{
"name": "GS1-CBV-Max",
"value": ""
},
{
"name": "GS1-EPCIS-Min",
"value": ""
},
{
"name": "GS1-EPCIS-Max",
"value": ""
},
{
"name": "GS1-EPC-Format",
"value": ""
},
{
"name": "GS1-CBV-XML-Format",
"value": ""
}
],
"params": [
{
"name": "queryName",
"value": "",
"type": "path",
"description": "The name of an EPCIS event query."
},
{
"name": "reportIfEmpty",
"value": "",
"type": "query"
},
{
"name": "initialRecordTime",
"value": "",
"type": "query"
},
{
"name": "second",
"value": "",
"type": "query"
},
{
"name": "minute",
"value": "",
"type": "query"
},
{
"name": "hour",
"value": "",
"type": "query"
},
{
"name": "dayOfMonth",
"value": "",
"type": "query"
},
{
"name": "month",
"value": "",
"type": "query"
},
{
"name": "dayOfWeek",
"value": "",
"type": "query"
},
{
"name": "stream",
"value": "",
"type": "query"
},
{
"name": "nextPageToken",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
}
]
},
"docs": "The `GET` endpoint is to retrieve results of a named query.\nFurthermore, this endpoint can also be used to subscribe to queries using Websocket. To do this, the client\nmust specify the query schedule or set the `stream` parameter to `true` as a URL query string parameter. Please\nnote that scheduling parameters and the `stream` parameter are mutually exclusive.\n## Scheduled query: Receive query results at 1.05am\nHandshake from client for scheduled query:\n```\nGET https://example.com/queries/MyQue"
},
{
"info": {
"name": "Optional endpoint that allows on-demand release of any resources associated with `nextPageToken`.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/nextPageToken/:token",
"params": [
{
"name": "token",
"value": "",
"type": "path"
}
]
},
"docs": "Optional endpoint that allows on-demand release of any resources associated with `nextPageToken`."
}
]
}
],
"bundled": true
}