Update a Route

Use this command to update an individual route.

Note

You must include all route details (source and destinations configurations) with your update. That is, if destinations are excluded, they will be deleted from the route.

Authorizations: Administrator, Operator

Requests

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

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

Parameters

Name	Type	Description
action	update	Update the specified element type.
deviceID	string	Device ID retrieved via the Get Device Info command.
elementType	route	Update the route element.
elementID	string	Route ID retrieved via the Get Device Configuration command
name	string	Name of route.
source	object	Source object model. See Source Object Model for definition.
destinations	string	Optional, if no destinatsions are desired in the route. Destinations object model. See Destinations Object Model for definition.

Response

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