Jump to

• Request
• Response

GET all route updates on devices.

get

/rest/{versionId}/routeSets/routeUpdates

Use this (GET) method to get all the pending route set update tasks on SDM server.

Request

Path Parameters

• 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 : routeUpdateTasks

Type: object

Show Source

• routeUpdateTaskList(optional): array routeUpdateTask

{
    "properties":{
        "routeUpdateTaskList":{
            "items":{
                "$ref":"#/definitions/RestRouteUpdateTask",
                "xml":{
                    "name":"routeUpdateTask"
                }
            },
            "type":"array",
            "xml":{
                "name":"routeUpdateTask"
            }
        }
    },
    "type":"object",
    "xml":{
        "name":"routeUpdateTasks"
    }
}

Nested Schema : routeUpdateTask

Type: array

Show Source

• Array of: object routeUpdateTask

{
    "items":{
        "$ref":"#/definitions/RestRouteUpdateTask",
        "xml":{
            "name":"routeUpdateTask"
        }
    },
    "type":"array",
    "xml":{
        "name":"routeUpdateTask"
    }
}

Nested Schema : routeUpdateTask

Type: object

Show Source

• devices(optional): string
• failureAction(optional): string
• initiatedBy(optional): string
• initiatedDate(optional): string
• name(optional): string
• notes(optional): string
• objectId(optional): string
• rollbackStatus(optional): string
• routeSets(optional): string

{
    "properties":{
        "devices":{
            "type":"string"
        },
        "failureAction":{
            "type":"string"
        },
        "initiatedBy":{
            "type":"string"
        },
        "initiatedDate":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "notes":{
            "type":"string"
        },
        "objectId":{
            "type":"string"
        },
        "rollbackStatus":{
            "type":"string"
        },
        "routeSets":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"routeUpdateTask"
    }
}

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