Typical Workflow for Using System Setting REST APIs
Here are the common tasks to start using Oracle Analytics Cloud REST APIs to programmatically view and manage system settings. If you’re using system setting REST APIs for the first time, follow these tasks as a guide.
Task | Description | REST API Documentation |
---|---|---|
Understand prerequisites |
Understand and complete several prerequisite tasks. You must have administrator permissions in Oracle Analytics Cloud to manage system settings using REST APIs (BI Service Administrator). |
Prerequisites |
Understand OAuth 2.0 token authentication | Authentication and authorization in Oracle Analytics Cloud is managed by Oracle Identity Cloud Service. To access the Oracle Analytics Cloud REST APIs, you need an OAuth 2.0 access token to use for authorization. | OAuth 2.0 Token Authentication |
Understand API keys for system settings | Each system setting has a public API key name that you can use in REST API operations. | REST API Key Values for System Settings |
Get system setting details | Get details about specific system settings, all system settings, or system settings that haven't been applied yet. | Get system settings |
Update system settings | Update one or more system setting. | Update system settings |