The About API provides endpoints for retrieving details about the TIX and the authenticated users. The API also provides details about the master data and meta data associated with the TIX organization/Node.

Resources

GET /about

This endpoint retrieves details about the TIX instance, its version, capabilities and configuration properties.

GET /tix/api/xml/about?nodeId=0800000015000019&includeMasterData=true
<about xmlns:ns2="http://schema.tracetracker.com/about">
<vendor>TraceTracker</vendor>
<version>
<standard>1.0.1</standard>
<vendor>6.0.42</vendor>
</version>
<capabilities>
<capability>/api/xml/about</capability>
<capability>/api/xml/admin/queue/import</capability>
<capability>/api/xml/event</capability>
<capability>/api/xml/event/epc/{epc}</capability>
<capability>/api/xml/object</capability>
<capability>/api/xml/query/CountEventQuery</capability>
<capability>/api/xml/query/ExtendedEventQuery</capability>
<capability>/api/xml/query/SimpleEventQuery</capability>
<capability>/api/xml/query/SimpleEventTrace</capability>
<capability>/api/xml/query/SimpleMasterDataQuery</capability>
</capabilities>
<properties>
<properties name="user">administrator</properties>
<properties name="gan.id">0800000015000019</properties>
<properties name="org.id">0800000015</properties>
<properties name="hub.gap">https://hub.tracetracker.com/gap</properties>
<properties name="mds.gap">https://mds.tracetracker.com/gap</properties>
<properties name="mds.service.id">MASTERDATA:PROD</properties>
<properties name="mds.console">https://mds.tracetracker.com</properties>
<properties name="mds.fullname">Masterdata for Prod Environment</properties>
<properties name="mds.gan.id">0800001908600035</properties>
<properties name="node.name">additives</properties>
<properties name="node.fullname">Additives GAN</properties>
<properties name="org.name">no.additives</properties>
<properties name="org.fullname">Additives Producer</properties>
<properties name="timezone">Europe/Oslo</properties>
<properties name="tix.downstream-basic">false</properties>
<properties name="cbvValidation">false</properties>
<properties name="epcis.strictConformance">false</properties>
<properties name="api.graph.png.maxwidth">2000</properties>
<properties name="api.graph.png.maxheight">768</properties>
<properties name="api.query.epcis.max-result">1000</properties>
<properties name="api.object.defaultPageSize">20</properties>
</properties>
<ns7:masterdata>
<ns7:organization id="0800000024">
<ns7:attribute id="C">KE</ns7:attribute>
<ns7:attribute id="LAST_MOD">2006-04-11 11:18:27</ns7:attribute>
<ns7:attribute id="MDV">urn:tracetracker:mds:gns:organization</ns7:attribute>
<ns7:attribute id="TEST">1</ns7:attribute>
<ns7:attribute id="NODES">0800000015000019,0800000024000011</ns7:attribute>
<ns7:attribute id="OID">0800000024</ns7:attribute>
<ns7:attribute id="GLN">0035198000006</ns7:attribute>
<ns7:attribute id="DUNS">080000002</ns7:attribute>
<ns7:attribute id="FN">Feed Company</ns7:attribute>
<ns7:attribute id="MDS">MASTERDATA:TEST</ns7:attribute>
<ns7:attribute id="ON">no.feed</ns7:attribute>
<ns7:attribute id="MDE">9</ns7:attribute>
</ns7:organization>
<ns7:node id="0800000024000011">
<ns7:attribute id="NN">no.feed.gan</ns7:attribute>
<ns7:attribute id="TEST">1</ns7:attribute>
<ns7:attribute id="C">KE</ns7:attribute>
<ns7:attribute id="LAST_MOD">2006-06-15 11:34:33</ns7:attribute>
<ns7:attribute id="NA">
https://foylejboss2.pd.tracetracker.com:9443/tix/feed
</ns7:attribute>
<ns7:attribute id="NID">0800000015000019</ns7:attribute>
<ns7:attribute id="GLN"/>
<ns7:attribute id="DUNS"/>
<ns7:attribute id="HUB">0990000013000013</ns7:attribute>
<ns7:attribute id="AT">HESSIAN_HTTPS</ns7:attribute>
<ns7:attribute id="MDS">MASTERDATA:TEST</ns7:attribute>
<ns7:attribute id="FN">Feed Gan</ns7:attribute>
<ns7:attribute id="MDE">7</ns7:attribute>
<ns7:attribute id="MDV">urn:tracetracker:mds:gns:node</ns7:attribute>
</ns7:node>
</ns7:masterdata>
</about>

