Get Existing Device Groups
get
/{versionId}/inventory/deviceMgmt/deviceGroups
Retrieve all device groups created and maintained in Device Manager. Folder groups that are defined within Network Function (NF) device groups are not returned.
Request
Path Parameters
Query Parameters
Back to Top
Response
200 Response
400 Response
The user input is invalid.
401 Response
The session ID is invalid.
404 Response
The object (resource URI, device, and so on) of your input request cannot be found.
Examples
Examples of Accessing the API
See Authenticate for how to acquire a session cookie.
The following example shows how to get existing device groups using curl.
curl -X GET \
-b sessionid.txt \
--header "Accept: application/xml" \
"https://example.com:8443/rest/v1.3/inventory/deviceMgmt/deviceGroups"The following example shows how to get existing device groups using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/inventory/deviceMgmt/deviceGroups"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)Example of the Response Body
The following example shows the contents of the response body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<deviceGroups>
<deviceGroups>
<fullName>Home</fullName>
<id>ID1</id>
<isHidden>false</isHidden>
<name>Home</name>
<parentGroupId>ID0</parentGroupId>
</deviceGroups>
<deviceGroups>
<fullName>Devgrp</fullName>
<id>ID7</id>
<isHidden>false</isHidden>
<name>Devgrp</name>
<parentGroupId>ID0</parentGroupId>
</deviceGroups>
</deviceGroups>The following example shows the contents of the response body in JSON.
{
"deviceGroups": [
{
"fullName": "Home",
"id": "ID1",
"isHidden": "false",
"name": "Home",
"parentGroupId": "ID0"
},
{
"fullName": "Devgrp",
"id": "ID7",
"isHidden": "false",
"name": "Devgrp",
"parentGroupId": "ID0"
}
]
}