REST API for Oracle Analytics Cloud

All REST Endpoints

Catalog

The catalog where user content and other artifacts are stored. The content types that this API supports include folders, workbooks, subject areas, analyses, dashboards, dashboard pages, reports, connections, datasets, data flows, sequences, scripts, and semantic models.

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/Analysis

Operations on catalog analysis.

Get analysis details: Method: get
Path: /api/20210901/catalog/analysis/{urlBase64AnalysisId}

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}
Get connection details: Method: get
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.

Get latest run history for a data flow: Method: get
Path: /api/20210901/catalog/dataflows/{dataflowId}/history/latest
Get run history for a data flow: Method: get
Path: /api/20210901/catalog/dataflows/{dataflowId}/history
Get run history for a data flow job: Method: get
Path: /api/20210901/catalog/dataflows/{dataflowId}/history/{jobId}
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.

Get latest reload history for a dataset: Method: get
Path: /api/20210901/catalog/datasets/{datasetId}/history/latest
Get reload history for a dataset: Method: get
Path: /api/20210901/catalog/datasets/{datasetId}/history
Get reload history for a dataset job: Method: get
Path: /api/20210901/catalog/datasets/{datasetId}/history/{jobId}
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.

Get latest run history for a sequence: Method: get
Path: /api/20210901/catalog/sequences/{sequenceId}/history/latest
Get run history for a sequence: Method: get
Path: /api/20210901/catalog/sequences/{sequenceId}/history
Get run history for a sequence job: Method: get
Path: /api/20210901/catalog/sequences/{sequenceId}/history/{jobId}
Run a sequence: Method: post
Path: /api/20210901/catalog/sequences/{sequenceId}/actions/run

Catalog/Workbooks

A container that stores and organizes analytics content, such as tables, visualizations, filters and parameters.

Download workbook export: Method: get
Path: /api/20210901/catalog/workbooks/{urlBase64WorkbookId}/exports/{exportId}
Export workbook canvas: Method: post
Path: /api/20210901/catalog/workbooks/{urlBase64WorkbookId}/exports
Get canvases: Method: post
Path: /api/20210901/catalog/workbooks/{id}/actions/getCanvases
Get workbook details: Method: get
Path: /api/20210901/catalog/workbooks/{urlBase64WorkbookId}

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/Mail

Mail settings for an Analytics instance, including SMTP server.

Configure a mail server: Method: put
Path: /api/20210901/system/mail/server
Delete mail server settings: Method: delete
Path: /api/20210901/system/mail/server
Get mail server settings: Method: get
Path: /api/20210901/system/mail/server

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.

Get system settings: Method: get
Path: /api/20210901/system/settings
Update system settings: Method: put
Path: /api/20210901/system/settings

Work Requests

The operations from the WorkRequests category.

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