Tags

The following resources are applicable:

/tags

Mount Point: /v2/tags

POST

Creates a new Tag based on the information provided in TagCreator parameter.

Request Body

element: tagCreator
media types: application/xml
application/json

Provides the information for the new Tag to be created.

Response Body

element: tag
media types: application/xml
application/json

The newly created Tag object.

GET

Returns the list of all the tag associated to the account of the currently connected user.

Response Body

element: tagsResult
media types: application/xml
application/json

The list of requested Tag objects.

/tags/{tagId}

Mount Point: /v2/tags/{tagId}

The following operations are supported on this resource:

PUT

Updates the Tag specified by the "id" path parameter based on the information provided in the Tag parameter.

Parameters

name description type default
tagId The id of the Tag to be updated. path

Request Body

element: tag
media types: application/xml
application/json

The modified Tag whose attributes need to be updated.

Response Body

element: tag
media types: application/xml
application/json

The updated tag.

GET

Returns the Tag specified by the "id" path parameter.

Parameters

name description type default
tagId The id of the Tag requested. path

Response Body

element: tag
media types: application/xml
application/json

The requested Tag object.

DELETE

Deletes the Tag specified by the "id" path parameter.

Parameters

name description type default
tagId The id of the Tag to be deleted. path

/tags/apply

Mount Point: /v2/tags/apply

POST

Creates a new TagApplication on the information provided in TagApplicationCreator parameter.

Request Body

element: tagApplicationCreator
media types: application/xml
application/json

Provides the information for the new TagApplication to be created.

Response Body

element: tagApplication
media types: application/xml
application/json

The newly created TagApplication object.

/tags/findByName

Mount Point: /v2/tags/findByName

GET

Returns the Tag specified by the "name" query parameter.

Parameters

name description type default
name The name of the Tag requested. query

Response Body

element: tag
media types: application/xml
application/json

The requested Tag object.

/tags/findTagApplicationByTaggable

Mount Point: /v2/tags/findTagApplicationByTaggable

GET

Gets the list of all the tag application associated to the given taggable entity.

Parameters

name description type default
entityType The type of the entity for which search. query
entityId The id of the entity for which search. query

Response Body

element: tagApplicationsResult
media types: application/xml
application/json

The list of associated TagApplication objects.

/tags/getTagSummary

Mount Point: /v2/tags/getTagSummary

GET

Return a summary of total device assigned per Tag

Response Body

element: tagDeviceSummary
media types: application/xml
application/json

A TagDeviceSummary object representing the summary

/tags/remove

Mount Point: /v2/tags/remove

DELETE

Deletes the TagApplication specified by the tagId, entityType and entityId path parameters.

Parameters

name description type default
tagId The tagId of the TagApplication to be deleted. query
entityType The entityType of the TagApplication to be deleted. query
entityId The entityId of the TagApplication to be deleted. query