AMA

This is the reference documentation for the REST API called the Asset Management API, or just "AMA" for short. The API provides query and capture functionality on the entities that are part of the Asset data model. The data are either event data stored in an EPCIS (TIX) or Master Data stored in TT MDS. Some API functions query both repositories or capture data to both repositories.

Resources

About

URI	/api/1/about
Description	You can from this endpoint get the application details.
URI Parameters
HTTP Methods	`GET \| POST`

Example of response XML:

<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
 <about>
  <vendor>TraceTracker</vendor>
  <version>
   <standard>1.0</standard>
   <vendor>2.3.2-SNAPSHOT</vendor>
 </version>
 </about>
</ttAMA:amaResponse> 

About user

URI	/api/1/about/user
Description	You can from this endpoint get the details about the user you currently is using when accessing AMA, details includes a list of all roles the user is associated with.
URI Parameters
HTTP Methods	`GET`

Example of response XML:

<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
 <about>
  <user>username</user>
  <roles>
   <role>API</role>
   <role>ASSET</role>
  </roles>
 </about>
</ttAMA:amaResponse>

Admin Asset

URI

/api/1/asset/admin/asset

Description

The addAsset endpoints allows users to add new assets to Asset. This endpoint provides the same functionality as available from the web application at ASSET/admin/new/asset.jsf. You can read more about the operation at Managing Assets from AMA. You can from this endpoint also assign more internalId (tags) to an existing asset by posting the new internalId with forceUpdate set to true.

URI Parameters

name	description	type	default
legacyId	Legacy id (application id) to be associated with asset	form
internalId	Internal asset id to be mapped to legacy id, the internalId may not be epc, mds or device, this parameter is optional.	form
assetType	Full master data key of an asset type. If the type of the given legacyId is already known to Asset, this parameter is optional.	form
internalType	Type of internal id. Default: EPC	form	EPC
forceUpdate	Try to force update of back-ends. Default: false.	form	false
timestamp	the commission time to use if the asset is new and not commissioned. ISO-8601 with format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Note, you need to escape the '+' sign in the timezone, example: 2010-11-04T14:00:29%2B01:00. This parameter is optional, it will by default be set to current time.	form
latitude	optional latitude for the new device	form
longitude	optional longitude for the new device.	form

HTTP Methods

POST

Required Roles

API ASSET WORKER
MOBILE

Asset Destination Add

URI

/api/1/asset/destinations/add

Description

This endpoint allows users to create a new destination with given Id. The Content-Type used should be application/x-www-form-urlencoded

URI Parameters

name	description	type	default
destinationId	ID will be sanitised if it contains invalid characters. If it doesn't start in the format urn:gtnet:id:gsti:{companyPrefix}., it'll be modified as urn:gtnet:id:gsti:9999.0005 for example. Means 9999 is company prefix and 0005 a unique Id.	form
startGeoloc	lat/lng comma-separated string of start point.	form
endGeoloc	lat/lng comma-separated string of end point.	form
startAlias	Friendly name for the start location.	form
endAlias	Friendly name for the end location.	form
startGeoBoundary	the value of startGeoBoundary a space separated list of geo-coordinates e.g -0.03470014122084642,35.85267303154252 0.3333399683627102,35.863659359667516 -0.17202898643508405,37.429211117479944 -0.9300450400464968,36.74256560966747 -0.6609061897269104,35.42420623466754	form
endGeoBoundary	the value of endGeoBoundary	form
forceUpdate	Optional if true, existing destination with given ID is overwritten with new values. Default is false	form	false

HTTP Methods

POST

Required Roles

API ASSET ADMIN
MOBILE

Asset Destination List

URI

/api/1/asset/destinations/list

Description

This endpoint allows users to list Destinations of given ids. a new destination with given Id.

URI Parameters

name	description	type	default
destinationId	destination Id(s). e.g urn:gtnet:id:gsti:9999.0005 where 9999 is the company prefix. The last values after the prefix can be used as well. If not specified; all destinations are returned.	query

HTTP Methods

GET

Required Roles

API ASSET
MOBILE

Asset Destination Remove

URI

/api/1/asset/destinations/remove

Description

This endpoint allows users to remove destination from the Master Data Service.

URI Parameters

name	description	type	default
destinationId	destination ID. e.g urn:gtnet:id:gsti:9999.0005 for company ID 9999 and unique destination ID 0005. If 0005 is provided, it is appended to a URN form.	query

HTTP Methods

DELETE

Response Body

HTTP OK for success, HTTP 404 when this ID doesn't match any existing destination.

Required Roles

API ASSET
MOBILE

Admin Device

URI

/api/1/asset/admin/device

Description

The addDevice endpoints allows users to add new devices to Asset.. This endpoint provides the same functionality as available from the web application at ASSET/admin/new/asset.jsf. You can read more about the operation at Managing Assets from AMA

The Content-Type used should be application/x-www-form-urlencoded.
Updates Herder, EPCIS and TTMDS (with mappings).

URI Parameters

name	description	type	default
legacyId	Legacy id (application id) to be associated with device	form
internalId	Device id to be mapped to legacy id.	form
assetType	Full master data key of an asset type. If the type of the given legacyId is already known to Asset, this parameter is optional.	form
internalType	Type of internal id. Default: "IMEI"	form	IMEI
forceUpdate	Try to force update of back-ends. Default: false.	form	false
timestamp	the commission time to use if the device is new and not commissioned. ISO-8601 with format yyyy-MM-dd'T'HH:mm:ss.SSSZ. Note, you need to escape the '+' sign in the timezone, example: 2010-11-04T14:00:29%2B01:00. This parameter is optional, it will by default be set to current time.	form
latitude	optional latitude for the new device	form
longitude	optional longitude for the new device.	form

HTTP Methods

POST

Required Roles

API ASSET WORKER
MOBILE

Asset update comment

URI

/api/1/asset/admin/asset/{asset}/comment

/api/1/asset/admin/asset/comment/add

Description

You can from this endpoint add a comment to an asset. This endpoint provides the same functionality as available from the web application at ASSET/admin/edit/comment.jsf

URI Parameters

name	description	type	default
asset	The legacy ID or tag ID of the asset to change.	path
comment	The comment to add. The comment can contain following HTML tags: u b i strike all other tags will be removed from the comment.	query
includeMasterData	If true, the result will contain master data about the asset and its location.	query	false
includeEventData	If true, the result will contain the last event of the asset.	query	false
timestamp	The time when time comment was created. ISO-8601 with format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Note, you need to escape the '+' sign in the timezone, example: `2010-11-04T14:00:29%2B01:00`. This parameter is optional, it will by default be set to current time.	query

