Jump to

• Request
• Response

POST to Lock/Unlock/OverrideLock a RouteSet

post

/rest/{versionId}/routeSets/{routeSetId}/action

Use this (POST) method to Lock / Unlock/ OverrideLock a RouteSet on SDM server. User needs to provide the action to be taken ona route set as part of method body and needs to provide Route Set ID on which action needs to be executed as part of URI

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• routeSetId: string
  The route set on which action needs ot be performed.
• versionId: string
  The rest api version, it's value is v1.3.

Body ()

The action type information, which can be one of Lock/Unlock/OverrrideLock.

Root Schema : routeSetAction

Type: object

Show Source

• addMode(optional): string
• type(optional): string

{
    "properties":{
        "addMode":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"routeSetAction"
    }
}

Back to Top

Response

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