Get a List of User-defined Tags

Get a list of user-defined tags assigned to IoT devices.

Query Parameters

• customerid string required

  The customer ID to which the API call is directed

• type string

  Possible values: [custom, system]

  The type identifies the tag as either a system-defined tag or a custom tag.

• source string required

  Possible values: [predefined, tenant]

  The source of the user-defined tags assigned to IoT devices. The following string must be tenant.

Responses

• 200
• 4XX
• 5XX

---

Successful Response (We only show some important fields here.)

application/json

• Schema
• Example (from schema)
• deviceDetailResponseExample

---

Schema

• totalTags integer

  The number of tags matching the request

• tags object[]

  An array of user-defined tags assigned to a device. Each item in the array consists of three attributes: tagType, tagValue, and tagId.

  Array [

  tagType string

  The key for a user-defined tag

  tagValue string

  The value of the tag key for a user-defined tag

  tagId string

  The ID of a user-defined tag

  ]

{
  "totalTags": 0,
  "tags": [
    {
      "tagType": "string",
      "tagValue": "string",
      "tagId": "string"
    }
  ]
}

{
  "totalTags": 2,
  "tags": [
    {
      "_id": {
        "tagId": "60f221a219e22f10003a965e"
      },
      "tagType": "zzzNoTagTypeABC",
      "tagValue": "special_blocked",
      "tagId": "60f221a219e22f10003a965e",
      "type": "custom"
    },
    {
      "_id": {
        "tagId": "60dad9446e89f01000b8950f"
      },
      "tagType": "Risk3",
      "tagValue": "RiskHighFirst",
      "tagId": "60dad9446e89f01000b8950f",
      "type": "custom"
    }
  ]
}

Client Error Response

application/json

• Schema
• Example (from schema)
• Bad Request
• Forbidden access
• Too many requests

---

Schema

• code string

  STATUS_CODE

• msg string

  GENERAL_MESSAGE

{
  "code": "string",
  "msg": "string"
}

{
  "code": 400,
  "msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}

{
  "code": 403,
  "msg": "Forbidden access. Either the provided API key is invalid or it does not have the required RBAC permissions to run this API."
}

{
  "code": 429,
  "msg": "Too many requests. The number of requests for device details for a single device exceeded the rate limit of 180 queries per minute per tenant."
}

Server Error Response

application/json

• Schema
• Example (from schema)
• deviceDetailResponseExample

---

Schema

• code string

  STATUS_CODE

• msg string

  GENERAL_MESSAGE

{
  "code": "string",
  "msg": "string"
}

{
  "code": 500,
  "msg": "Internal server error. A unified status for API communication type errors."
}

Loading...