Start OTA Job


Start 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=start

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.

24615

Job has started

The job has already started.

Samples

Request Sample

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

Return Sample

{
    "code":0,
    "msg":"OK",
    "requestId":"3bdf31b4-e357-4d4c-8cf9-a40dc129a407",
    "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.StartJobRequest;
import com.envisioniot.enos.connect_service.v2_1.ota.job.StartJobResponse;

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

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

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

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