/api/objects
The following resources are applicable:
/objects/{type}
GET
This method returns the objects selected by the supplied query and other parameters. {type} should be one of: interfaces, nodes, demands, interface queues, lsps or custom type.
Parameters
| name | description | type | default |
|---|---|---|---|
| size | The number of objects to return. | query | 10 |
| offset | Used with size to indicate where to start the result set. | query | 0 |
| sortDir | The order in which the result set records are sorted, options=increasing, decreasing. | query | |
| sortProp | Specifies the property on which to sort. | query | |
| type | Object type, e.g.: interfaces, nodes, etc. | path | |
| query |
The filter to choose objects, or the form:
{ |
query | |
| filter | An alternate query form to choose objects, of the form: {<property>(<op><<value>>[;...]*)} e.g. "node(==palto);capacity(=40000);name(~829)" | query | |
| filterKeys | Settings which restrict the size of the result-set and are of the form (<property>(<op><value>)[;...]*) e.x (name~"pal.*") | query | |
| from | Internal only. | query | |
| to | Internal only. | query | |
| last | Internal only. | query | |
| hideInactive | True if stale objects should be ignored. | query | false |
| format | (no documentation provided) | query | table |
| delim | If outputting to a file, this will be the object delimiter | query | |
| storedir | Not used. | query | |
| exclude | (no documentation provided) | query | false |
| uiRegex | (no documentation provided) | query | true |
Response Body
| element: | objects |
| media types: | text/plain application/json |
Returns a list of objects selected by the query and other filter parameters
Status Codes
| HTTP Status Code | Description |
|---|---|
| 200 OK | OK; the resource was updated successfully |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |
/objects/{type}/count
GET
This method returns the count of the objects selected by the supplied query and other parameters.
Parameters
| name | description | type | default |
|---|---|---|---|
| type | Object type, e.g.: interfaces, nodes, etc. | path | |
| query |
The filter to choose objects, or the form:
{ |
query | |
| filter |
An alternate query form to choose objects, of the form:
{ |
query | |
| from | Internal only. | query | |
| to | Internal only. | query | |
| last | Internal only. | query | |
| hideInactive | True if stale objects should be ignored | query | false |
| exclude | (no documentation provided) | query | false |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain |
Returns number of the objects selected by the query and other filter parameters
Status Codes
| HTTP Status Code | Description |
|---|---|
| 200 OK | OK; the resource was updated successfully |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |