Delete Device

Delete a device.

Operation Permissions

Required Authorization

Required Operation Permission

Device Management

Full Access

Request Format

POST https://{apigw-address}/connect-service/v2.1/devices?action=delete

Request Parameters (URI)

Note

Use one of the following methods to specify the device to be deleted:

  • Include assetId in the request

  • Include productKey + deviceKey in the request

Name

Location (Path/Query)

Mandatory/Optional

Data Type

Description

orgId

Query

Mandatory

String

The organization ID which the asset belongs to. How to get orgId>>

assetId

Query

Optional (See Note above)

String

The asset ID. How to get assetId>>

productKey

Query

Optional (See Note above)

String

The product key. To be used with deviceKey.

deviceKey

Query

Optional (See Note above)

String

The device key. To be used with productKey.

Samples

Request Sample

url: https://{apigw-address}/connect-service/v2.1/devices?action=delete&orgId=yourOrgId&assetId=mAEsF3sm
method: POST

Return Sample

responseBody:{
"code":0,
"msg":"OK",
"requestId":"12d7e3be-6bac-43de-8733-7e02a4eb8a88",
"data":null
}

Java SDK Sample

package com.envisioniot.enos.api.sample.connect_service.device;

import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envisioniot.enos.connect_service.v2_1.device.DeleteDeviceRequest;
import com.envisioniot.enos.connect_service.v2_1.device.DeleteDeviceResponse;

public class DeleteDevice {
    public static void main(String[] args) {
        final String appKey = "yourAppKey";
        final String appSecret = "yourAppSecret";
        String serverUrl = "yourServerUrl";

        String orgId = "yourOrgId";
        String assetId = "yourAssetId";
        DeleteDeviceRequest request = new DeleteDeviceRequest();
        request.setOrgId(orgId);
        request.setAssetId(assetId);
        DeleteDeviceResponse response = Poseidon.config(PConfig.init().appKey(appKey).appSecret(appSecret).debug())
                .url(serverUrl)
                .getResponse(request,DeleteDeviceResponse.class);

    }
}