Settings
The information in this document is currently in BETA and subject to change.
The Settings resource is a Read-Only resource that represents general system, division and accounting configuration information for the accessed system. This information is critical to displaying data in formats and ways that are familiar to, and desired by the resource owner. Specific settings can be requested using their setting name or all of the settings may be returned by requesting the entire resource.
Resource Properties
| Scope Parameter | settings |
|---|---|
| Location | /settings |
| Methods | GET |
| Default Page Size | NA |
| Max Page Size | NA |
| Default Includes | None |
Resource Attributes
| Field | Description | Format | Required | Field Type | Notes |
|---|---|---|---|---|---|
| value | The value of the setting. | string | true | default | |
| description | A description detailing how the setting is used. | string | false | default |
Link Templates
| Identifier | Resource | Location Template |
|---|