Query Parameters
Each RESTCONF operation allows zero or more
query
parameters to be present in the request URL. The specific parameters allowed will
depend on the resource type, and sometimes the specific target resource used, in the
request.
- Query parameters can be given in any
order.
- Each parameter can appear only once in a
request URI.
- A default value may apply if the
parameter is missing.
- Query parameter names and values are
case-sensitive.
- A server MUST return an error with a
400 Bad Request
status-line if a query parameter is unexpected.
- The value of any query parameter MUST be
encoded according to RFC3986. Any reserved characters MUST be percent-encoded, according
to RFC
3986.
Table 1. Supported RESTCONF Query
Parameters
Name |
Methods |
Description |
content |
GET, HEAD |
Select config or non-config data resources |
depth |
GET, HEAD |
Request limited subtree depth in the reply content |
filter |
GET, HEAD |
Return a human-readable JSON formatted response instead of a non-formatted block
of data |
formatted |
GET, HEAD |
Reduces the response data by only returning the filtered results |
insert |
GET, HEAD |
Insertion mode for ordered-by-user data resources |
point |
GET, HEAD |
Insertion point for ordered-by-user data resources |