Typical Workflow for Using System Setting REST APIs

Here are the common tasks to start using Oracle Analytics Server 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 Server to manage system settings using REST APIs (BI Service Administrator).

Quick Start tasks
Understand the authentication mechanism allowed by your configuration. Authentication in Oracle Analytics Server is managed using the same authentication mechanism as your Oracle Analytics Server environment. Authenticate
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