Use this command to get details of all routes. Retrieve the Device ID via the (3.8.1) Get Device Info command.
Tip
Routes are paged and have a numPages attribute in the response. If the numPages value is greater than 1, use the page and/or pageSize parameters to access the rest of the data. For example, GET /api/.../routes?page=2&pageSize=10 fetches routes 11-20 from the collection.
Active for Version: 3.2+
Authorizations: Administrator, Operator, Observer
Requests
|
|
Parameters
N/A
Response
|
|
|
Name |
Type |
Description |
|---|---|---|
|
data |
object |
Data object, including route objects (see (3.8.1) Route Object Model for definition). |
|
numPages |
number |
Number of pages of routes. See the above tip on using the numPages attribute. |
|
numResults |
number |
Number of available routes. |
|
numActiveOutputConnections |
number |
Number of currently active outputs. |
|
pendingRouteCreates |
number |
Number of routes that are pending creation, and that are not yet listed. |