Elements

Name

Description

Name

Description

vendor

The vendor name

version

The version numbers

properties

Lists configuration for the TIX

capabilities

List API endpoints available

masterdata

The organization and or node master data attributes when the parameter "includeMasterData" is set to "true". The default

value for this parameter is "false". The attributes returned by the endpoint consists of the id, an optional label resolved from

the data dictionary and the attribute value.

metadata

A list of data dictionary definitions for the properties that constitute the master data for this organization. The

parameter "includeMetaData" has to be set to "true", it defaults to "false". Note that the "includeMetaData" parameter

includes the masterdata element described above.

remoteNodeMasterData

The about endpoint can be used also to fetch the master data for a remote node id. When the parameter "remoteNodeId"

is included in the query the query result will include the master data, if any, for the organization and node denoted by the

remoteNodeId parameter. This is different from the masterdata and metadata elements above in that they refer to master/meta

data that belong to the organization/node the user is currently connected to.

Master/Meta Data Resolution

This is done via pointers in the TIX's GNS vocabularies for organization and node. Master Data pointers are MDV (id of the vocabulary containing masterdata for the organization/node) and MDE (id of the vocabulary element containing masterdata for the organization/node). TIX uses these pointers to query the MDS for the masterdata for the organization/node. When MDV is not defined then the MDE is used by default to look u

Meta data is fetched from the MDS using the pointer urn:gtnet:dictionary:reference in the GNS vocabulary for Organization.

Properties description

Name

Description

Name

Description

user

The username for the authenticated user

org.name

The name of the organization

gan.id

The nodeId

org.fullname

The full name of the organization

org.id

The organization id

timezone

The timezone used by TIX console when presenting time and the timezone that will be used when capturing data without Time Zone.

hub.gap

The GAP URL for the HUB.

tix.downstream-basic

The TIX is downstream-basic if this property is true. This means the TIX features are limited including no data capture.

mds.gap

The GAP URL for the MDS.

cbvValidation

Strict CBV validation is enforced if this property is true. Strict validation means that only values defined in the CBV specification can be for bizStep and disposition values.

mds.service.id

The service identifier for MDS.

epcis.strictConformance

If true, TIX will enforce EPCs that are EPCIS-compliant when importing XML data. However, this breaks backwards compatibility with older TIXes.

mds.console

URL to the MDS console.

api.graph.png.maxwidth

The max width for graphs, see Graph Queries for more information.

mds.fullname

Name of the MDS instance.

api.graph.png.maxheight

The max height for graphs, see Graph Queries for more information.

mds.gan.id

The nodeId for the MDS.

api.query.epcis.max-result

The max page size and events returned from the SimpleEventQuery and ExtendedEventQuery. See Event Queries for more information.

node.name

The name for the nodeId.

api.object.defaultPageSize

The default page size for objects returned from object queries, see Object Queries for more information.

node.fullname

The full name for the nodeId.

 

 

GET /about/user

 This endpoints retrieves details about the authenticated user, its roles and nodes it can access.

<about xmlns:ns2="http://schema.tracetracker.com/about">
<user>administrator</user>
<organization>0800002819</organization>
<roles>
<role>API</role>
<role>CONSOLE</role>
<role>WORKER</role>
</roles>
<nodeIds>
<nodeId
FN="Additives GAN"
NN="additives"
ORG-FN="Additives Producer">0800000015000019</nodeId>
<nodeId
FN="Feed GAN"
NN="feed"
ORG-FN="Feed Company"
AA="https://remote.tix.com/instance">0800000024000011</nodeId>
</nodeIds>
</about>

Elements

Name

Description

Name

Description

user

The username for the authenticated user

organization

The organization the user belongs to

roles

List the roles the authenticated user have been granted

nodeIds

List all nodes the user has access to.

NodeId attributes

Name

Description

Name

Description

FN

Node full name

NN

Node name

ORG-FN

Organization full name

AA

Optional URL included if the nodeId is not managed by the TIX. The URL is to the remote TIX that is managing the NodeId.