Summary
Search device groups
Description
Returns device groups that match the specified input
Route
POST /configuration_manager/deviceGroups/query
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| name |
string |
yes |
Search string |
| start |
number |
yes |
Offset of page start |
| limit |
number |
yes |
Maximum number of items in the page |
| options |
object |
no |
- |
Copied to Clipboard
{
"name": "fugiat",
"start": 70709850.99205565,
"limit": 35636468.02433142,
"options": {
"regex": false
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string"
},
"start": {
"title": "start",
"type": "number"
},
"limit": {
"title": "limit",
"type": "number"
},
"options": {
"title": "options",
"type": "object",
"properties": {
"regex": {
"type": "boolean",
"description": "Enables global regex/substring search."
}
}
}
},
"required": [
"name",
"start",
"limit"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| deviceGroups |
object |
List of device groups that match the search criteria |
Copied to Clipboard
{
"totalCount": -38155758.80325266,
"groups": [
{
"_id": "5c35355dbebaa82eaf8113f0",
"name": "my standard name",
"description": "my standard description",
"devices": [
"xr9kv-atl"
]
},
{
"_id": "5c35355dbebaa82eaf8113f0",
"name": "my standard name",
"description": "my standard description",
"devices": [
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl"
]
}
]
}
Copied to Clipboard
{
"title": "deviceGroups",
"type": "object",
"properties": {
"totalCount": {
"type": "number"
},
"groups": {
"type": "array",
"items": {
"$ref": "deviceGroupDocument"
}
}
}
}
