REST API - GET Entity Tags

Updated

This operation retrieves a list of entity tags that are defined for any entity, in a CommCell environment.

Request

Syntax

Send the request using either XML or JSON.

GET <webservice>/tags/{{entityType}}/{{entityId}}&tagId={{tagId}}&tagName={{tagName}}&tagValue={{tagValue}}

Host: <host name>

Accept: application/xml

Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

entityType

The type of the entity.

Valid values are:

  • 3, CLIENT_ENTITY

  • 5, INSTANCE_ENTITY

  • 7, SUBCLIENT_ENTITY

  • 28, CLIENT_GROUP_ENTITY

  • 64, PROVIDER_ENTITY

  • 158, PLAN_ENTITY

Yes

entityId

The ID for the entity of a particular entity type.

If the entity ID is not known, use this API to retrieve a list of entity IDs for an entity type.

No

tagId

The ID for a tag.

If the tag ID is not known, use this API to retrieve a list of tag IDs for an entity type or entity ID.

No

tagName

The name of a tag.

If the tag name is not known, use this API to retrieve the tag name for a particular tag ID.

No

tagValue

The value of a tag.

If the tag value is not known, use this API to retrieve the tag value for a particular tag ID.

No

Request Headers

Name

Description

Host

The host name of the Web Server or the Web Console that is used in the API request.

Accept

The format of the response.

Valid values are: application/xml or application/json.

Authtoken

The authentication token that is received after a successful log on.

For more information about receiving an authentication token, see Authentication.

Response

Response Parameters

Name

Description

Elements

entityType

The type of the entity.

Valid values are:

  • 3, CLIENT_ENTITY

  • 5, INSTANCE_ENTITY

  • 7, SUBCLIENT_ENTITY

  • 28, CLIENT_GROUP_ENTITY

  • 64, PROVIDER_ENTITY

  • 158, PLAN_ENTITY

tags

entityId

The ID for the entity of a particular entity type.

tags

name

The entity tag name.

tag

id

The entity tag ID.

tag

value

The entity tag value.

value

Examples

Sample Request

GET <webservice>/tags/3/8&tagId=452

Accept: application/json

Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{

"error": {},

"tags": [

{

"entityType": 3,

"entityId": 8,

"tag": [

{

"name": "Brand",

"id": 452,

"value": "XYZ"

}

]

}

]

}