Jump to

• Request
• Response

Get status of update task by task id

get

/rest/{versionId}/routeSets/routeUpdates/{taskId}

Use this API to get the details about the route update task on device.User needs to provide update task id to get the update task details.

Request

Path Parameters

• taskId: string
  The is of the update task.
• versionId: string
  The rest api version, it's value is v1.3.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : routeUpdateTaskDetails

Type: object

Show Source

• deviceStatusList(optional): array updateDeviceStatusList
• errorHandling(optional): string
• rollbackCount(optional): string
• rollbackStatus(optional): string
• totalDeviceCount(optional): string
• updatedCount(optional): string
• updateStatus(optional): string

{
    "properties":{
        "deviceStatusList":{
            "items":{
                "$ref":"#/definitions/RestUpdateDeviceStatus",
                "xml":{
                    "name":"updateDeviceStatus"
                }
            },
            "type":"array",
            "xml":{
                "name":"updateDeviceStatusList",
                "wrapped":true
            }
        },
        "errorHandling":{
            "type":"string"
        },
        "rollbackCount":{
            "type":"string"
        },
        "rollbackStatus":{
            "type":"string"
        },
        "totalDeviceCount":{
            "type":"string"
        },
        "updateStatus":{
            "type":"string"
        },
        "updatedCount":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"routeUpdateTaskDetails"
    }
}

Nested Schema : updateDeviceStatusList

Type: array

Show Source

• Array of: object updateDeviceStatus

{
    "items":{
        "$ref":"#/definitions/RestUpdateDeviceStatus",
        "xml":{
            "name":"updateDeviceStatus"
        }
    },
    "type":"array",
    "xml":{
        "name":"updateDeviceStatusList",
        "wrapped":true
    }
}

Nested Schema : updateDeviceStatus

Type: object

Show Source

• deviceGroupId(optional): string
• objectId(optional): string
• preUpdateVersion(optional): string
• pushStatus(optional): string
• rollBackDate(optional): string
• rollBackFailureMsg(optional): string
• rollBackStatus(optional): string
• routeSetId(optional): string
• routeUpdateTaskId(optional): string
• status(optional): string
• updateDate(optional): string
• updateFailureMsg(optional): string
• updateVersion(optional): string

{
    "properties":{
        "deviceGroupId":{
            "type":"string"
        },
        "objectId":{
            "type":"string"
        },
        "preUpdateVersion":{
            "type":"string"
        },
        "pushStatus":{
            "type":"string"
        },
        "rollBackDate":{
            "type":"string"
        },
        "rollBackFailureMsg":{
            "type":"string"
        },
        "rollBackStatus":{
            "type":"string"
        },
        "routeSetId":{
            "type":"string"
        },
        "routeUpdateTaskId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "updateDate":{
            "type":"string"
        },
        "updateFailureMsg":{
            "type":"string"
        },
        "updateVersion":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"updateDeviceStatus"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

403 Response

There is no permission to access the resources.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

500 Response

Internal server error

Back to Top