REST API for Session Delivery Manager Release 8.2.5p1

Get Device Management Summary Information

get

/{versionId}/inventory/deviceMgmt/devices

Use this (GET) method to retrieve the summary device information for all devices that the user has privileges to view in Device Manager. The user can filter the query request using the query parameters provided in the request.

Request

Path Parameters

versionId:

Query Parameters

immediateChildren:
parentGroupId:

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

Example of Accessing the API with cURL

The following example shows how to get device management summary information by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET \
    -b sessionid.txt \
    --header "Accept: application/xml" \
    "https://example.com:8443/rest/v1.3/inventory/deviceMgmt/devices"

Example of Accessing the API with Python

The following example shows how to get device management summary information by submitting a GET request on the REST resource using Python. This example assumes the cookie variable contains a valid authentication cookie. For an example of authenticating with Python, see Authenticate.

import requests
url = "https://example.com:8443/rest/v1.3/inventory/deviceMgmt/devices"
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 format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<devices>
    <devices>
        <bootstrapState>Activated</bootstrapState>
        <connectivityStatus>true</connectivityStatus>
        <id>ID2</id>
        <ip>10.0.0.154</ip>
        <key>sd154_10.0.0.154</key>
        <manageable>true</manageable>
        <name>sd154</name>
        <nfId>ID5</nfId>
        <nfName>sd154</nfName>
        <parentGroupId>ID5</parentGroupId>
        <platformInfo>
            <platform>6100</platform>
            <serialNumber>--</serialNumber>
        </platformInfo>
        <softwareInfo>
            <configVersion>619</configVersion>
            <version>SCZ910p2</version>
        </softwareInfo>
    </devices>
    <devices>
        <bootstrapState>Activated</bootstrapState>
        <connectivityStatus>true</connectivityStatus>
        <id>ID3</id>
        <ip>10.0.0.157</ip>
        <key>sd157_10.0.0.157</key>
        <manageable>true</manageable>
        <name>sd157</name>
        <nfId>ID8</nfId>
        <nfName>sd157</nfName>
        <parentGroupId>ID8</parentGroupId>
        <platformInfo>
            <platform>6100</platform>
            <serialNumber>--</serialNumber>
        </platformInfo>
        <softwareInfo>
            <configVersion>38</configVersion>
            <version>SCZ900p2</version>
        </softwareInfo>
    </devices>
</devices>