Object Queries

epcs

Filter on the epc of an entity. Multiple epcs may be specified. Wildcards '*' may be used.

entityClass

Filter on entityClass. Legal values are "batch", "tradeunit" and "tradeunitcluster".

entityTypeIds

Return only the objects that have the specified TRD type.

GE_created

Limit the search on objects with created date after GE_created

LE_created                                  

Limit the search on objects with created date before LE_created

hasProperty_tt:[propertyName]

Used without a parameter value. Return entities that have the specific property set, regardless of value.

notHasProperty_tt:[propertyName]

Used without a prarameter value. Return entities that do not have the property set.

eqProperty_tt:[propertyName]

Filter the EPCs on property values. Includes only the entities where the specified property name is equal to the given value. If you have multiple eqProperty_tts with the same property name, they will always be combined using OR otherwise they are combined using the specified operatorType. Example: If you specify several eqProperty_tt with the same propertyName, e.g. eqProperty_tt:myProperty=a&eqProperty_tt:myProperty=b&eqProperty_tt:myProperty=c&operatorType=AND, then they will be concatenated using OR, no matter which operatorType did you specify (because AND wouldn't make any sense in such situation), otherwise (eqProperty_tt:myFirstProperty=a&eqProperty_tt:mySecondProperty=b&eqProperty_tt:myThirdProperty=c&operatorType=AND) operator specified by operatorType parameter is used.

neqProperty_tt:[propertyName]

The same as the parameter above, except that this filters on entities without a specific property value.

geProperty_tt:[propertyName]

Filter on entities with a specific property type with a value greater or equal to the specified value.

leProperty_tt:[propertyName]

Filter on entities with a specific property type with a value value lesser or equal to the specified value.

gtProperty_tt:[propertyName]

Filter on entities with a specific property type with a value value greater than the specified value.

ltProperty_tt:[propertyName]

Filter on entities with a specific property type with a value value lesser than the specified value.

matchAny

Takes a substring as an argument and will match against epcs and property values. If includeAggregated is true, matchAny will also filter on these. If the substring does not contain wildcards, a subtext search will be performed, or else the wildcard '*' will be used as is. This means that matchAny=*foo will be a prefix search, and matchAny=foo* will be a suffix search. The match will be case insensitive.

matchTypes

Used in conjunction with the matchAny parameter. If specified, this will limit the property types searched by the matchAny parameter. Example: if matchTypes is set to "articledescription" then other property types will be ignored when using matchAny. Note that multiple matchTypes parameters may by specified.

A family of parameter that will use pure identity patterns found in the EPCClass vocabulary for looking up EPCs. If this parameter is used, a MasterDataQuery will be run first, looking for the specified attribute and value. The vocabulary elements returned that are identity patterns will be used for matching objects.

If this parameter is used in conjunction with includeAggregated, objects will also be returned if the aggregated objects match the identity patterns.

Examples of legal attrParams:

• matchAny_EPCClass:EQATTR_quality=supreme    Find objects belonging to the class that has the masterdata property "quality" that has the value "supreme".
• matchAny_EPCClass:HASATTR=quality  Find objects belonging to the class that has the quality property.
• matchAny_EPCClass:likeAttr_color=green  Find objects belonging to a class that has the masterdata property color and a value containing the string "green". In other words, this parameter uses substring matching.

Non identity pattern matching may also be performed. If the id of the vocabulary element start with urn:gtnet:idpat:non-schema:*-123-* the suffixed wildcard (*-123-*) will be used to match epcs.

matchAlternateIds

hasOutgoing

If set to true, only return entities that have outgoing transformations. In the graphs, transformations are always viewed left to right. Outgoing transformations originate from the object you're looking at and therefore an outgoing transformation is a transformation where the entity appears on the left side. If set to false, return only entities that do not have any outgoing transformations.

hasIncoming

If set to true, only return entities that have incoming transformations. In the graphs, transformations are always viewed left to right. Incoming transformations are the ones where the object you're looking at is the destination and therefore an incoming transformation is a transformation where the entity appears on the right side. If set to false, return only entities that do not have any incoming transformations.

partialMatch

If true, the matching of the epcs parameters will be performed using substring matching.

includeAggregated

If true, return other entities that may have been inside the returned entities.

includeProperties

includeTransformations

If true, the transformations of the returned entities will be included in the result set.

includeLinks

includeLinksConfirmTime

linkAlias

Filter the result to only contain objects that have a link and where the sender or receiver of the link is one of the values of this parameter. When combined with matchAny or matchAny_EPCClass the OR operator will be used when building the query.

isSent

Filter on entities that have been sent to GTNet.

hasSentTo

If true, returns object that are outgoing shipments. If false, returns objects that are not outgoing shipments. Special rules apply when combined with hasReceivedFrom. See details on hasReceivedFrom.

hasReceivedFrom

If true, returns object that are incoming shipments. If false, returns objects that are not incoming shipments.

If combined with hasSentTo, they will return all objects that are incoming or outgoing shipments. If hasSentTo is true and hasReceivedFrom is false, you may still get results with hasReceivedFrom=true but only those that also have hasSentTo=true.

If both are false, only objects that are not incoming shipments and not outgoing shipments will be returned.

GE_receiveTime

If set, return only those objects that are received at the specified time or later. This parameter implies hasReceivedFrom=true. Special rules apply when combined with GE/LE_sendTime. See hasReceivedFrom for details.

LE_receiveTime

If set, return only those objects that are received at the specified time or earlier. This parameter implies hasReceivedFrom=true. Special rules apply when combined with GE/LE_sendTime. See hasReceivedFrom for details.

GE_sendTime

If set, return only those objects that are sent at the specified time or later. This parameter implies hasSentTo=true. Special rules apply when combined with GE/LE_receiveTime. See hasReceivedFrom for details.

LE_sendTime

If set, return only those objects that are sent at the specified time or earlier. This parameter implies hasSentTo=true. Special rules apply when combined with GE/LE_receiveTime. See hasReceivedFrom for details.

If set, return only those object that are updated at the specified time or later.

LE_lastEventTime

If set, return only those object that are updated at the specified time or earlier.

remoteNodeId

If set, returns the details found in a remote node given the other parameters.

operatorType

OR

When providing property values for searching this parameter specifies the operator type. Legal values are "and" or "or".

orderBy

The field in the query to order by. Legal values are "epc", "created", "linkTime", "lastEventTime", "lastPropertyTime", "property_tt:[propertytype]" or "propertyEventTime_tt:[propertytype]". When ordering on a specific property value, only entities with that property value are returned.

"linkTime" must be combined with hasReceivedFrom=true and or hasSentTo=true

If set, return the property log for the properties specified in the includeProperties parameter that was updated at the specified time or earlier. The property log will be sorted in ascending order. Can be combined with GE_result_time.

includeMasterData

includeMetaData

asc

Ordering will be ascending if true. Descending if false.

pageNumber

1

Specifies the page number to return. If not specified, the first page is returned.

pageSize

20

Specifies the number of entities to return in the result set.