HTTP Methods

POST | PUT

Required Roles

API ASSET
MOBILE

Example of response XML:

<?xml version="1.0" encoding="utf-8"?>
<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
 <status>
  <statusCode>10000</statusCode>
  <statusMessage>
    Request ok, parameters legal with legal values.
  </statusMessage>
 </status>
</ttAMA:amaResponse>

Asset remove comment

URI

/api/1/asset/admin/asset/{asset}/comment

/api/1/asset/admin/asset/comment/delete

Description

You can from this endpoint remove the comment (if any) from an Asset.

URI Parameters

name	description	type	default
asset	The legacy ID or tag ID of the asset to change.	path
includeMasterData	If true, the result will contain master data about the asset and its location.	query	false
includeEventData	If true, the result will contain the last event of the asset.	query	false
timestamp	The time when time comment was removed. ISO-8601 with format yyyy-MM-dd'T'HH:mm:ss.SSSZ. Note, you need to escape the '+' sign in the timezone, example: 2010-11-04T14:00:29%2B01:00. This parameter is optional, it will by default be set to current time.

HTTP Methods

DELETE

Required Roles

API ASSET
MOBILE

Asset update location

URI

/api/1/asset/admin/asset/{asset}/location
/api/1/asset/admin/asset/location

Description

You can from this endpoint update the location of an asset. The project for the asset will be updated when changing the location, the new project will be the project whose boundary intercepts the latitude and longitude or UNKNOWN if no project boundaries intercepts the GPS position.

URI Parameters

name	description	type	default
asset	The legacy id or tag id of the asset to change.	path
latitude	The new latitude of the asset.	form
longitude	The new longitude of the asset.	form
includeMasterData	If true, the result will contain master data about the asset and its location.	form	false
includeEventData	If true, the result will contain the last event of the asset.	form	false
timestamp	The time when location changed. ISO-8601 with format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Note, you need to escape the '+' sign in the timezone, example:2010-11-04T14:00:29%2B01:00. This parameter is optional, it will by default be set to current time.	form

HTTP Methods

PUT

Required Roles

API ASSET WORKER
MOBILE

Example of response XML:

<?xml version="1.0" encoding="utf-8"?>
<ttAMA:amaResponse
 xmlns:epcis="urn:epcglobal:epcis:xsd:1"
 xmlns:ttAMA="http://schema.tracetracker.com/ttAMA"
 xmlns:tt="http://www.tracetracker.com/data">
 <epcis:events>
  <ObjectEvent>
   <eventTime>2012-06-26T14:49:34.839+02:00</eventTime>
   <eventTimeZoneOffset>+03:00</eventTimeZoneOffset>
   <epcList>
    <epc>urn:gtnet:id:gsii:1.441301.441301</epc>
   </epcList>
   <action>OBSERVE</action>
   <bizStep>urn:epcglobal:cbv:bizstep:departing</bizStep>
   <disposition>urn:epcglobal:cbv:disp:in_transit</disposition>
   <tt:asset_location>urn:gtnet:id:gsli:1.UNKNOWN</tt:asset_location>
   <tt:asset_status>20_idle</tt:asset_status>
   <tt:geo_location>15.4,40.2</tt:geo_location>
   <tt:asset_category>44</tt:asset_category>
  </ObjectEvent>
 </epcis:events>
</ttAMA:amaResponse> 

Asset update status

URI

/api/1/asset/admin/asset/{asset}/status

/api/1/asset/admin/asset/status

Description

You can from this endpoint change the status of an asset. Changing the status of an asset from 'IN_USE' to a another status will affect reports generated for the asset.

URI Parameters

name	description	type	default
asset	The legacy id or tag id of the asset to change.	path
latitude	The new latitude of the asset.	form
longitude	The new longitude of the asset.	form
includeMasterData	If true, the result will contain master data about the asset and its location.	form	false
includeEventData	If true, the result will contain the last event of the asset.	form	false
timestamp	The time when location changed. ISO-8601 with format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Note, you need to escape the '+' sign in the timezone, example: 2010-11-04T14:00:29%2B01:00. This parameter is optional, it will by default be set to current time.	form

HTTP Methods

PUT

Required Roles

API ASSET WORKER
MOBILE

Example of response XML:

<?xml version="1.0" encoding="utf-8"?>
<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
 <status>
  <statusCode>10000</statusCode>
  <statusMessage>Request ok, parameters legal with legal values.</statusMessage>
 </status>
 <params>
  <legacyId>441301</legacyId>
  <internalId>unknown</internalId>
  <internalType>EPC</internalType>
  <forceUpdate>false</forceUpdate>
 </params>
</ttAMA:amaResponse>

Asset into container

URI

/api/1/asset/admin/asset/into

Description

Put an asset into a container. The asset will be taken out of current container before added to the new container.

URI Parameters

name	description	type	default
asset	the identifier for asset to put into container, value can be the EPC, LEGACY or TAG id.	form
container	the identifier for container that the asset is put into, the value can be the EPC, LEGACY or TAG id.	form
includeMasterData	If true, the result will contain master data about the asset.	form	false
includeEventData	If true, the result will contain the last event of the asset.	form	false
timestamp	The time when asset was put into the container. ISO-8601 with format yyyy-MM-dd'T'HH:mm:ss.SSSZ. Note, you need to escape the '+' sign in the timezone, example: 2010-11-04T14:00:29%2B01:00 . This parameter is optional, it will by default be set to current time.	form

HTTP Methods

POST

Required Roles

API ASSET WORKER
MOBILE

Example of response XML:

<ttAma:amaResponse>
 <params>
  <asset>urn:gtnet:id:gsii:8888.96XXXX01.A3</asset>
  <container>C1</container>
  <includeEventData>true</includeEventData>
  <includeMasterData>false</includeMasterData>
  <timestamp>2013-01-16T13:08:20.037+01:00</timestamp>
 </params>
 <ns3:events>
  <ObjectEvent>
   <eventTime>2013-01-16T13:08:20.037+01:00</eventTime>
   <eventTimeZoneOffset>+01:00</eventTimeZoneOffset>
   <epcList><epc>urn:gtnet:id:gsii:8888.96XXXX01.A3</epc>
   </epcList>
   <action>OBSERVE</action>
   <bizStep>urn:epcglobal:cbv:bizstep:entering_exiting</bizStep>
   <disposition>urn:tracetracker:voc:disp:into</disposition>
   <bizLocation><id>urn:gtnet:id:gsli:8888.993241</id>
   </bizLocation>
   <tt:asset_location>urn:gtnet:id:gsli:8888.993241</tt:asset_location>
   <tt:module_asset_access>true</tt:module_asset_access>
   <tt:current_entity>urn:gtnet:id:gsii:8888.93XXXX01.C1</tt:current_entity>
   <tt:asset_status>30_in_use</tt:asset_status>
   <tt:into_entity>urn:gtnet:id:gsii:8888.93XXXX01.C1</tt:into_entity>
   <tt:geo_location>61.767911,4.8753549</tt:geo_location>
   <tt:asset_category>96</tt:asset_category>
   <tt:module_driver_access>true</tt:module_driver_access>
  </ObjectEvent>
  <AggregationEvent>
   <eventTime>2013-01-16T13:08:20.037+01:00</eventTime>
   <eventTimeZoneOffset>+01:00</eventTimeZoneOffset>
   <parentID>urn:gtnet:id:gsii:8888.93XXXX01.C1</parentID>
   <childEPCs><epc>urn:gtnet:id:gsii:8888.96XXXX01.A3</epc>
   </childEPCs>
   <action>ADD</action>
   <bizStep>urn:epcglobal:cbv:bizstep:entering_exiting</bizStep>
   <disposition>urn:tracetracker:voc:disp:into</disposition>
   <bizLocation><id>urn:gtnet:id:gsli:8888.993241</id>
   </bizLocation>
  </AggregationEvent>
 </ns3:events>
</ttAma:amaResponse>

Asset outof container

URI

/api/1/asset/admin/asset/outof

Description

Take an asset out of a container. An error message will be return if the asset is not currently in given container.

URI Parameters

name	description	type	default
asset	the identifier for asset to take out of an container, value can be the EPC, LEGACY or TAG id.	form
container	the identifier for container that the asset is taken out of, the value can be the EPC, LEGACY or TAG id.	form
includeMasterData	If true, the result will contain master data about the asset.	form	false
includeEventData	If true, the result will contain the last event of the asset.	form	false
timestamp	The time when asset was taken out of container. ISO-8601 with format yyyy-MM-dd'T'HH:mm:ss.SSSZ. Note, you need to escape the '+' sign in the timezone, example: 2010-11-04T14:00:29%2B01:00 . This parameter is optional, it will by default be set to current time.	form

HTTP Methods

POST

Required Roles

API ASSET WORKER
MOBILE

Example of response XML:

<ttAma:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
 <params>
  <asset>urn:gtnet:id:gsii:8888.96XXXX01.A3</asset>
  <container>C1</container>
  <includeEventData>true</includeEventData>
  <includeMasterData>false</includeMasterData>
  <timestamp>2013-01-16T13:08:20.037+01:00</timestamp>
 </params>
 <ns3:events>
  <ObjectEvent>
   <eventTime>2013-01-16T13:08:20.037+01:00</eventTime>
   <eventTimeZoneOffset>+01:00</eventTimeZoneOffset>
   <epcList><epc>urn:gtnet:id:gsii:8888.96XXXX01.A3</epc>
   </epcList>
   <action>OBSERVE</action>
   <bizStep>urn:epcglobal:cbv:bizstep:entering_exiting</bizStep>
   <disposition>urn:tracetracker:voc:disp:into</disposition>
   <bizLocation><id>urn:gtnet:id:gsli:8888.993241</id>
   </bizLocation>
   <tt:asset_location>urn:gtnet:id:gsli:8888.993241</tt:asset_location>
   <tt:module_asset_access>true</tt:module_asset_access>
   <tt:current_entity>urn:gtnet:id:gsii:8888.93XXXX01.C1</tt:current_entity>
   <tt:asset_status>30_in_use</tt:asset_status>
   <tt:into_entity>urn:gtnet:id:gsii:8888.93XXXX01.C1</tt:into_entity>
   <tt:geo_location>61.767911,4.8753549</tt:geo_location>
   <tt:asset_category>96</tt:asset_category>
   <tt:module_driver_access>true</tt:module_driver_access>
  </ObjectEvent>
  <AggregationEvent>
   <eventTime>2013-01-16T13:08:20.037+01:00</eventTime>
   <eventTimeZoneOffset>+01:00</eventTimeZoneOffset>
   <parentID>urn:gtnet:id:gsii:8888.93XXXX01.C1</parentID>
   <childEPCs><epc>urn:gtnet:id:gsii:8888.96XXXX01.A3</epc>
   </childEPCs>
   <action>ADD</action>
   <bizStep>urn:epcglobal:cbv:bizstep:entering_exiting</bizStep>
   <disposition>urn:tracetracker:voc:disp:into</disposition>
   <bizLocation><id>urn:gtnet:id:gsli:8888.993241</id>
   </bizLocation>
  </AggregationEvent>
 </ns3:events>
</ttAma:amaResponse>

Asset into location

URI

/api/1/asset/location/in

Description

You can from this endpoint move one or more asset into a new location.

The location update will cascade to any other asset that is registered to be inside the asset. Like any asset that is inside a container whose location is updated.
The Content-Type used should be application/x-www-form-urlencoded

URI Parameters

name	description	type
asset	One or more legacy IDs or TAG IDs.	form
location	Legacy location ID.	form
timestamp	The time of the registration. ISO-8601 with format yyyy-MM-dd'T'HH:mm:ss.SSSZ	form

HTTP Methods

POST

Required Roles

API ASSET WORKER
MOBILE

Asset outof location

URI

/api/1/asset/location/out

Description

You can from this endpoint move one or more asset out of a location.

The location update will cascade to any other asset that is registered to be inside the asset. Like any asset that is inside a container whoose location is updated.
The Content-Type used should be application/x-www-form-urlencoded

URI Parameters

name	description	type
asset	One or more legacy IDs or TAG IDs.	form
location	Legacy location ID.	form
timestamp	The time of the registration. ISO-8601 with format yyyy-MM-dd'T'HH:mm:ss.SSSZ	form

HTTP Methods

POST

Required Roles

API ASSET WORKER
MOBILE

Asset history

URI

/api/1/asset/history

