tagVUE™ API (v2)

Introduction

tagVUE™ platform exposes its data, events and operations via an API (Application Programming Interface), so developers can enable devices and other applications to interact with the tagVUE applications. This document is the official reference for that functionality.

Primary method to access tagVUE from other sensors, devices and client applications is using the REST API. This API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. Wherever possible, standard HTTP features are supported, however since majority of API use is expected in machine-tomachine (M2M) communication and embedded applications, care is taken to reduce client side resource utilization. On all server applications, REST API access is only permitted under secured (HTTPS) protocol. Standard implementation of this API on client applications also uses the secured sockets. Please refer to individual endpoint documentation on restrictions and exceptions.

Authentication

Application and devices need to authenticate themselves to the service to allow access to perform any API operation. Every web service call is stateless and does not carry authentication information in a session. This means, regardless of the factors (or a combination of factors) chosen for authenticating to the server, client application must include the credentials in every call.

API Key based authentication - Authorization: [apikey]:[secret]
User password based authentication - HTTP Basic authentication (RFC 2617)

Authentication information is included as HTTP headers. All REST API calls are expected to use SSL authentication. A failed authentication will return the HTTP status code 401 [more information]

ApplicationV2

Controller which handles all Items services operation

API	Description
GET api/v2/application/hello	Get application info

ItemV2

Controller which handles CRUD operations on item object

API	Description
GET api/v2/items/id/{id}	Get item details by unique identificator
GET api/v2/items/name/{name}	Get item details by item name
GET api/v2/items	Get all items by specified filters. Filters are not case-sensitive. If more than one filter provided, they will be combined with AND operator.
POST api/v2/items	Create (and enroll) new item. Manufacturer can be provided by Name or EntityID. If manufacturer name is provided and manufacturer does not exist, it will be created. Model can be provided by Name, Code or EntityID. If name is provided and model does not exist, it will be created. If more than one model with same Name or Code found, manufacturer must be provided for API to select proper model.
PUT api/v2/items/{id}	Update existing item properties
DELETE api/v2/items/{id}	Decomission existing items
PUT api/v2/items/{itemEntityId}/attributes	Update item properties and attributes. item should exist and be active. Attributes should be defined in application. If item does not have some attribute, it will be created if possible. Any item may have global attribute. If you want to update item category attribute, then item should belong to this category.Authentication used for this call should have "Asset Administration/Modify" privilege
PUT api/v2/items/{itemEntityId}/custodian	Sets custodian to item. Requires "Asset Administration -> Transfer Owner" privilege. Custodian can be provided by username (entity-id) or email or employee ID. Item should be active. Custodian account should not be locked.
DELETE api/v2/items/{itemEntityId}/custodian	Remove custodian from item. Requires "Asset Administration -> Transfer Owner" privilege. Item should be active.

ItemClassV2

Controller which handles all items classes operation

API	Description
GET api/v2/classes?Skip={Skip}&Take={Take}&Since={Since}&Name={Name}	Get all item classes
GET api/v2/classes/{id}	Get specific class by unique identificator
POST api/v2/classes	Create new item class
PUT api/v2/classes/{id}	Update existing item class properties

ItemAttributeMetaV2

Controller which handles all class attributes metadata

API	Description
GET api/v2/classes/{classId}/attributes/meta?Skip={Skip}&Take={Take}&Since={Since}&Name={Name}	Get all classes for specific class (if you want to get global attributes then use 'global' for class-id
GET api/v2/attributes/meta/{attributeId}	Get specific attribute by unique identifier
POST api/v2/attributes/meta	Create new attribute metadata
PUT api/v2/attributes/meta/{id}	Update existing attribute metadata

ItemAttributeValueV2

Controller which handles all items attributes operation

API	Description
GET api/v2/items/{itemId}/attributes/values	Get attribute list for specified item
GET api/v2/attributes/value/{attributeId}	Get specific item attribute object
POST api/v2/items/{itemId}/attributes/value	Create new attribute under the specified item
PUT api/v2/attributes/value/{attributeId}	No documentation available.

ManufacturerV2

Controller which handles all manufacturers operation

API	Description
GET api/v2/manufacturers/{id}	Get manufacturer by unique identificator
GET api/v2/manufacturers?Skip={Skip}&Take={Take}&Since={Since}&Name={Name}	Get all manufacturers
POST api/v2/manufacturers	Create new manufacturer
PUT api/v2/manufacturers/{id}	Update existing manufacturer

ModelV2

Controller which handles all models operation

API	Description
GET api/v2/models/{id}	Get model by unique identificator
GET api/v2/models?Skip={Skip}&Take={Take}&Since={Since}&Name={Name}	Get all models
POST api/v2/models	Create new model
PUT api/v2/models/{id}	Update existing model

LocationV2

Controller which handles all location operations

API	Description
GET api/v2/locations/{id}	Get location by unique identificator
GET api/v2/locations?Skip={Skip}&Take={Take}&Since={Since}&Name={Name}	Get locations based on filters
POST api/v2/locations	Create new location
PUT api/v2/locations/{id}	Update existing location
GET api/v2/locations/classes	Get all location classes

ProjectV2

Controller which handles all project operations

API	Description
GET api/v2/projects?Skip={Skip}&Take={Take}&Since={Since}&Name={Name}	Get all projects
GET api/v2/projects/{id}	Get project by unique identificator
POST api/v2/projects	Create new project
PUT api/v2/projects/{id}	Update existing project. User must have a "Manage projects" privilege to perform this action.

TagV2

Controller which handles all tag operation

API	Description
GET api/v2/tags/{id}	Get tag by unique identificator (EPC)
POST api/v2/tags/search?intent={intent}&field[0]={field[0]}&field[1]={field[1]}	Get tags entity details by list of epcs
GET api/v2/tags?TagType={TagType}&IgnoreLocationChanges={IgnoreLocationChanges}&Skip={Skip}&Take={Take}&Since={Since}&Name={Name}	Get all tags by specified filters
PUT api/v2/tags	Report a list of tag observations. Use this API to group a list of tag observations by events or simply to reduce network traffic. Only "checkout" or "inventory" intent is supported.
PUT api/v2/tags/{epc}/remove	Removes tag from object.

Operation

Execute operations ovet items.

API	Description
PUT api/v2/operations	Execute common operations. Operation type identified by the property of the operationData. Some operations may have dedicated API endpoint, check documentation.

PhotoV2

Controller which handles all photos operation

API	Description
GET api/v2/photos?Type={Type}&Distinct={Distinct}&Skip={Skip}&Take={Take}&Since={Since}&Name={Name}	Get all photos in a zip package
POST api/v2/photos	Upload new photos for existing items (photos are send as 1 zip package)

ActivityV2

Controller which handles all tagVUE entity activities and observations

API	Description
GET api/v2/activities/types	Get all available entity activity types in the tagVUE system (enrolled, updated, added etc...)
GET api/v2/activities/item/id/{id}?Type={Type}&Skip={Skip}&Take={Take}&Since={Since}&Name={Name}	Get item activities by providing item id
GET api/v2/activities/item/name/{name}?Type={Type}&Skip={Skip}&Take={Take}&Since={Since}	Get item activities by providing item name
GET api/v2/observations/types	Get all available entity observation types in the tagVUE system (seen, moved, inventoried etc...)
GET api/v2/observations/item/id/{id}?Type={Type}&Skip={Skip}&Take={Take}&Since={Since}&Name={Name}	Get item observations by providing item id
GET api/v2/observations/item/name/{name}?Type={Type}&Skip={Skip}&Take={Take}&Since={Since}	Get item observations by providing item name