Get list of tags and count of its associated entities

Select

SaaS

Customer Managed

Returns list of tags for the logged in user's default entity tag set along with count of associated entities

Query Parameters

• tagId int32

  Id of the tag whose associated entities details needs to be returned

Responses

• 200
• 404
• 503

---

OK

application/json

• Schema
• Example (from schema)
• Example-1

---

Schema

• tagSetInfo object

  id int32

  GUID string

  name string
• tags object[]

  id int32

  name string

  count int32

  globalConfigInfo object

  Only applicable on Global CommCells

  id string

  name string

  commcells object[]

  List of Service CommCells where the global configuration is applied

  id int32

  name string

  guid string

  displayName string

  companies object[]

  List of companies where the global configuration is applied

  id int32

  name string

  guid string

  scope string

  The entity level at which the config is applied.

  scopeFilterQuery string

  CommCellEntityCache filter query string used for filtering the scope

  applyOnAllCommCells boolean

  Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  applyOnAllCompanies boolean

  Decides whether the global configuration should be applied to all the companies, including the newly created ones

  isMarkedForDeletion boolean

  Indicates whether global configuration deletion has been started.

  status string

  associatedEntities object[]

  id int32

  name string

  type string

  commcell object

  Details of the CommCell to which the entity belongs in a multi-CommCell environment.

  id int32

  name string

  aliasName string

  GUID string

{
  "tagSetInfo": {
    "id": 0,
    "GUID": "string",
    "name": "string"
  },
  "tags": [
    {
      "id": 0,
      "name": "string",
      "count": 0,
      "globalConfigInfo": {
        "id": "string",
        "name": "string",
        "commcells": [
          {
            "id": 0,
            "name": "string",
            "guid": "string",
            "displayName": "string"
          }
        ],
        "companies": [
          {
            "id": 0,
            "name": "string",
            "guid": "string"
          }
        ],
        "scope": "string",
        "scopeFilterQuery": "string",
        "applyOnAllCommCells": true,
        "applyOnAllCompanies": true,
        "isMarkedForDeletion": true,
        "status": "string"
      },
      "associatedEntities": [
        {
          "id": 0,
          "name": "string",
          "type": "string"
        }
      ],
      "commcell": {
        "id": 0,
        "name": "string",
        "aliasName": "string",
        "GUID": "string"
      }
    }
  ]
}

{
  "tagSetInfo": {
    "id": 738,
    "GUID": "59DBD39D-26DE-435E-8EEA-F8E1A2E0A5CA",
    "name": "Default Tag set"
  },
  "tags": [
    {
      "id": 742,
      "name": "BRAND",
      "count": 1,
      "associatedEntities": [
        {
          "id": 20,
          "name": "CVLT",
          "type": "61"
        }
      ]
    }
  ]
}

Not Found

application/json

• Schema
• Example (from schema)
• Example-1

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Page not found",
  "errorCode": 404
}

Service Unavailable

application/json

• Schema
• Example (from schema)
• Example-1

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Service unavailable",
  "errorCode": 503
}

GET /v4/tags/associatedentities    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

tagId — query

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Tags/AssociatedEntities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Tags/AssociatedEntities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Tags/AssociatedEntities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Tags/AssociatedEntities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Tags/AssociatedEntities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Tags/AssociatedEntities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Tags/AssociatedEntities' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'