Description

You can from this endpoint retrieve the history of an asset, all events recorded.

URI Parameters

name	description	type	default
`asset`	the legacy ID or TAG ID.	query
`geTime`	limit the result by event time	query
`leTime`	limit the result by event time	query
`page`	Page number to get, counting from 1. Optional. Default is 1.	query	1
`pageSize`	Size of a single page. Optional. Default is 20.	query	20

HTTP Methods

GET

Required Roles

API ASSET WORKER
MOBILE

Version

3.0.5

Example of response XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
    <entry>
        <containerId>urn:gtnet:id:gsii:9999.932204.93220011</containerId>
        <enter-location>urn:gtnet:id:gsli:9999.PERF121205160253</enter-location>
        <id>urn:gtnet:id:gsii:9999.446314.44630042</id>
        <location lat="63.40339" lng="63.40339" uknownBizLocation="false">
            <bizLocation>urn:gtnet:id:gsli:9999.2431</bizLocation>
        </location>
        <state>inside_container</state>
        <status icon=":30_in_use:" id="status.in.use"/>
        <time>2014-04-30T23:49:18+02:00</time>
        <type>ASSET</type>
    </entry>
</ttAMA:amaResponse>

Asset history count

URI

/api/1/asset/historyCount

Description

You can from this endpoint retrieve the number of events in the history of an asset, all events recorded between given time bounds.

URI Parameters

name	description	type
`asset`	the legacy ID or TAG ID.	query
`geTime`	limit the result by event time	query
`leTime`	limit the result by event time	query

HTTP Methods

GET

Required Roles

API ASSET WORKER
MOBILE

Version

3.0.21

Example of response XML:

<?xml version="1.0" encoding="UTF-8"?>
<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
   <eventCount>
      <epc>urn:gtnet:id:gsii:9999.130126XXXX01.sam_1</epc>
      <events>94</events>
      <geTime>2014-04-05T00:00:00.000000+0300</geTime>
      <leTime>2014-12-05T23:59:59.000000+0300</leTime>
   </eventCount>
</ttAMA:amaResponse>

Driver log Trip search

URI

/api/1/drivers/trips/history/search

Description

Search Driver trips between given dates and optionally with specified labels.

URI Parameters

name	description	type	default
`driver`	Driver id e.g email or username	query
`geTime`	From time (inclusive) e.g 2015-01-20T12:18:03.283	query
`leTime`	To time (inclusive) e.g 2015-01-20T13:18:03.283	query
page	Page of results to return		1
pageSize	Optional, history size to return		20
labels	Optional, trip labels.

HTTP Methods

GET

Required Roles

API ASSET WORKER
MOBILE

Version

3.0.26

Example output in XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
    <trips>
        <trip>
            <id>001</id>
            <driver>kowalski</driver>
            <vehicle>top_gear_subaru</vehicle>
            <distance>26</distance>
            <startTime>2015-01-20T10:18:03.283+01:00</startTime>
            <endTime>2015-01-20T11:18:03.283+01:00</endTime>
            <startLocation>0.1,37.2</startLocation>
            <endLocation>0.2,36.2</endLocation>
            <startLocationAlias>dummyStartAlias</startLocationAlias>
            <endLocationAlias>dummyEndAlias</endLocationAlias>
            <type>WORK</type>
        </trip>
        <trip>
            <id>002</id>
            <driver>kowalski</driver>
            <vehicle>Toyota</vehicle>
            <distance>26</distance>
            <startTime>2015-01-20T10:18:03.283+01:00</startTime>
            <endTime>2015-01-20T11:18:03.283+01:00</endTime>
            <startLocation>0.2,35.2</startLocation>
            <endLocation>0.2,36.2</endLocation>
            <startLocationAlias>dummyStartAlias</startLocationAlias>
            <endLocationAlias>dummyEndAlias</endLocationAlias>
            <type>WORK</type>
        </trip>
    </trips>
</ttAMA:amaResponse>

Driver log Trip count

URI

/api/1/drivers/trips/history/count

Description

Count the number of driver trips between given dates and optionally with specified labels.

URI Parameters

name	description	type
`driver`	Driver id e.g email or username	query
`geTime`	From time (inclusive) e.g 2015-01-20T12:18:03.283	query
`leTime`	To time (inclusive) e.g 2015-01-20T13:18:03.283	query
labels	Optional, trip labels.

HTTP Methods

GET

Required Roles

API ASSET WORKER
MOBILE

Version

3.0.26

Example output in XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
    <countQueryResult>
        <result>15</result>
    </countQueryResult>
</ttAMA:amaResponse>

Driver log Trip labels

URI

/api/1/drivers/trips/labels

Description

Add/Remove a list of labels to a list of trip ids.

URI Parameters

name	description	type	default
`label`	label to add. mutltiple &label=example&label=example_2 can be used.	query
`epc`	Id of trip. mutltiple &epc=urn:gtnet:id:gsti:9999.198199XXXX01.N-123.2015012601001889 &epc=urn:gtnet:id:gsti:9999.198199XXXX01.N-123.2015012601001810 can be used.	query

HTTP Methods

POST,DELETE

Required Roles

API ASSET DRIVER

Version

3.0.30

Example output in XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA"/>

Driver log Driver labels

List

URI

/api/1/drivers/labels/{driver}

Description

List labels associated with a driver.

URI Parameters

name	description	type	default
`label`	label to add. mutltiple &label=example&label=example_2 can be used.	query
`epc`	Id of trip. mutltiple &epc=urn:gtnet:id:gsti:9999.198199XXXX01.N-123.2015012601001889 &epc=urn:gtnet:id:gsti:9999.198199XXXX01.N-123.2015012601001810 can be used.	query

HTTP Methods

GET

Required Roles

API ASSET DRIVER

Version

3.0.30

Example output in XML

<?xml version="1.0" encoding="UTF-8"?>
<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
   <labels>
      <label>tag_1</label>
      <label>brazil</label>
      <label>mine</label>
      <label>Routine</label>
   </labels>
</ttAMA:amaResponse>

Add or Remove

URI

/api/1/drivers/labels/{driver}

Description

Add or remove driver's labels

URI Parameters

name	description	type	default
`driver`	target driver's ID	path
`label`	label to add.	form

HTTP Methods

POST,DELETE

Required Roles

API ASSET DRIVER

Version

3.0.30

Asset update

URI

/api/1/asset/admin/asset/update

