Summary
Fetches all the devices that exist on a tree.
Description
Search through a GC Tree to find all the devices that exist on it.
Route
POST /configuration_manager/devices/tree
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| treeId |
string |
yes |
- |
| version |
string |
yes |
- |
| options |
object |
yes |
- |
Copied to Clipboard
{
"treeId": "5c35355dbebaa82eaf8113f0",
"version": "v2",
"options": {
"nodes": []
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"treeId": {
"title": "treeId",
"$ref": "common#/definitions/mongoObjectId"
},
"version": {
"title": "version",
"$ref": "goldenConfigData#/definitions/goldenConfigTreeVersionName"
},
"options": {
"title": "options",
"type": "object",
"info": "Accepts a 'nodes' array to filter devices by the specified nodes.",
"properties": {
"nodes": {
"type": "array"
}
},
"required": []
}
},
"required": [
"treeId",
"version",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
Response containing the list of devices. |
Copied to Clipboard
{
"devices": []
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"devices": {
"type": "array"
}
}
}
