Quick Start

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

Prerequisites

Prerequisite More Information
Subscribe to Oracle Analytics Cloud Subscribe to Oracle Analytics Cloud
Sign in to Oracle Analytics Cloud Access Oracle Analytics Cloud

Task 1: Obtain Account Information

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

  • User name and password for Oracle Analytics Cloud.

  • URL of your Oracle Analytics Cloud instance.

  • Appropriate application role in Oracle Analytics Cloud. 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 (Except for operations that use manageContent which requires BI Service Administrator)
    • 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
    • Snapshots: Requires BI Service Administrator
    • System: Requires BI Service Administrator

There are additional prerequisites to use Snapshot REST APIs. For details, see Snapshot REST API Prerequisites.

Task 2: Understand the Send Request URL

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

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

Where:

  • subdomain.domain.com - Host (and port) where Oracle Analytics Cloud is running. For example: myoac-idabcd0efghj-ia.analytics.ocp.oraclecloud.com

  • resource-path: Relative path that defines the resource (REST endpoint). See All REST Endpoints.

Example cURL Commands

The following table shows examples of GET and POST operations using cURL:

Operation cURL Command

Use GET to retrieve information about your Oracle Analytics Cloud instance.

curl -i --header 'Authorization: Bearer <token>' --request GET 'https://myoac-idabcd0efghj-ia.analytics.ocp.oraclecloud.com/api/20210901/system'

Use POST to create and register a snapshot.

curl -i --header 'Authorization: Bearer <token>' --request POST 'https://myoac-idabcd0efghj-ia.analytics.ocp.oraclecloud.com/api/20210901/snapshots' -d @example_request_payload.json