Delete OTA Job


Delete an OTA job.

Operation Permissions

Required Authorization

Required Operation Permission

Device Management

Full Access

Request Format

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

Request Parameters (URI)

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>>

jobId

Query

Mandatory

String

The job ID.

Error Codes

Code

Message

Description

24404

Job not found

The job cannot be found.

24618

Not allowed to delete running job

The job cannot be deleted as it is still running.

Samples

Request Sample

url: https://{apigw-address}/connect-service/v2.1/ota-jobs?action=delete&orgId=yourOrgId&jobId=yourJobId
method: POST

Return Sample

{
    "code":0,
    "msg":"OK",
    "requestId":"dcf62008-7904-4560-9db6-6a9e3519c765",
    "data":null
}

Java SDK Sample

package com.envisioniot.enos.connect_service.ota.job;

import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envisioniot.enos.connect_service.v2_1.ota.job.DeleteJobRequest;
import com.envisioniot.enos.connect_service.v2_1.ota.job.DeleteJobResponse;

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

        String orgId = "yourOrgId";
        String jobId = "yourJobId";

        DeleteJobRequest request = new DeleteJobRequest();
        request.setOrgId(orgId);
        request.setJobId(jobId);

        DeleteJobResponse response = Poseidon
                .config(PConfig.init().appKey(appKey).appSecret(appSecret).debug())
                .url(serverUrl)
                .getResponse(request, DeleteJobResponse.class);
    }
}