Description

You can from this endpoint update both status and location of an asset. See the alternative endpoints for status and location if you only want to update only the location or the status. The response will contain the current state of the asset after the update is committed when setting includeEventData to true.

The location update will cascade to any other asset that is registered to be inside the asset. Like any asset that is inside a container whose location is updated.
Changing the status of an asset from 'IN_USE' to a another status will affect reports generated for the asset.
Use includeMasterData and includeEventData to control the data returned from the request.
For convenience a POST method that only uses form parameters.
The Content-Type used should be application/x-www-form-urlencoded

URI Parameters

name	description	type	default
asset	The legacy id or tag id of the asset to change.	form
status	The new status of the asset. Possible values are: 'IN_USE', 'IDLE', 'AVAILABLE', 'NEEDS_REPAIR', 'UNDER_REPAIR' or 'DESTROYED'.	form
latitude	The new latitude of the asset.	form
longitude	The new longitude of the asset.	form
includeMasterData	If true, the result will contain master data about the asset and its location.	form	false
includeEventData	If true, the result will contain the last event of the asset.	form	false
timestamp	The update time. ISO-8601 with format yyyy-MM-dd'T'HH:mm:ss.SSSZ. Note, you need to escape the '+' sign in the timezone, example: 2010-11-04T14:00:29%2B01:00. This parameter is optional, it will by default be set to current time.	form

HTTP Methods

POST

Required Roles

API ASSET WORKER
MOBILE

Example of response XML:

<?xml version="1.0" encoding="utf-8"?>
<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
 <status>
  <statusCode>10000</statusCode>
  <statusMessage>Request ok, parameters legal with legal values.</statusMessage>
 </status>
 <params>
  <legacyId>441301</legacyId>
  <internalId>unknown</internalId>
  <internalType>EPC</internalType>
  <forceUpdate>false</forceUpdate>
 </params>
</ttAMA:amaResponse>

Asset find

URI

/api/1/asset/find

Description

You can from this endpoint find details about asset matching the query parameters.

Use includeMasterData and includeEventData to limit the details level of the result

URI Parameters

name	description	type	default
query	text to search match for. A tag query will only match whole tag, and return zero or one result. Required if type parameter is missing.	query
queryType	ID, IDPAT, LEGACY or NAME. Optional. Default is ID. The query will match on tag and lagacyId if this parameter is LEGACY.	query	ID
category	id of category. Optional Example: category=urn:tracetracker:asset:idpat:category:9999.117113185.*	query
project	id of project. Optional. Example: project=urn:gtnet:id:gsli:9999.94932	query
status	status to filter on. Possible values are: 'IN_USE', 'IDLE', 'AVAILABLE', 'NEEDS_REPAIR', 'UNDER_REPAIR' or 'DESTROYED'. Optional.	query
type	type to filter on. Possible values are: `'ASSET', 'CONTAINER', 'VEHICLE' or 'BIG_ASSET'`. Required if `query` parameter is missing.	query
includeMasterData	whether to include event data. Optional. Default is true.	query	true
includeEventData	whether to include master data. Optional. Default is true.	query	true
page	Page number to get, counting from 1. Optional. Default is 1.	query	1
pageSize	Size of a single page. Optional. Default is 20.	query	20

HTTP Methods

GET

Required Roles

API ASSET
MOBILE

Asset service

URI

/api/1/asset/service

Description

You can from this endpoint retrieve service entries

URI Parameters

name	description	type	default
asset	limit the result by asset IDs or tags	query
geTime	limit the result by time when they was created, greater or equal	query
leTime	limit the result by time when they was created, less or equal.	query
page	Page number to get, counting from 1. Optional. Default is 1.	query	1
pageSize	Size of a single page. Optional. Default is 20.	query	20

HTTP Methods

GET

Required Roles

API ASSET
MOBILE

Version

3.0.5

Asset service note

URI

/api/1/asset/service/note

Description

You can from this endpoint add a service note to an asset

The Content-Type used should be application/x-www-form-urlencoded

URI Parameters

name	description	type	default
`asset`	the asset id or tag to add note to	form
`timestamp`	the time when the note is for. ISO-8601 with format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Note, you need to escape the '+' sign in the timezone, example: `2010-11-04T14:00:29%2B01:00`.	form
`note`	limit the result by time when they was created, less or equal.	form
`serviced`	True if this is a service note for an asset where service was performed.	form	`false`

HTTP Methods

POST

Required Roles

API ASSET
MOBILE

Version

3.0.5

Asset service schedule

URI

/api/1/asset/service/schedule

Description

Adds new reminder for a given asset, ignores if one of the same datetime exists.

The Content-Type used should be application/x-www-form-urlencoded

URI Parameters

name

description

type

default

asset

the asset id or tag for the schedule

form

timestamp

future schedule time, time must be in the future. ISO-8601 with format yyyy-MM-dd'T'HH:mm:ss.SSSZ.
Note, you need to escape the '+' sign in the timezone, example: 2010-11-04T14:00:29%2B01:00.

form

type

the service type to schedule

REPEAT_REMINDER – The schedule will repeat
ONE_TIME_SCHEDULE – The schedule will remain expired until user cancels or reschedules it

form

HTTP Methods

POST

Required Roles

API ASSET
MOBILE

Version

3.0.5

Example of response XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA" >
    <status>
        <statusCode>0</statusCode>
        <statusMessage>{
            id: "L10", 
            epc: "urn:gtnet:id:gsii:9999.12XXXX01.L10", 
            data: "2014-10-01T15:46:04.693Z",
            action: "schedule created"}</statusMessage>
    </status>
</ttAMA:amaResponse>

Asset service cancel

URI

/api/1/asset/service/schedule

Description

Cancel a reminder for a given Asset. The reminder must exist for it to be cancelled.

The Content-Type used should be application/x-www-form-urlencoded

URI Parameters

name

description

type

default

asset

the asset id or tag to remove schedule from

query

type

the service type to cancel

REPEAT_REMINDER – The schedule will repeat
ONE_TIME_SCHEDULE – The schedule will remain expired until user cancels or reschedules it

query

reminder

the data value of the scheduled reminder

query

HTTP Methods

DELETE

Required Roles

API ASSET
MOBILE

Version

3.0.5

