Jump to

• Request
• Response

Get All Existing Route Sets

get

/rest/{versionId}/routeSets

Use this (GET) method to display all route sets that exist on the SDM server. You can use query parameters with this task to retrieve specific route sets. On the navigation pane, go to Get Started > Send Requests on the navigation pane. On the Send Requests page, scroll to the Pagination Parameters section for more information.

Request

Path Parameters

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

Query Parameters

• ascending(optional): string
  Sort order shall be ascending or not. Can have values (true/false)
• deviceLrtFilename(optional): string
  The name of the Lrt file on the device.
• limitation(optional): string
  The size of the page.
• name(optional): string
  The name of the route set.
• offset(optional): string
  The page number to be fetched.
• sort(optional): string
  Sort by specified property. Supported: name, deviceLrtFileName, deviceLrtConfigName, routeSetId, pubIdType

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : routeSets

Type: object

Show Source

• pageInfo(optional): object PageInfo
• routeSets(optional): array routeSet

{
    "properties":{
        "pageInfo":{
            "$ref":"#/definitions/PageInfo"
        },
        "routeSets":{
            "items":{
                "$ref":"#/definitions/RestRouteSet",
                "xml":{
                    "name":"routeSet"
                }
            },
            "type":"array",
            "xml":{
                "name":"routeSet"
            }
        }
    },
    "type":"object",
    "xml":{
        "name":"routeSets"
    }
}

Nested Schema : PageInfo

Type: object

Show Source

• limitation(optional): integer(int32)
• numberOfElements(optional): integer(int64)
• offset(optional): integer(int32)

{
    "properties":{
        "limitation":{
            "format":"int32",
            "type":"integer"
        },
        "numberOfElements":{
            "format":"int64",
            "type":"integer"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : routeSet

Type: array

Show Source

• Array of: object routeSet

{
    "items":{
        "$ref":"#/definitions/RestRouteSet",
        "xml":{
            "name":"routeSet"
        }
    },
    "type":"array",
    "xml":{
        "name":"routeSet"
    }
}

Nested 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