Jump to

• Request
• Response
• Examples

Lock or Unlock Devices

post

/rest/{versionId}/inventory/nfMgmt/nfs/{nfId}/groups/{groupId}/action

Use this (POST) method to lock or unlock the devices within a device group.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• groupId: string
• nfId: string
• versionId: string

Body ()

Root Schema : deviceGroupAction

Type: object

Show Source

• type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        }
    },
    "xml":{
        "name":"deviceGroupAction"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

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

The following example shows how to perform an action on a device group by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL

<curl>

Example of cURL Data

The following shows an example of cURL data sent with the request.

curl -v -b sessionid.txt -X POST -d@nf/lockDeviceGroup.xml -H"Content-Type: application/xml" -H"Accept: application/xml" http://localhost:8080/rest/v1.1/inventory/nfMgmt/nfs/ID18/groups/ID18/action

Example of Request Body

The following shows an example of the user request body input in XML format.

<?xml version="1.0" encoding="UTF-8"?>
<deviceGroupAction>
   <type>Lock</type>
</deviceGroupAction>

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 204 No Content
Date: Wed, 06 Sep 2017 21:55:59 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN

Back to Top