Summary
Search all Device Groups
Description
Gets a list of all device groups that match the search criteria
Route
POST /configuration_manager/deviceGroups/search
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| s |
string |
yes |
Search string |
| start |
number |
yes |
Offset of page start |
| limit |
number |
yes |
Maximum number of items in the page |
Copied to Clipboard
{
"s": "dolore Excepteur labore",
"start": -44618193.46793012,
"limit": -20648795.71895379
}
Copied to Clipboard
{
"type": "object",
"properties": {
"s": {
"title": "s",
"type": "string"
},
"start": {
"title": "start",
"type": "number"
},
"limit": {
"title": "limit",
"type": "number"
}
},
"required": [
"s",
"start",
"limit"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| deviceGroups |
object |
List of device groups that match the search criteria |
Copied to Clipboard
{
"totalCount": 76934303.11365649,
"groups": [
{
"_id": "5c35355dbebaa82eaf8113f0",
"name": "my standard name",
"description": "my standard description",
"devices": [
"xr9kv-atl",
"xr9kv-atl"
]
},
{
"_id": "5c35355dbebaa82eaf8113f0",
"name": "my standard name",
"description": "my standard description",
"devices": [
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl"
]
}
]
}
Copied to Clipboard
{
"title": "deviceGroups",
"type": "object",
"properties": {
"totalCount": {
"type": "number"
},
"groups": {
"type": "array",
"items": {
"$ref": "deviceGroupDocument"
}
}
}
}
