About this resource
Representation of a collection of Setting items
Properties
| Property | Description | Type |
|---|---|---|
| items | A collection of resource items. | Collection of Setting items |
Relations
Examples
Getting multiple settings
You can retrieve more than one setting with a single request by stating the names of the
settings you would like to retrieve. Use the "names" query parameter to specify
a comma-separated list of setting names which you want to retrieve.
For example:
GET /settings?names=.recordFieldViewList,.userFieldViewList HTTP/1.1 Accept: application/hal+json
This request will not fail for the cases when a
single setting fetch will:
- When a setting is not found: the missing setting will be omitted from the response.
- When a setting is not whitelisted and the user is not in the ADAM Administrator or Operator user groups: it will not be returned either.
- When the user doesn't have the Role required to change: the aggregated value for the current requestor will be returned using the ADAM setting value fallback mechanism.
- When a setting is a Role Setting: tt will not be returned in the response.
- If, due to all the specifics above, none of requested settings is returned, the response will simply be an empty collection (but not 404 not found).