Skip to main content

Route Object Model

The route object model differs when used in API requests and responses.

POST API Requests

Use the following route model when issuing the Create a Route and Update a Route API requests.

NameTypeDescription
namestringName of route.
idstring

Optional when creating source, required when updating. Route ID.

sourceobjectRoute source object. See Source Object Model for definition.
destinationsobject listRoute destinations list. See Destinations Object Model for definition.

GET API Responses

The following route model is returned after issuing the Get Device Configuration and Get Route Configuration API commands.

NameTypeDescription
namestringName of route.
idstring

Route ID.

sourceobjectRoute source object. See Source Object Model for definition.
destinationsobject listRoute destinations list. See Destinations Object Model for definition.
elapsedTimestringElapsed running time of route.
statestringRoute state: idle or running.
pendingUpdatesobjectRoute update object that lists the values that are pending an update. Only appears while a route update or a stop/start action is occurring.
summaryStatusCodestringRoute status summary code: warn, error, ok, or unknown.
summaryStatusDetailsstringRoute status details.
hasPendingDeletebooleanIf the route has a pending delete task.

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.