REST API for Oracle Analytics Cloud

All REST Endpoints

Catalog

A catalog where user content, such as workbooks, reports, connections, datasets, and other artifacts are stored.

Copy a catalog item: Method: post
Path: /api/20210901/catalog/{type}/{id}/actions/copy
Create a folder: Method: post
Path: /api/20210901/catalog/folders
Delete a folder: Method: delete
Path: /api/20210901/catalog/folders/{id}
Get catalog item ACL: Method: post
Path: /api/20210901/catalog/{type}/{id}/actions/getACL
Get catalog item details: Method: get
Path: /api/20210901/catalog/{type}/{id}
Get catalog items: Method: get
Path: /api/20210901/catalog
Get catalog items by type: Method: get
Path: /api/20210901/catalog/{type}
Move a catalog item: Method: post
Path: /api/20210901/catalog/{type}/{id}/actions/move
Update a catalog item ACL: Method: post
Path: /api/20210901/catalog/{type}/{id}/actions/updateACL

Catalog/Connections

A self-service connection to a data source.

Create a connection: Method: post
Path: /api/20210901/catalog/connections
Delete a connection: Method: delete
Path: /api/20210901/catalog/connections/{connectionId}
Update a connection: Method: put
Path: /api/20210901/catalog/connections/{connectionId}

Catalog/Data Flows

A visual collection of expressions, functions, and database commands that transform data or apply machine learning models.

Run a data flow: Method: post
Path: /api/20210901/catalog/dataflows/{dataflowId}/actions/run

Catalog/Datasets

A self-service data model based on a connection.

Reload data for a dataset: Method: post
Path: /api/20210901/catalog/datasets/{datasetId}/actions/reload

Catalog/Sequences

A collection of data flows, datasets, and other sequences that are processed in the same transaction.

Run a sequence: Method: post
Path: /api/20210901/catalog/sequences/{sequenceId}/actions/run

Snapshots

An archive file (BAR) that captures the state of an Analytics instance.

Create a snapshot: Method: post
Path: /api/20210901/snapshots
Delete a snapshot: Method: delete
Path: /api/20210901/snapshots/{snapshotId}
Get a snapshot: Method: get
Path: /api/20210901/snapshots/{snapshotId}
Get all snapshots: Method: get
Path: /api/20210901/snapshots

System

Analytics instance deployed on Oracle Cloud Infrastructure.

Get details of an Analytics instance: Method: get
Path: /api/20210901/system
Restore a snapshot in an Analytics instance: Method: post
Path: /api/20210901/system/actions/restoreSnapshot

System/Safe Domains

A domain registered as safe for an Analytics instance.

Create or update a safe domain: Method: put
Path: /api/20210901/system/safeDomains/{urlBase64DomainId}
Delete a safe domain: Method: delete
Path: /api/20210901/system/safeDomains/{urlBase64DomainId}
Get all safe domains: Method: get
Path: /api/20210901/system/safeDomains

System/System Settings

System-level properties for an Analytics instance.

Work Requests

The operations from the WorkRequests category.

Get a work request item: Method: get
Path: /api/20210901/workRequests/{id}