Oracle Analytics Publisher

Welcome to the Oracle Analytics Community: Please complete your User Profile and upload your Profile Picture

Confirmation needed on BI Publisher REST API for Catalog Management & SOAP API Support Lifecycle

Received Response
17
Views
1
Comments
Vangel
Vangel Rank 1 - Community Starter

We are implementing a CI/CD pipeline to manage our BI Publisher assets. A core requirement for this automation is a script that can upload BI Publisher catalog objects, particularly data model files (.xdm), from our version-controlled repository to BI publisher.

Our development and research led us to the BI Publisher SOAP Web Services. We have found that the ’CatalogService’ with its ’downloadObject’ and ’uploadObject’ methods, works perfectly for this task.

However, wer are evaluating whether this task can be accomplished using the more modern REST API. Our review of the REST API documentation indicates that its functionality is focused exclusively on „Manage Report”. We can see how to create a report and link it to an existing data model by providing its path, but we cannot find any endpoint or method that allows for the direct upload or download of the .xdm file itself.

Question 1: Could someone from Oracle or an experienced community member please confirm if our understanding is correct about REST APIs? Is it true that the BI Publisher REST API cannot be used to download (archive) and upload (unarchive) the standalone data model (.xdm.catalog) catalog files?

Question 2: Since the SOAP CatalogService appears to be the only tool for our requirement, we need to understand its long-term support plan. Is there a specific end-of-life or deprecation roadmap for the BI SOAP services, or we can expect them to be available?

SOAP:  https://docs.oracle.com/cd/E28280_01/bi.1111/e22259/catalogservice.htm#BIPDV826

Rest API: https://docs.oracle.com/middleware/12212/bip/BIPAP/rest-endpoints.html

Thank your for your assistance.

Answers

  • Sandeep S. Chauhan-Oracle
    edited Sep 9, 2025 11:20AM
    1. You are correct in your understanding. REST APIs cover report execution/management and do not support direct upload/download of .xdm catalog objects.
    2. There is no deprecation or end-of-life announced for the SOAP CatalogService, and no such plan exists. . These services continue to be supported across all flavors (OAS, OAC) with modern authentication (OAuth) Additionally, there is a Catalog Utility available which may help in some scenarios, though it may not fully align with your CI/CD automation requirement.