Jump to

• Request
• Response
• Examples

Get Existing Device Groups

get

/rest/{versionId}/inventory/deviceMgmt/deviceGroups

Use this (GET) method to 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

• versionId: string

Query Parameters

• immediateChildren(optional): string
• parentGroupId(optional): string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : deviceGroups

Type: object

Show Source

• deviceGroups(optional): array deviceGroup

{
    "properties":{
        "deviceGroups":{
            "items":{
                "$ref":"#/definitions/RestDeviceGroup",
                "xml":{
                    "name":"deviceGroup"
                }
            },
            "type":"array",
            "xml":{
                "name":"deviceGroup"
            }
        }
    },
    "type":"object",
    "xml":{
        "name":"deviceGroups"
    }
}

Nested Schema : deviceGroup

Type: array

Show Source

• Array of: object deviceGroup

{
    "items":{
        "$ref":"#/definitions/RestDeviceGroup",
        "xml":{
            "name":"deviceGroup"
        }
    },
    "type":"array",
    "xml":{
        "name":"deviceGroup"
    }
}

Nested Schema : deviceGroup

Type: object

Show Source

• fullName(optional): string
• id(optional): string
• isHidden(optional): string
• name(optional): string
• parameters(optional): array parameters
• parentGroupFullName(optional): string
• parentGroupId(optional): string
• type(optional): string

{
    "properties":{
        "fullName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "isHidden":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "parameters":{
            "items":{
                "$ref":"#/definitions/RestParameter",
                "xml":{
                    "name":"parameter"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "parentGroupFullName":{
            "type":"string"
        },
        "parentGroupId":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"deviceGroup"
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object parameter

{
    "items":{
        "$ref":"#/definitions/RestParameter",
        "xml":{
            "name":"parameter"
        }
    },
    "type":"array",
    "xml":{
        "wrapped":true
    }
}

Nested Schema : parameter

Type: object

Show Source

• description(optional): string
• label(optional): string
• maxValue(optional): integer(int64)
• minValue(optional): integer(int64)
• name(optional): string
• readOnly(optional): boolean
• validValues(optional): array validValues
• value(optional): string
• valueList(optional): array validLists
• valueType(optional): string

{
    "properties":{
        "description":{
            "type":"string"
        },
        "label":{
            "type":"string"
        },
        "maxValue":{
            "format":"int64",
            "type":"integer"
        },
        "minValue":{
            "format":"int64",
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "readOnly":{
            "type":"boolean"
        },
        "validValues":{
            "items":{
                "type":"string",
                "xml":{
                    "name":"validValue"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "value":{
            "type":"string"
        },
        "valueList":{
            "items":{
                "type":"string",
                "xml":{
                    "name":"valueList"
                }
            },
            "type":"array",
            "xml":{
                "name":"validLists",
                "wrapped":true
            }
        },
        "valueType":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"parameter"
    }
}

Nested Schema : validValues

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string",
        "xml":{
            "name":"validValue"
        }
    },
    "type":"array",
    "xml":{
        "wrapped":true
    }
}

Nested Schema : validLists

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string",
        "xml":{
            "name":"valueList"
        }
    },
    "type":"array",
    "xml":{
        "name":"validLists",
        "wrapped":true
    }
}

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.

Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get existing device groups 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/deviceGroups"

Example of Accessing the API with Python

The following example shows how to get existing device groups 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/deviceGroups"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Wed, 08 May 2019 16:40:20 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
vary: Origin,Accept-Encoding
Content-Length: 225
Content-Type: application/xml

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"?>
<deviceGroups>
  <deviceGroup>
    <fullName>Home</fullName>
    <id>ID1</id>
    <isHidden>false</isHidden>
    <name>Home</name>
    <parentGroupId>ID0</parentGroupId>
  </deviceGroup>
</deviceGroups>

Back to Top