Adding Manual Tag to Devices

Adding manual tag to the devices.

Query Parameters

customerid string required

The customer ID to which the API call is directed

application/json

Request Body required

tag object required

The tag object that will be added to the devices

deviceidlist array required

The device list that will have the new tag. The limit of the device list is 50.

Responses

Successful Response

application/json

Schema

Example (from schema)

addingTagResponseExample

Schema

api string

The current API URI

updateSuccess string

To indicate whether the adding operation is success or not

{
  "api": "string",
  "updateSuccess": "string"
}

{
  "api": "pub/v4.0/tag",
  "updateSuccess": "yes"
}

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)

addingTagResponseExample

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."
}

Adding Manual Tag to Devices​

Adding Manual Tag to Devices