Example of response XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA" >
    <status>
        <statusCode>0</statusCode>
        <statusMessage>{
            id: "L10", 
            epc: "urn:gtnet:id:gsii:9999.12XXXX01.L10", 
            data: "2014-10-01T15:46:04.693Z",
            action: "schedule canceled"}</statusMessage>
    </status>
</ttAMA:amaResponse>

Category add

URI

/api/1/asset/admin/category

Description

Create a new Category.

URI Parameters

name	description	type	default
name	the name of the new Category.	form
groupId	The id of the Category Group to assign the new Category to.	form

HTTP Methods

POST

Required Roles

API ASSET ADMIN
MOBILE

Category create group

URI

/api/1/asset/admin/category/group

Description

Create a new Category group.

URI Parameters

name	description	type	default
name	the name of the new Category group to create.	form

HTTP Methods

POST

Required Roles

API ASSET ADMIN
MOBILE

URI	/api/1/asset/admin/category/list
Description	Get the categories as master data.
URI Parameters
HTTP Methods	`GET`
Required Roles	`API ASSET ADMIN` `MOBILE`

urn:tracetracker:asset:idpat:department:9999.54056952c375b2d753edd89f5f3154407218a8ed.*

Department add

URI

/api/1/asset/admin/department

Description

Create a new Department.

URI Parameters

name	description	type	default
name	the name of the new Department.	form

HTTP Methods

POST

Required Roles

API ASSET ADMIN
MOBILE

Department delete

URI

/api/1/asset/admin/department

Description

Remove department

URI Parameters

name	description	type	default
id	the id of the Department to remove	query

HTTP Methods

DELETE

Required Roles

API ASSET ADMIN
MOBILE

Department list

URI	/api/1/asset/admin/department/list
Description	Get the departments as master data.
URI Parameters
HTTP Methods	`GET`
Required Roles	`API ASSET ADMIN` `MOBILE`

Mapping remove

URI

/api/1/asset/admin/mapping

Description

You can from this endpoint delete internalId from asset and device mappings.

internalIds are used to match an ID from an external resource (like a device) that is sending observations to Asset via Herder. The legacyId may be the application id or any associated tag found in the mapping.
Herder will be updated when removing an internalId from the mapping.
Herder will reject any observation referring to the deleted internalId.

URI Parameters

name	description	type
legacyId	Legacy id (application or tag id) for the mapping.	query
internalType	The internalId type to remove, EPC or IMEI.	query
internalId	The value of the InternalId to remove from the mapping.	query

HTTP Methods

DELETE

Required Roles

API ASSET WORKER
MOBILE

Example of response XML:

<ttAMA:amaResponse
 xmlns:epcismd="urn:epcglobal:epcis-masterdata:xsd:1"
 xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
 <epcismd:masterdata>
  <Vocabulary type="urn:tracetracker:8888:asset:mapping">
   <VocabularyElementList>
    <VocabularyElement id="82210106">
     <attribute id="epc">
      urn:gtnet:id:gsii:8888.822108.82210106</attribute>
     <attribute id="mds">
      urn:gtnet:idpat:gsii:8888.822108.*</attribute>
    </VocabularyElement>
   </VocabularyElementList>
  </Vocabulary>
 </epcismd:masterdata>
</ttAMA:amaResponse>

Mapping list

URI

/api/1/asset/admin/mapping/list

Description

You can from this endpoint get details about all mapped devices and assets.

Use legacyId parameter to get details about specific mappings. The legacyId may be the application id or any associated tag found in the mapping.

URI Parameters

name	description	type	default
page	Specifying the result page to return. Optional.	query	1
pageSize	Maximum number of mappings returned on one page. Optional. The default is 100.	query	100
legacyId	limit the result to only include the following set of mappings (application or tag id). Required.

HTTP Methods

GET

Required Roles

API ASSET WORKER
MOBILE

Example of response XML:

<ttAMA:amaResponse
 xmlns:epcismd="urn:epcglobal:epcis-masterdata:xsd:1"
 xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
 <epcismd:masterdata>
  <Vocabulary type="urn:tracetracker:8888:asset:mapping">
   <VocabularyElementList>
    <VocabularyElement id="82210106">
     <attribute id="epc">
      urn:gtnet:id:gsii:8888.822108.82210106</attribute>
     <attribute id="mds">
      urn:gtnet:idpat:gsii:8888.822108.*</attribute>
    </VocabularyElement>
   </VocabularyElementList>
  </Vocabulary>
 </epcismd:masterdata>
</ttAMA:amaResponse>

Product add

URI

/api/1/asset/admin/product

Description

Create or update a Product.

The Content-Type used should be application/x-www-form-urlencoded

Note, each instance can be configured to require additional product properties, use GET to get a list of all product properties for a given product type.

URI Parameters

name	description	type
productName	The name of the product.	form
category	the category ID to assign to the new product.	form
type	the product type.	form

HTTP Methods

POST

Required Roles

API ASSET ROLE_MANAGER
MOBILE

Product definition

URI

/api/1/asset/admin/product

Description

Get list of properties that should be included when creating a new product via POST.

editable : means that it can be updated.
required : means that it must be included when creating a new product.
type : the type validation that should be used when validating.

URI Parameters

name	description	type	default
type	the type to get properties for.	query	ASSET

HTTP Methods

GET

Required Roles

API ASSET ROLE_MANAGER
MOBILE

Example of response XML:

<ama:amaResponse xmlns:ns2="urn:epcglobal:epcis-masterdata:xsd:1"
 xmlns:ns3="urn:epcglobal:epcis:xsd:1"
 xmlns:ama="http://schema.tracetracker.com/ttAMA"
 xmlns:ns5="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
 xmlns:ns6="urn:epcglobal:epcis-query:xsd:1">
 <status><statusCode>10000</statusCode></status>
 <ns2:masterdata>
  <Vocabulary type="type-def">
   <VocabularyElementList>
    <VocabularyElement id="ASSET">
     <attribute editable="true" id="urn:tracetracker:asset:mda:daily_price"
      required="false" type="number" />
     <attribute editable="false" id="productName"
      required="true" type="text" />
     <attribute editable="false" id="category"
      required="true" type="text" />
     <attribute editable="false" id="type"
      required="true" type="text" />
     <attribute editable="true" id="urn:tracetracker:asset:mda:monthly_price"
      required="false" type="number" />
    </VocabularyElement>
   </VocabularyElementList>
  </Vocabulary>
 </ns2:masterdata>
</ama:amaResponse>

Product event properties

URI

/api/1/asset/admin/product-extensions

