Adding Manual Tag to Devices

POST 
/pub/v4.0/tag

Adding manual tag to the devices.

Request

Query Parameters

customerid stringrequired

The customer ID to which the API call is directed

application/json

Body

required

tag objectrequired

The tag object that will be added to the devices

deviceidlist arrayrequired

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

Responses

200

Successful Response

application/json

Schema

Schema

api string

The current API URI

updateSuccess string

To indicate whether the adding operation is success or not

Example (from schema)

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

addingTagResponseExample

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

4XX

Client Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

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

Bad Request

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

Forbidden access

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

Too many requests

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

5XX

Server Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

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

addingTagResponseExample

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

Loading...