Skip to main content

Get a List of User-defined Tags

GET 

/pub/v4.0/tag/list

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

Request

Query Parameters

    customerid stringrequired

    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 stringrequired

    Possible values: [predefined, tenant]

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

Responses

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

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

  • ]
Loading...