Get system settings
/api/20210901/system/settings
Request
-
key: array[string]
Returns a list of Settings for which we have queried. If omitted, returns all the Settings.
-
pending: boolean
If true, returns a list of system settings that are not yet applied, that is, pending. If false, returns a list of system settings that are currently applied. If the pending parameter is not defined, returns all the system settings.
-
type: string
Optional. Type of system settings you want to return. `default`: Return system settings with default values, that is, settings that haven't been modified. `updated`: Return system settings with customized values, that is, settings that have been modified.Allowed Values:
[ "default", "updated" ]
There's no request body for this operation.
Back to TopResponse
- application/json
200 Response
array
-
Array of:
object Settings
An object which represents a system-level property.
object
-
object
UpdateSettingsDetails
An object representing the settings update payload.
object
401 Response
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
403 Response
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
500 Response
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
Examples
These examples show you how to obtain the latest system setting information for your Oracle Analytics instance.
- Example 1 - Get a list of all the system settings and their current values
- Example 2 - Get current values for a specific set of system settings
- Example 3 - Get a list of system settings that aren't applied yet
Example 1 Get a list of all the system settings
In this example, you get a list of all the system settings, their current values, and whether they've been applied yet.
cURL Example:
curl -i \ --header 'Authorization: Bearer <token>' \ --request GET 'https://<hostname>/api/20210901/system/settings'
Example of Request Body
Not applicable.
Example of Response Header
Not applicable.
Example of Response Body
{ "items":[ { "key":"String", "value":"String", "displayName":"String", "pending": Boolean } ]
For example:
Status 200:
{ "items":[ { "key":"UserInactivityTimeout", "value":"60", "displayName":"User Inactivity Timeout (minutes)", "pending": true }, {... } ] }
Example 2 Get current values for a specific set of system settings
In this example, you request information about two system settings Connection Externalization
Enabled and Allow HTML/JavaScript/CSS Content. The REST API keys for these
settings are EnableConnectionExternalization
and
AllowHTMLJavaScriptCSSContent
.
To find key values for other system settings, see REST API Keys for System Settings.
cURL Example:
First, obtain the REST API key value for the system settings you want to return. See REST API Keys for System Settings.
Then run this cURL command with the required key values:
curl -i \ --header 'Authorization: Bearer <token>' \ --request GET 'https://<hostname>/api/20210901/system/settings?key=EnableConnectionExternalization&key=AllowHTMLJavaScriptCSSContent'
Example of Request Body
Not applicable.
Example of Response Header
Not applicable.
Example of Response Body
If successful, the response body contains an array of the requested system settings with the following structure:
For example:
Status 200:
{ "items":[ { "key":"EnableConnectionExternalization", "value":"true", "displayName":"Connection Externalization Enabled", "pending": true }, { "key":"AllowHTMLJavaScriptCSSContent", "value":"never", "displayName":"Allow HTML/JavaScript/CSS Content", "pending": false } ] }
Example 3 Get a list of system settings that aren't applied yet
In this example, you request a list of system settings with updates in progress, that is, waiting
to be applied (pending=true
).
cURL Example:
curl -i --header 'Authorization: Bearer <token>' --request GET 'https://<hostname>/api/20210901/system/settings?pending=true'
Example of Request Body
Not applicable.
Example of Response Header
Not applicable.
Example of Response Body
If successful, the response body contains an array of system settings with the
pending
value true
, in this format:
{ "items":[ { "key":"String", "value":"String", "displayName":"String", "pending": true } ]
For example:
Status 200:
{ "items":[ { "key":"UserInactivityTimeout", "value":"60", "displayName":"User Inactivity Timeout (minutes)", "pending": true } ] }