Get Information on an NF Group
get
/rest/{versionId}/inventory/nfMgmt/nfs/{nfId}/groups/{groupId}
Use this (GET) method to display a specific device group from a Network Function (NF).
Request
Path Parameters
Back to Top
Response
Supported Media Types
- application/xml
- application/json
200 Response
successful operation
Nested Schema : parameter
Type:
Show Source
object
-
description(optional):
string
-
label(optional):
string
-
maxValue(optional):
integer(int64)
-
minValue(optional):
integer(int64)
-
name(optional):
string
-
readOnly(optional):
boolean
Default Value:
false
-
validValues(optional):
array validValue
-
value(optional):
string
-
valueList(optional):
array validLists
-
valueType(optional):
string
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
The following example shows how to retrieve a specified device group from the NF by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
Example of cURL Data
The following shows an example of cURL data sent with the request.
curl -v -b sessionid.txt -X GET -H"Content-Type: application/xml" -H"Accept: application/xml" http://localhost:8080/rest/v1.1/inventory/nfMgmt/nfs/ID7/groups/ID10
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Wed, 06 Sep 2017 20:51:41 GMT Server: Apache X-Frame-Options: SAMEORIGIN Content-Length: 329 Vary: Accept-Encoding Content-Type: application/xml
Example of Response Body
The following example shows the contents of the response body in XML format.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <deviceGroup> <fullName>HG1/HG2/NF1/DependencyGroup/myCluster</fullName> <id>ID10</id> <isHidden>false</isHidden> <name>myCluster</name> <parentGroupFullName>HG1/HG2/NF1/DependencyGroup</parentGroupFullName> <parentGroupId>ID9</parentGroupId> <type>SCALABILITY</type> </deviceGroup>