Returns all EPCIS events available in the EPCIS repository.

get

https://nedap-harmony.com/api/{workspaceId}/epcis/v1/events

This endpoint allows querying EPCIS events that are currently in the repository. Events can be filtered through URL query string parameters as specified by the EPCIS Query Language. An 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.0/query-schema.json. An EPCIS 2.0 query may also be expressed via parameters in the URI query string. The query parameters with fixed fieldnames are included in this OpenAPI interface. However, this list is not exhaustive and the EPCIS 2.0 standard defines additional query parameters with flexible names, depending on the specific value of uom, type or fieldname that appears within the name of the parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workspaceId

uuid

required

WorkspaceId of the workspace the API call is for.

Query Params

test

string

Whether this is a request for 'Test' or 'Live' environment. True refers to the 'Test' environment, no value or False refers to the 'Live' environment.

EXISTS_bizTransaction

boolean

EQ_bizTransaction_type

array of strings

EQ_bizTransaction_type

EQ_bizTransaction_bizTransaction

array of uris

EQ_bizTransaction_bizTransaction

EQ_typeReference

array of strings

EQ_typeReference

eventType

array of strings

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.

eventType

GE_eventTime

date-time

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).

LT_eventTime

date-time

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).

GE_recordTime

date-time

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 (section 8.2.5.2).

LT_recordTime

date-time

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).

EQ_action

array of strings

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.

EQ_action

EQ_bizStep

array of strings

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 <a href="https://ref.gs1.org/cbv/BizStep\" target="_blank">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.

EQ_bizStep

EQ_disposition

array of strings

Like the EQ_bizStep parameter, but for the disposition field.

EQ_disposition

EQ_persistentDisposition_set

array of strings

Like the EQ_bizStep parameter, but for the persistentDisposition set field.

EQ_persistentDisposition_set

EQ_persistentDisposition_unset

array of strings

Like the EQ_bizStep parameter, but for the persistentDisposition unset field.

EQ_persistentDisposition_unset

EQ_readPoint

array of uris

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.

EQ_readPoint

WD_readPoint

array of uris

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.

WD_readPoint

EQ_bizLocation

array of uris

Like the EQ_readPoint parameter, but for the bizLocation field.

EQ_bizLocation

WD_bizLocation

array of uris

Like the WD_readPoint parameter, but for the bizLocation field.

WD_bizLocation

MATCH_epc

array of uris

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.

MATCH_epc

orderBy

string

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, Double, Time, or String.

orderDirection

string

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.

eventCountLimit

int32

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.

maxEventCount

int32

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.

nextPageToken

string

Parameter that points to the next list of results when requesting a list of events that is larger than the value specified with the perPage parameter. Some technologies refer to this as scrolling. nextPageToken may be invalidated through timeout. It is up to the specific implementation to provide the mechanisms for invalidating tokens.

perPage

int32

This parameter helps to control the amount of data returned to the client through pagination. In the case of EPCIS events, perPage specifies the maximum number of events in a response to the client. It does not mandate that the server reaches this limit. For example, if the server sees that some EPCIS events are very large, the server can decide to return fewer events to avoid creating an error because the response body is too large. As long as there are more resources to retrieve, the Link header contains the URL of the next page and the attribute rel=\"next\". The last page is indicated by the absence of the rel=\"next\". Depending on the implementation, there can be a global upper limit for the perPage value that the client cannot override, which should be stated in the documentation.

Responses

401

Unauthorized

403

Forbidden

429

Too Many Requests

200OK