Skip to main content

Create a Route

Use this command to create an individual route.

Authorizations: Administrator, Operator

Requests

POST /api/devices/[Device ID]/updates
cookie: sessionID: [Session ID]

{ 
 "action": "create",
"deviceID": "[Device ID]", "elementType": "route", "fields":
{
"name": "[Route name]",
"startRoute": [true,false],
"source":
{
<Source object>
},
"destinations": [
<Destination object list>
]
}
}

Parameters

NameTypeDescription
action
  • create
Create the specified element type.
deviceIDstringDevice ID retreived via the Get Device Info command.
elementType
  • route
Create a route element.
namestringName of route.
startRouteBooleanIf route is started after it is created
sourceobjectSource object. See Source Object Model for definition.
destinationsobject listOptional. List of route destinations. See Destinations Object Model for definition.

Response

{
  "status": "[success message]"
}

 

JavaScript errors detected

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

If this problem persists, please contact our support.