REST API for Oracle Analytics Cloud

Get system settings

get

/api/20210901/system/settings

Returns a list of system settings.

Request

Query Parameters

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.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: object

Show Source

items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Settings"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Settings

An object which represents a system-level property.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Settings"
    }
}

Nested Schema : Settings

Type: object

An object which represents a system-level property.

Show Source

displayName(required): string
pending(required): boolean

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdateSettingsDetails"
        }
    ],
    "description":"An object which represents a system-level property.",
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "pending":{
            "type":"boolean"
        }
    },
    "required":[
        "key",
        "displayName",
        "value",
        "pending"
    ]
}

Match All

Show Source

object UpdateSettingsDetails

An object representing the settings update payload.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdateSettingsDetails"
        }
    ],
    "description":"An object which represents a system-level property.",
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "pending":{
            "type":"boolean"
        }
    },
    "required":[
        "key",
        "displayName",
        "value",
        "pending"
    ]
}

Nested Schema : UpdateSettingsDetails

Type: object

An object representing the settings update payload.

Show Source

key(required): string
value(required): string

{
    "description":"An object representing the settings update payload.",
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "required":[
        "key",
        "value"
    ]
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

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

If successful, then the response body contains an array of system settings with the following structure:

{
 "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 
      }
   ]
}