Add child/parent flags to all inventory get commands (#190)

* add child type flags to all inventory related commands * add child flags to all inventory commands
reubenmiller · Oct 20, 2022 · 8d41db7 · 8d41db7
1 parent 2313c74
commit 8d41db7
Show file tree

Hide file tree

Showing 101 changed files with 2,085 additions and 76 deletions.
diff --git a/api/spec/json/agents.json b/api/spec/json/agents.json
@@ -161,6 +161,26 @@
             }
           ]
         },
+        {
+          "name": "skipChildrenNames",
+          "type": "boolean",
+          "description": "Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved"
+        },
+        {
+          "name": "withChildren",
+          "type": "boolean",
+          "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
+        },
+        {
+          "name": "withGroups",
+          "type": "boolean",
+          "description": "When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups."
+        },
         {
           "name": "withParents",
           "type": "boolean",
@@ -217,6 +237,33 @@
           "required": true,
           "description": "Agent ID"
         }
+      ],
+      "queryParameters": [
+        {
+          "name": "skipChildrenNames",
+          "type": "boolean",
+          "description": "Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved"
+        },
+        {
+          "name": "withChildren",
+          "type": "boolean",
+          "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
+        },
+        {
+          "name": "withGroups",
+          "type": "boolean",
+          "description": "When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups."
+        },
+        {
+          "name": "withParents",
+          "type": "boolean",
+          "description": "Include a flat list of all parents and grandparents of the given object"
+        }
       ]
     },
     {

diff --git a/api/spec/json/configuration.json b/api/spec/json/configuration.json
@@ -97,6 +97,31 @@
               "format": "(description eq '%s')"
             }
           ]
+        },
+        {
+          "name": "skipChildrenNames",
+          "type": "boolean",
+          "description": "Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved"
+        },
+        {
+          "name": "withChildren",
+          "type": "boolean",
+          "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
+        },
+        {
+          "name": "withGroups",
+          "type": "boolean",
+          "description": "When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups."
+        },
+        {
+          "name": "withParents",
+          "type": "boolean",
+          "description": "Include a flat list of all parents and grandparents of the given object"
         }
       ]
     },
@@ -247,6 +272,33 @@
           "required": true,
           "description": "Configuration package (managedObject) id"
         }
+      ],
+      "queryParameters": [
+        {
+          "name": "skipChildrenNames",
+          "type": "boolean",
+          "description": "Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved"
+        },
+        {
+          "name": "withChildren",
+          "type": "boolean",
+          "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
+        },
+        {
+          "name": "withGroups",
+          "type": "boolean",
+          "description": "When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups."
+        },
+        {
+          "name": "withParents",
+          "type": "boolean",
+          "description": "Include a flat list of all parents and grandparents of the given object"
+        }
       ]
     },
     {

diff --git a/api/spec/json/deviceGroups.json b/api/spec/json/deviceGroups.json
@@ -112,15 +112,30 @@
           ]
         },
         {
-          "name": "withParents",
+          "name": "skipChildrenNames",
           "type": "boolean",
-          "description": "Include a flat list of all parents and grandparents of the given object"
+          "description": "Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved"
         },
         {
           "name": "withChildren",
           "type": "booleanDefault",
           "default": "false",
           "description": "Include names of child assets (only use where necessary as it is slow for large groups)"
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
+        },
+        {
+          "name": "withGroups",
+          "type": "boolean",
+          "description": "When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups."
+        },
+        {
+          "name": "withParents",
+          "type": "boolean",
+          "description": "Include a flat list of all parents and grandparents of the given object"
         }
       ]
     },
@@ -173,6 +188,33 @@
           "required": true,
           "description": "Device group ID"
         }
+      ],
+      "queryParameters": [
+        {
+          "name": "skipChildrenNames",
+          "type": "boolean",
+          "description": "Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved"
+        },
+        {
+          "name": "withChildren",
+          "type": "boolean",
+          "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
+        },
+        {
+          "name": "withGroups",
+          "type": "boolean",
+          "description": "When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups."
+        },
+        {
+          "name": "withParents",
+          "type": "boolean",
+          "description": "Include a flat list of all parents and grandparents of the given object"
+        }
       ]
     },
     {
@@ -708,6 +750,18 @@
           "required": true,
           "description": "Device Group."
         }
+      ],
+      "queryParameters": [
+        {
+          "name": "withChildren",
+          "type": "boolean",
+          "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
+        }
       ]
     }
   ]

diff --git a/api/spec/json/deviceGroupsChildren.json b/api/spec/json/deviceGroupsChildren.json
@@ -98,6 +98,11 @@
           "name": "withChildren",
           "type": "boolean",
           "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
         }
       ]
     },

diff --git a/api/spec/json/deviceProfile.json b/api/spec/json/deviceProfile.json
@@ -80,6 +80,31 @@
               ]
             }
           ]
+        },
+        {
+          "name": "skipChildrenNames",
+          "type": "boolean",
+          "description": "Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved"
+        },
+        {
+          "name": "withChildren",
+          "type": "boolean",
+          "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
+        },
+        {
+          "name": "withGroups",
+          "type": "boolean",
+          "description": "When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups."
+        },
+        {
+          "name": "withParents",
+          "type": "boolean",
+          "description": "Include a flat list of all parents and grandparents of the given object"
         }
       ]
     },
@@ -197,6 +222,33 @@
           "required": true,
           "description": "DeviceProfile (managedObject) id"
         }
+      ],
+      "queryParameters": [
+        {
+          "name": "skipChildrenNames",
+          "type": "boolean",
+          "description": "Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved"
+        },
+        {
+          "name": "withChildren",
+          "type": "boolean",
+          "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
+        },
+        {
+          "name": "withGroups",
+          "type": "boolean",
+          "description": "When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups."
+        },
+        {
+          "name": "withParents",
+          "type": "boolean",
+          "description": "Include a flat list of all parents and grandparents of the given object"
+        }
       ]
     },
     {

diff --git a/api/spec/json/devices.json b/api/spec/json/devices.json
@@ -179,6 +179,26 @@
             }
           ]
         },
+        {
+          "name": "skipChildrenNames",
+          "type": "boolean",
+          "description": "Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved"
+        },
+        {
+          "name": "withChildren",
+          "type": "boolean",
+          "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
+        },
+        {
+          "name": "withGroups",
+          "type": "boolean",
+          "description": "When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups."
+        },
         {
           "name": "withParents",
           "type": "boolean",
@@ -235,6 +255,33 @@
           "required": true,
           "description": "Device ID"
         }
+      ],
+      "queryParameters": [
+        {
+          "name": "skipChildrenNames",
+          "type": "boolean",
+          "description": "Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved"
+        },
+        {
+          "name": "withChildren",
+          "type": "boolean",
+          "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
+        },
+        {
+          "name": "withGroups",
+          "type": "boolean",
+          "description": "When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups."
+        },
+        {
+          "name": "withParents",
+          "type": "boolean",
+          "description": "Include a flat list of all parents and grandparents of the given object"
+        }
       ]
     },
     {

diff --git a/api/spec/json/devicesChildren.json b/api/spec/json/devicesChildren.json
@@ -98,6 +98,11 @@
           "name": "withChildren",
           "type": "boolean",
           "description": "Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance."
+        },
+        {
+          "name": "withChildrenCount",
+          "type": "boolean",
+          "description": "When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)"
         }
       ]
     },