Oracle Communities

Oracle Analytics and AI

Child Item

REST APIs for Oracle Analytics Server to read the Catalog object metadata for Data Lineage

Use case: You are using a 3rd party data catalog & lineage going across various DW databases, ETL tools, & BI. You would like to programmatically read the metadata for objects in the OAS catalog. Third party tool able to read the Classic (OBIEE) objects, But looking for endpoints for DV Objects. You are using SOAP API to read the catalog details in the OAS.

Refer: What Are The Available Options To Manage The Catalog In Oracle Analytics Server (OAS)? (Doc ID 2724149.1) https://docs.oracle.com/middleware/12213/biee/BIEIT/methods.htm#BIEIT286

However, the DV has objects that don't fall into this existing pattern and barely read the objects. DV objects - connections, datasets, data flows, sequences, and workbooks

Idea:

Release catalog REST APIs for Oracle Analytics Server to read the Catalog object's metadata

OAS Rest APIs

https://docs.oracle.com/en/middleware/bi/analytics-server/oap_rest_api/rest-endpoints.html

Find more posts tagged with

Planned

Status: Planned

Comments

Michal Zima

@BalaGuddeti-Oracle Look at this Idea:

https://community.oracle.com/products/oracleanalytics/discussion/18832/api-for-programmatically-manipulating-dv-objects-data-visualization-and-automate-dv-tasks-in-oas

created by me in April 2023 - it basically dealing with same requirement as mine (complaining about complete lack of REST API for DV in OAS), so pls, vote for this Idea and add your comments to it. Thanks

GabriellePrichard-Oracle

The Catalog APIs were recently delivered in OAC. There are endpoints that will provide metadata about certain catalog objects- I am tagging @Mike Durran-Oracle to provide more information regarding if/when these APIs will be available in OAS.

Michal Zima

@GabriellePrichard-Oracle Gabrielle, it looks like that @Mike Durran-Oracle does not respond to your suggestion. For OAS customer, unavailability of REST API (for DV) is really very critical gap it product. And I hope, that Product Development/Mgmt is aware of this fact and have a plan/roadmap for it.

Mike Durran-Oracle

Apologies, I have been on extended leave and I'm just back this week. I'd like to confirm that we are aware, from previous discussions of the requirement for APIs on OAS.

vkm

the current Catalog ETLs are useful to get catalog objects only, It would be helpful to have a RESTAPI to get the RPD metadata subject areas, folders and columns in each folder.

GabriellePrichard-Oracle

@vkm Can you please create a new Idea Lab post for this?

User_BK96C

Hello,
is this functionality now fully available in Oracle Analytics Server 2025? I am currently unable to access the API, and it is not clear from the documentation how the endpoints are supposed to be exposed.

Could you clarify how the REST API endpoints are exposed in OAS 2025 and what needs to be configured or deployed on the application side in order to make them accessible?

The available documentation here – https://docs.oracle.com/en/middleware/bi/analytics-server/oasri/index.html – appears incomplete, as it refers to features and configurations that are not included in the actual installation packages or described in detail.