Description

Get list of properties that can be included as extensions when doing capture on an Asset in the Event Api.

URI Parameters

name	description	type	default
type	the type to get properties for.	query	ASSET

HTTP Methods

GET

Required Roles

API ASSET ROLE_MANAGER
MOBILE

Example of response XML:

<ns4:amaResponse xmlns:ns2="urn:epcglobal:epcis-masterdata:xsd:1" 
 xmlns:ns4="http://schema.tracetracker.com/ttAMA">
 <status>
  <statusCode>10000</statusCode>
 </status>
 <ns2:masterdata>
  <Vocabulary type="type-def">
   <VocabularyElementList>
    <VocabularyElement id="asset">
     <attribute id="product_serial"></attribute>
    </VocabularyElement>
   </VocabularyElementList>
  </Vocabulary>
 </ns2:masterdata>
</ns4:amaResponse>

Example of event that can be used to update the product_serial for an asset.

<ns4:EPCISDocument ns3="urn:epcglobal:epcis-query:xsd:1">
 <EPCISBody>
  <EventList>
   <ObjectEvent>
    <eventTime>2013-04-15T08:55:03.000+01:00</eventTime>
    <eventTimeZoneOffset>+02:00</eventTimeZoneOffset>
    <epcList><epc>....</epc></epcList>
    <action>OBSERVE</action>
    <product_serial xmlns="http://www.tracetracker.com/data">XS903</product_serial>
   </ObjectEvent>
  </EventList>
 </EPCISBody>
</ns4:EPCISDocument>

Product list

URI

/api/1/asset/md/list

Description

You can from this endpoint get all products types registered in Asset.

You can use attributeName parameter to limit the product details returned
This endpoint returns only product data stored in the EPCClass vocabulary in the MDS.
Will by default only return product name and id.
You can use the following attributes to get more details about a product
- urn:tracetracker:asset:mda:asset_name
  The product name
- urn:tracetracker:asset:mda:asset_catname
  The category name for the product
- urn:tracetracker:asset:mda:asset_cat
  The category id
- urn:tracetracker:asset:mda:objtype
  The product type, 0 is asset, 1 is container, 2 is vehicle and 3 is big asset.
The Content-Type used should be application/x-www-form-urlencoded for POST

URI Parameters

name	description	type	default
`attributeName`	A list of names of attributes to include in the result.	query	urn:tracetracker:asset:mda:asset_name
`page`	Specifies the page number to return. If not specified, the first page is returned.	query	1
pageSize	Specifies the number of product types to return in the result set.	query	20

HTTP Methods

GET | POST

Required Roles

API ASSET
MOBILE

Example of response XML:

<?xml version="1.0" encoding="UTF-8"?>
<ttAMA:amaResponse xmlns:ttAMA="http://schema.tracetracker.com/ttAMA">
 <MasterDataElement id="urn:gtnet:idpat:gsii:1.833501.*"
  urn__tracetracker__asset__mda__asset_name="Asfaltsag Stihl TS 400" />
 <MasterDataElement id="urn:gtnet:idpat:gsii:1.952401.*"
  urn__tracetracker__asset__mda__asset_name="Vasker Sealtech henger" />
 <MasterDataElement id="urn:gtnet:idpat:gsii:1.932201.*"
  urn__tracetracker__asset__mda__asset_name="Lomp/Spisebrakke" />
</ttAMA:amaResponse>

Event Capture

URI	/api/1/asset/event
Description	Import event data into system, use of asset specific extensions are only allowed in events that only contains EPCs registered in Asset. The endpoint supports only import of ObservationEventand AggregationEvent. Use the event import API in the EPCIS server if you want to importTransactionEvent or QuantityEvent. The post can be of type "multipart/form-data", with "Content-Disposition: format-data; name=filename; filname=myfile.xml". You can override the filename by adding a request header named "X-TraceTracker-Client-References". The Events imported via this resource may use TAG/LEGACY in epcList for the ObjectEvents, any TAG/LEGACY found will be resolved to EPC before imported. Read the AMA Event import for more information of how events should be modeled when updating Asset specific properties like status or location.
URI Parameters
HTTP Methods	`POST`
Required Roles	`API ASSET` `MOBILE`

Example of response XML:

<?xml version="1.0" encoding="utf-8"?>
<importResults>
 <importResult>
  <eventCount>2</eventCount>
  <fileName>ama-event-1340712250425-ON.XML</fileName>
  <userId>administrator</userId>
  <status>200</status>
 </importResult>
</importResults>

Location find

URI

/api/1/asset/location

Description

You can from this endpoint find details about the location (project), whose boundary is intercepted by given latitude and longitude.

If the coordinates resolves to a location, information about that location will be returned. Otherwise the result will contain a dummy location titled 'Unknown'.

URI Parameters

name	description	type	default
latitude	Latitude in decimal degrees. (-90 to 90)	query
longitude	Longitude in decimal degrees. (-180 to 180)	query

HTTP Methods

GET | POST

Required Roles

API ASSET
MOBILE

Location list

URI

/api/1/asset/location/list

Description

You can from this endpoint get a list of all master data for all locations.

Use attributeName parameter to limit the amount of master data in the response.

URI Parameters

name	description	type	default
attributeName	A list of attribute names to include for each location. All attributes will be returned if this parameter is not specified.	query
`page`	Specifies the page number to return. If not specified, the first page is returned.	query	1
`pageSize`	Specifies the number of location to return in the result set.	query	100

HTTP Methods

GET | POST

Required Roles

API ASSET
MOBILE

Masterdata

URI

/api/1/asset/md

Description

You can from this endpoint find master data for asset or location.

Use TAG_ID if you want to get master data for an asset.
Use LEGACY_LOCATION if you want to get master data for a location
The Content-Type used should be application/x-www-form-urlencoded for POST

URI Parameters

name	description	type	default
`id`	The id to get master data for.	query
`type`	The id type. Valid types are TAG_ID and LEGACY_LOCATION.	query	TAG_ID
`page`	Specifies the page number to return. If not specified, the first page is returned.	query	1
`pagesize`	Specifies the number of location to return in the result set	query	20

HTTP Methods

GET | POST

Required Roles

API ASSET
MOBILE

Driver associate vehicle

URI

/api/1/fleet/admin/drivers/associate

Description

You can from this endpoint associate a Driver with a Vehicle.

