IoT Platform:Device jobs

Background information

• To implement custom tasks, you must develop task management capabilities on the device side. For detailed operations, refer to Device Jobs.

• For device batch service invocation tasks and device batch property setting tasks, if the device-side Link SDK has integrated service invocation and property setting functions, there is no need to develop additional task management capabilities to execute device jobs.

  For methods on integrating service invocation and property setting functions into the device-side Link SDK, see the Thing Specification Language development methods for the respective Link SDK in Device Access Overview.

  For an explanation of the Alink protocol used for service invocation and property setting, see Device Properties, Events, and Services.

Device job status update notification

Downstream.

Topic: /sys/${productKey}/${deviceName}/thing/job/notify.

Sample request in Alink JSON format:

{
    "id": "7542940",
    "version": "1.0",
    "params": {
        "task": {
            "taskId": "i5Ks6***pF010101",
            "status": "SENT",
            "jobDocument": {},
            "jobFile":{
                "signMethod":"Md5",
                "sign":"wssxff56dhdsd***",
                "fileUrl": "https://iotx-***.oss-cn-shanghai.aliyuncs.com/***.zip"
            }
        }
    }
}

Sample response in Alink JSON format:

{
    "id": "7542940",
    "code": 200,
    "data": {}
}

Get device job details

Upstream.

• Request topic: /sys/${productKey}/${deviceName}/thing/job/get.

• Response topic: /sys/${productKey}/${deviceName}/thing/job/get_reply.

Sample request in Alink JSON format:

{
    "id": "123",
    "version": "1.0",
    "params": {
        "taskId": "i5Ks***F010101"
    }
}

taskId values differ, and the Alink response data format differs.

• taskId is the ID of the subtask:

  {
      "id": "1234",
      "code": 200,
      "data": {
          "statusDetails":{"devs":"test","status":"init"},
          "taskId": "i5Ks***F010101",
          "task":{
              "taskId": "i5Ks***F010101",
              "status": "IN_PROGRESS",
              "jobDocument": {},
              "jobFile":{
                  "signMethod":"Md5",
                  "sign":"wssxff56dhdsd***",
                  "fileUrl": "https://iotx-***.oss-cn-shanghai.aliyuncs.com/***.zip"
              }
          }
      }
  }

• taskId is $next:

  {
      "id": "1234",
      "code": 200,
      "data": {
          "statusDetails":{"devs":"test","status":"init"},
          "taskId": "$next",
          "task":{
              "taskId": "i5Ks***F010101",
              "status": "IN_PROGRESS",
              "jobDocument": {},
              "jobFile":{
                  "signMethod":"Md5",
                  "sign":"wssxff56dhdsd***",
                  "fileUrl": "https://iotx-***.oss-cn-shanghai.aliyuncs.com/***.zip"
              }
          }
      }
  }

• taskId is $list:

  {
      "id": "1234",
      "code": 200,
      "data": {
          "statusDetails":{"devs":"test","status":"init"},
          "taskId": "$list",
          "task":[
              {
                  "taskId": "i5Ks***",
                  "status": "IN_PROGRESS"
              },
              {
                  "taskId": "i61s***",
                  "status": "IN_PROGRESS"
              }
          ]
      }
  }

Update subtask status

Upstream.

• Request topic: /sys/${productKey}/${deviceName}/thing/job/update.

• Response topic: /sys/${productKey}/${deviceName}/thing/job/update_reply.

Sample request in Alink JSON format:

{
    "id": "123",
    "version": "1.0",
    "params": {
        "taskId": "i5Ks***F010101",
        "status": "IN_PROGRESS",
        "statusDetails": {
            "key": "value"
        },
        "progress": 50
    }
}

Sample response in Alink JSON format:

{
    "id":"123",
    "code":200,
    "data":{
        "taskId":"i5Ks***F010101"
    }
}