V2.5 Delete DPS Device


Delete DPS devices.


This API is only available if 2.4 Cumulative Update 2 has been applied to your environment.

Request Format

POST https://{apigw-address}/dps-service/v2.5/pvs/device?action=delete

Request Parameters (URI)

Name Location (Path/Query) Required/Optional Data Type Description
orgId Query Required String The organization ID which the device belongs to. How to get orgId>>

Request Parameters (Body)

Name Required/Optional Data Type Description
groupId Required String The registration group ID.
snList Required String Array The list of device SNs that are generated by system and unique in this environment. It should belong to the registration group specified by the groupId parameter.

Response Parameters

Name Data Type Description
data String Array The list of SNs of devices that were successfully deleted and do not exist.

Samples

Request Sample

url: https://{apigw-address}/dps-service/v2.5/pvs/device?action=delete&orgId=yourOrgId
method: POST
requestBody:
{
    "snList": ["sn1", "sn2", "sn3"],
    "groupId": "groupId"
}

Return Sample

{
  "code": 0,
  "msg": "OK",
  "requestId": "72dab943-4935-4b09-b3d0-245f653e4f22",
  "data": [
    "sn1",
    "sn2",
    "sn3"
  ]
}