Any observation on given vehicle will after association be registered as a part of trip for the driver.
A vehicle may only be associated with one Driver, use the dissociate endpoint first if you need to associate a vehicle with a new driver

URI Parameters

name	description	type	default
driver	The id of the Driver to associate with Vehicle.	form
vehicle	The id of the Vehicle to associate with Driver.	form

HTTP Methods

POST

Required Roles

API ASSET ADMIN

Driver dissociate vehicle

URI

/api/1/fleet/admin/drivers/dissociate

Description

You can from this endpoint dissociate a Driver from a Vehicle.

Any observation on given vehicle will after dissociation not be registered as part of trips for the given driver.

URI Parameters

name	description	type	default
driver	The id of the Driver to associate with Vehicle.	form
vehicle	The id of the Vehicle to associate with Driver.	form

HTTP Methods

POST

Required Roles

API ASSET ADMIN

Drivers List

URI

/api/1/fleet/admin/drivers/list

Description

You can from this endpoint view details of a given driver or all drivers if none is specified.

These are users with ROLE_DRIVER and belong to the Organization of the Node.

URI Parameters

name	description	type	default
driver	The id of the Driver to. This is optional	query

HTTP Methods

POST

Required Roles

API ASSET ADMIN DRIVER

Documents Management

List and Navigate Documents

URI

api/1/asset/documents/{legacyId}/list

Description

You can from this endpoint list documents associated with a given Asset.

The legacy ID is the simple ID used to refer to an asset

URI Parameters

name

description

type

default

legacyId

Reference to the specific asset. It is required.

path

pageToken

Optional, is used to navigate to the next page of results. This is a marker that is returned from previous page

of results in case more files are listed.

NB: Note that AmazonS3 storage does not provide total item count so a page token/marker is used to navigate through

more results.

query

pageSize

An integer specifying the number of results to return

query

50

HTTP methods

GET

Required Roles

API ASSET MOBILE

Sample

api/1/asset/documents/KAB-450X/list?nodeId=0800001908000022&pageToken=1/assets/urn:gtnet:id:gsii:1.313XXXX01.KAB-450X/multitail.conf

Sample output

<?xml version="1.0" encoding="UTF-8"?>
<resultsList>
   <assetFiles>
      <fileName>Abraham-l.txt</fileName>
      <key>1/assets/urn:gtnet:id:gsii:1.313XXXX01.KAB-450X/Abraham-l.txt</key>
      <lastModified>2015-08-09T22:38:41+03:00</lastModified>
      <properties />
      <size>0</size>
   </assetFiles>
   <assetFiles>
      <fileName>Kenny.xml</fileName>
      <key>1/assets/urn:gtnet:id:gsii:1.313XXXX01.KAB-450X/Kenny.xml</key>
      <lastModified>2015-08-09T20:49:44+03:00</lastModified>
      <properties />
      <size>5837</size>
   </assetFiles>
   <assetFiles>
      <fileName>kennyx.emerald</fileName>
      <key>1/assets/urn:gtnet:id:gsii:1.313XXXX01.KAB-450X/kennyx.emerald</key>
      <lastModified>2015-08-09T22:38:39+03:00</lastModified>
      <properties />
      <size>47962</size>
   </assetFiles>
   <assetFiles>
      <fileName>Credit Notes.jpg</fileName>
      <key>1/assets/urn:gtnet:id:gsii:1.313XXXX01.KAB-450X/Credit Notes.jpg</key>
      <lastModified>2015-08-17T00:05:14+03:00</lastModified>
      <properties />
      <size>24423</size>
   </assetFiles>
   <assetFiles>
      <fileName>1/assets/urn:gtnet:id:gsii:1.313XXXX01.KAB-450X/multitail.conf</fileName>
      <key>1/assets/urn:gtnet:id:gsii:1.313XXXX01.KAB-450X/multitail.conf</key>
      <lastModified>2015-08-09T22:38:37+03:00</lastModified>
      <properties />
      <size>43310</size>
   </assetFiles>
   <assetFiles>
      <fileName>1/assets/urn:gtnet:id:gsii:1.313XXXX01.KAB-450X/nice quotes.txt</fileName>
      <key>1/assets/urn:gtnet:id:gsii:1.313XXXX01.KAB-450X/nice quotes.txt</key>
      <lastModified>2015-08-09T22:38:35+03:00</lastModified>
      <properties />
      <size>167</size>
   </assetFiles>
   <assetFiles>
      <fileName>1/assets/urn:gtnet:id:gsii:1.313XXXX01.KAB-450X/pom.xml</fileName>
      <key>1/assets/urn:gtnet:id:gsii:1.313XXXX01.KAB-450X/pom.xml</key>
      <lastModified>2015-08-14T00:49:47+03:00</lastModified>
      <properties />
      <size>37727</size>
   </assetFiles>
</resultsList>

Upload Documents

URI

api/1/asset/documents/{legacyId}/add

Description

You can from this endpoint upload documents and associate them with a given Asset.

The legacy ID is the simple ID used to refer to an asset

This method accepts the uploads as multipart/form-data. Multiple files may be uploaded at an instance.

URI Parameters

name	description	type	default
legacyId	Reference to the specific asset. It is required.	path

HTTP methods

POST

Required Roles

API ASSET MOBILE

Sample

curl -v -u user:password -XPOST -F 'data=@/home/kenny/Pictures/snaps/front.jpg' "http://localhost:8380/asset/api/1/asset/documents/KAB-450X/add?nodeId=0800001908000022"

A result of HTTP OK 200 is returned for successful uploads

About

About user

Admin Asset

Asset Destination Add

Asset Destination List

Asset Destination Remove

Admin Device

Asset update comment

Asset remove comment

Asset update location

Asset update status

Asset into container

Asset outof container

Asset into location

Asset outof location

Asset history

Asset history count

Driver log Trip search

Driver log Trip count

Driver log Trip labels

Driver log Driver labels

List

Add or Remove

Asset update

Asset find

Asset service

Asset service note

Asset service schedule

Asset service cancel

Category add

Category create group

Category list

urn:tracetracker:asset:idpat:department:9999.54056952c375b2d753edd89f5f3154407218a8ed.*

Department add

Department delete

Department list

Mapping remove

Mapping list

Product add

Product definition

Product event properties

Product list

Event Capture

Location find

Location list

Masterdata

Driver associate vehicle

Driver dissociate vehicle

Drivers List

Documents Management

List and Navigate Documents

Upload Documents