Summary
Get a list of inventory devices
Description
This method will get a list of inventory devices.
Route
POST /automationgateway/getInventoryDevices
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| integrationType |
enum |
yes |
Allowed values are: [ netmiko, netconf, http_requests, grpc ] - Integration type of the device |
| offset |
number |
no |
The number of items to skip before starting to collect the result set: 123 |
| limit |
number |
no |
The number of items to return: 123 |
| filter |
string |
no |
Response filter function with JSON name/value pair argument, i.e., contains({"name":"ios"})
Valid filter functions - contains, equals, startswith: string |
| order |
string |
no |
Ascending/Descending sort indication: Must be one of [ascending, descending] |
Copied to Clipboard
{
"integrationType": "http_requests",
"offset": 0,
"limit": 3,
"filter": "contains({\"name\":\"ios\"})\nValid filter functions - contains, equals, startswith: string",
"order": "ascending"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"integrationType": {
"title": "integrationType",
"type": "string",
"examples": [
"netmiko",
"netconf",
"http_requests"
]
},
"offset": {
"title": "offset",
"type": "number",
"examples": [
0
]
},
"limit": {
"title": "limit",
"type": "number",
"examples": [
3
]
},
"filter": {
"title": "filter",
"type": "string",
"examples": [
"contains({\"name\":\"ios\"})\nValid filter functions - contains, equals, startswith: string"
]
},
"order": {
"title": "order",
"type": "string",
"examples": [
"ascending"
]
}
},
"required": [
"integrationType"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
A JSON Object containing status, code and the result |
Copied to Clipboard
{
"data": [
{
"name": "http_device_name",
"variables": {
"base_url": "/api/v2.0",
"protocol": "http"
}
},
{
"name": "http_device_name",
"variables": {
"base_url": "/api/v2.0",
"protocol": "http"
}
},
{
"name": "http_device_name",
"variables": {
"base_url": "/api/v2.0",
"protocol": "http"
}
},
{
"name": "http_device_name",
"variables": {
"base_url": "/api/v2.0",
"protocol": "http"
}
},
{
"name": "http_device_name",
"variables": {
"base_url": "/api/v2.0",
"protocol": "http"
}
}
],
"key": "result",
"status": "200"
}
Copied to Clipboard
{
"properties": {
"key": {
"title": "key",
"type": "string",
"examples": [
"result"
]
},
"data": {
"title": "data",
"type": "array",
"items": {
"$ref": "deviceData#/definitions/httpDevice"
}
},
"status": {
"title": "status",
"type": "string",
"examples": [
"200"
]
}
},
"required": [
"meta",
"data"
],
"type": "object"
}
