Jump to

• Request
• Response

Create a new route Set

post

/rest/{versionId}/routeSets

Use this (POST) method to create a new route set on SDM server.User has to provide the route set information in the method body.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• versionId: string
  The rest api version, it's value is v1.3.

Body ()

The route set info which needs to be added.

Root Schema : routeSet

Type: object

Show Source

• addMode(optional): string
• addTaskId(optional): string
• addTaskStatus(optional): string
• copyFromRouteSetId(optional): string
• description(optional): string
• deviceGroupId(optional): string
• deviceLrtConfigName(optional): string
• deviceLrtFilename(optional): string
• deviceRequiresUpdating(optional): string
• lastModifiedTime(optional): string
• lockOwner(optional): string
• lockState(optional): string
• name(optional): string
• notes(optional): string
• pubIdType(optional): string
• routeCount(optional): string
• routeSetId(optional): string
• version(optional): string

{
    "properties":{
        "addMode":{
            "type":"string"
        },
        "addTaskId":{
            "type":"string"
        },
        "addTaskStatus":{
            "type":"string"
        },
        "copyFromRouteSetId":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "deviceGroupId":{
            "type":"string"
        },
        "deviceLrtConfigName":{
            "type":"string"
        },
        "deviceLrtFilename":{
            "type":"string"
        },
        "deviceRequiresUpdating":{
            "type":"string"
        },
        "lastModifiedTime":{
            "type":"string"
        },
        "lockOwner":{
            "type":"string"
        },
        "lockState":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "notes":{
            "type":"string"
        },
        "pubIdType":{
            "type":"string"
        },
        "routeCount":{
            "type":"string"
        },
        "routeSetId":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"routeSet"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : routeSet

Type: object

Show Source

• addMode(optional): string
• addTaskId(optional): string
• addTaskStatus(optional): string
• copyFromRouteSetId(optional): string
• description(optional): string
• deviceGroupId(optional): string
• deviceLrtConfigName(optional): string
• deviceLrtFilename(optional): string
• deviceRequiresUpdating(optional): string
• lastModifiedTime(optional): string
• lockOwner(optional): string
• lockState(optional): string
• name(optional): string
• notes(optional): string
• pubIdType(optional): string
• routeCount(optional): string
• routeSetId(optional): string
• version(optional): string

{
    "properties":{
        "addMode":{
            "type":"string"
        },
        "addTaskId":{
            "type":"string"
        },
        "addTaskStatus":{
            "type":"string"
        },
        "copyFromRouteSetId":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "deviceGroupId":{
            "type":"string"
        },
        "deviceLrtConfigName":{
            "type":"string"
        },
        "deviceLrtFilename":{
            "type":"string"
        },
        "deviceRequiresUpdating":{
            "type":"string"
        },
        "lastModifiedTime":{
            "type":"string"
        },
        "lockOwner":{
            "type":"string"
        },
        "lockState":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "notes":{
            "type":"string"
        },
        "pubIdType":{
            "type":"string"
        },
        "routeCount":{
            "type":"string"
        },
        "routeSetId":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"routeSet"
    }
}

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