nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Oracle Communities

Oracle Analytics and AI

Child Item

OAC Rest API - No certain folder or dashboard found

User_CAIGP

Hi there,

I am calling OAC Rest API to get existing OAC objects including dashboards, dashboardpages, analysis, folders, etc. referring to the documentation.

https://docs.oracle.com/en/cloud/paas/analytics-cloud/acapi/index.html

When I call with this endpoint ~/api/20210901/catalog/dashboards?search=*, I was expecting to get all dashboard objects across all the folders, however, it only returned partial objects from the OAC environment.

One of dashboard object that was not returned by the API call, shows below in the catalog properties.

I also tried to access the dashboard object through the folder type API call, using ~/api/20210901/catalog/folders/<folder id>, but I got 404 NotFound error with the bellow message.

I am not so sure what's causing this issue if it's either unsupported dashboard type (e.g. compositeSigature: dashboardgroupfolder1) or user access issue, or something else. Can anyone please help me resolve this issue? Please let me know if additional information is needed.

Thanks,

Find more posts tagged with

Accepted answers

Steve F-2

Hi @User_CAIGP

Dashboardgroupfolders are commonly used for organising Dashboards and Workbooks.

Dashboards and Workbooks from this folder (provided the dashboardgroupfolder is created inside first level child of shared folders) are listed in "Navigation Menu" on DV UI home page. It is similar to Dashboard Menu on Classic UI, only difference is Classic UI won't include workbooks.

Additionally, the Dashboard menu on Classic UI is not new in OAC; therefore, if you migrated from Oracle Business Intelligence (OBI) or Oracle Analytics Server (OAS) you (anyone viewing this post) may already be aware of it, if not it could mean you are using this feature and may not have any dashboardgroupfolder in the catalog.

Reference for OAC (DV): See: https://docs.oracle.com/en/cloud/paas/analytics-cloud/acswn/index.html#GUID-CFF90F44-BCEB-49EE-B40B-8D040F02D476 (search/browser find for Provide quick access to content from the navigation menu)

Select curated workbook or dashboard folders when saving workbooks or dashboards, enabling a link to that workbook or dashboard to display on the Navigation menu (workbooks) or Dashboards menu (dashboards). See Begin to Build a Workbook and Create Visualizations, and Create Your First Dashboard.

In the Catalog if you had a group for classic content, the UI would have custom property, like this (similar to your screenshot):

When I call with this endpoint ~/api/20210901/catalog/dashboards?search=*, I was expecting to get all dashboard objects across all the folders, however, it only returned partial objects from the OAC environment.

I am trying to explain why you may have partial or no results returned for dashboardgroupfolders specifically.

All comments

Mike Durran-Oracle

Could I confirm that you are searching for dashboardgroupfolders with the API?
what is the result of a call to this endpoint: /api/20210901/catalog/dashboardgroupfolders?search=*

User_CAIGP

Hi Mike,

Yes, I am searching for all objects of the dashboard type. That dashboard group folder in this post contains the majority of dashboards and dashboard pages, but it's not found by any API endpoint.

When I called with /api/20210901/catalog/dashboardgroupfolders?search=*, it returned nothing with a status of 200, indicating a successful call.

Could you please let me know if there is anything else I can do?

Thanks,

Gianni Ceresa

Are you limited to a REST api call? Or you could also call a SOAP api? The WSDL still expose the "good old" WebCatalogService, which should definitely give you everything in your catalog, whatever type of object they are (the REST api has this "strange" behaviour that without filter it returns the types supported, and you then need to query by type to get content, which could easily introduce holes in the results with missing objects).

I'm quite sure the SOAP one will return you all the items in a folder of your catalog, and from there you can do recursive calls to get the details of each object, or another call to get the list of sub-items if it's a folder.

User_CAIGP

Hi Gianni,

Thank you for your advice.

I am new to SOAP api call and the listed methods on the document are JavaScript-like syntax. If I need to call the api in Postman, how should I make the request including the method type, endpont url format, header, auth type, etc.

Thanks,

Gianni Ceresa

To be fair I never tried to call it with Postman, I usually was calling it from applications/scripts I was writing, either in Java or Python.

It's definitely a more "annoying" kind of webservice compared to REST, because it is less easy to call.

User_CAIGP

Thank you Gianni,

I figured out the way to make requests in Postman. I assume that both REST API and SOAP API will be available without any deprecations for OAC?

Gianni Ceresa

The SOAP API is in the product for 15+ years, I don't see why it would go away any day soon (it doesn't evolve much, but it's still there anyway).

The REST API is newer, a lot newer, and being publicly documented for usage only for some years now. It's supposed to be the new API for the product, mostly because REST is a lot easier and used by so many tools nowadays (and it also support some features that aren't available in the SOAP one).

But @Mike Durran-Oracle could maybe give a more official answer on that.

Steve F-2

Hi @User_CAIGP

Dashboardgroupfolders are commonly used for organising Dashboards and Workbooks.

Select curated workbook or dashboard folders when saving workbooks or dashboards, enabling a link to that workbook or dashboard to display on the Navigation menu (workbooks) or Dashboards menu (dashboards). See Begin to Build a Workbook and Create Visualizations, and Create Your First Dashboard.

In the Catalog if you had a group for classic content, the UI would have custom property, like this (similar to your screenshot):

When I call with this endpoint ~/api/20210901/catalog/dashboards?search=*, I was expecting to get all dashboard objects across all the folders, however, it only returned partial objects from the OAC environment.

I am trying to explain why you may have partial or no results returned for dashboardgroupfolders specifically.

User_CAIGP

Thank you Gianni and Steve for the details,

As both Rest API and SOAP API are good options with different pros and cons, I am investigating both ways to get OAC objects into tables.

@SteveF-Oracle, thanks for the explanation. I am curious why only partial dashboards inside a dashboardgroupfolders are returned by Rest API.

Thanks,

Mike Durran-Oracle

https://community.oracle.com/products/oracleanalytics/discussion/comment/68616#Comment_68616

We have a policy of giving 12 months notice of any API changes.