Query parameter

Each RESTCONF operation allows one or more query parameters to be present in the request URI. The specific parameters that are allowed depends on the resource type, and sometimes the specific target resource used, in the request.

The following are the query parameter which will be supported in this release.

Depth

For example, the below mentioned URL retrieves all the child resources of the “interface”, with the default value "unbounded" set to param “depth”.

GET /restconf/data/brocade-interface:interface?depth=unbounded

Content

You must mention the value of the content as “config” in the URI to retrieve the configuration data.
GET /restconf/data/interface?content=config

With Default

The "with-defaults" parameter is used to specify how information about default data nodes should be returned in response to GET requests on data resources.

When data is retrieved with a <with-defaults> parameter equal to 'trim', data nodes must not be reported if they contain the schema default value.

GET  /restconf/data/interfaces/interface=eth1?with-defaults=trim   HTTP/1.1
Host: 10.24.12.77
Accept: application/yang.data+json

This is the server responds.

HTTP/1.1 200 OK
   Date: Mon, 23 Apr 2012 17:01:00 GMT
   Server: SLX-OS WWW
   Content-Type: application/yang.data+json
   {
     "example:interface": [
       {
         "name" : "eth1",
         "status" : "up"
       }
     ]
   }