Quick Start

Use the information in this topic to help you get started with Oracle Analytics Server REST APIs.

Task 1: Obtain Account Information

From your Oracle administrator, obtain the appropriate account credentials to enable you to use Oracle Analytics Server REST APIs. Specifically, you will need:

User name and password for Oracle Analytics Server.
URL of your Oracle Analytics Server instance.
Appropriate application role in Oracle Analytics Server. The application role you require depends on the REST API operation you want to perform and is the same as the application role required to perform the same operation in the UI. For example:
- Catalog: Requires DV Content Author
- Connections: Requires DV Content Author
- Datasets: Requires DV Content Author
- Data flows: Requires DV Content Author
- Sequences: Requires DV Content Author
- Safe Domains: Requires BI Service Administrator
- System: Requires BI Service Administrator

Task 2: Understand the Send Request URL

Use the following URL to send requests using the Oracle Analytics Server REST API:

https://domain.com/path/resource-path

Where:

domain.com - Host (and port) where Oracle Analytics Server is running. For example: myoas.com
resource-path: Relative path that defines the resource (REST endpoint). See All REST Endpoints.