Query Options | Config REST Web Service
Query options are query string parameters that control the amount and order of the configuration objects comming from a Config REST Web Service. They can be applied when requesting a list of configuration objects.
The options can be combined and their names are prefixed with a dollar
$ character.
$count
With the option $count, clients can get the total number of configuration objects.
If present, the @odata.count property is present in JSON string of HTTP response.
$top
With the option $top, clients can specify the maximum number of configuration objects that should be returned, starting from the beginning.
|
The option does not affect the total number of configuration objects in the payload when selected by |
$skip
With the option $skip, clients can specify the number of configuration objects that should be ignored at the beginning of a collection.
|
The option does not affect the total number of configuration objects in the payload when selected by |
$orderby
With the option $orderby, clients can specify the order of configuration objects.
If the option is not specified, the order depends on the backend data source.
The order can be asc`ending (default) or `desc`ending and is based on
names of properties with primitive values (in OpenApi specification as
`"integer" or "string") only.
Multiple property names can be separated by a comma to create a chain of comparators. The next comparator in the sequence is applied when the previous one returns the same result.
If the selected property is not part of all configuration objects, configuration objects without the property comes first in the result.
Reading all configuration objects in descending order by dp property and then in ascending order by key property
$filter
With the option $filter, clients can request a subset of all configuration objects.
The subset can be specified by
<BooleanExpression> (certain criteria) which each of the returned configuration objects have to fulfill.
If the value returned for a given configuration object is true, the object is returned.
Otherwise the configuration object is discarded.
|
The option affects the total number of configuration objects in the payload when selected by |
The option is specified as follows:
$filter=<BooleanExpression>
For more details, please see OData Version 4.0: 1.2.5.1 System Query Option $filter.
Reading all configuration objects with dp property value equal to net.atos.dirx.access.apprepo.api.config.XmlTemplate
Request
GET {config_rest_web_application_location}/ConfigBases?$filter=dp eq 'net.atos.dirx.access.apprepo.api.config.XmlTemplate'