Jump to

• Request
• Response

Commit/Rollback/Cancel a route set update.

post

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

Use this method(POST) to perform some actions on the route set update tasksUser needs to provide task id as part of uri and type of action to be performed (Commit/Rollback/Cancel) as part of method body.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• taskId: string
  The task id on which Commit/Cancel/Rollback actions to be performed.
• versionId: string
  The rest api version, it's value is v1.3.

Body ()

The action type is specified here. It can be one of Commit/Cancel/Rollback.

Root Schema : routeUpdateAction

Type: object

Show Source

• type(optional): string

{
    "properties":{
        "type":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"routeUpdateAction"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root 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