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.
| Name | Type | Description |
|---|---|---|
| name | string | Name of route. |
| id | string | Optional when creating source, required when updating. Route ID. |
| source | object | Route source object. See Source Object Model for definition. |
| destinations | object list | Route 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.
| Name | Type | Description |
|---|---|---|
| name | string | Name of route. |
| id | string | Route ID. |
| source | object | Route source object. See Source Object Model for definition. |
| destinations | object list | Route destinations list. See Destinations Object Model for definition. |
| elapsedTime | string | Elapsed running time of route. |
| state | string | Route state: idle or running. |
| pendingUpdates | object | Route update object that lists the values that are pending an update. Only appears while a route update or a stop/start action is occurring. |
| summaryStatusCode | string | Route status summary code: warn, error, ok, or unknown. |
| summaryStatusDetails | string | Route status details. |
| hasPendingDelete | boolean | If the route has a pending delete task. |