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 AI and Analytics

Child Item

Oracle analytics rest apis

User_TD15Q

Hi,

i have installed oracle analytics o2026 n my local machine and it is working and running fine. i want use its rest apis via python. but i came to know that web tier is must for this. so i installed web tier as well. now it is working fine http://localhost:7777/analytics/saw.dll?bieehome&startPage=1 also. but i am unable to reach "http://localhost:7777/api/20210901/catalog/items", rest api end point in browser, via curl command or in any way. Any help or clue will be really appreciated.

Find more posts tagged with

REST API

Oracle analytics

python

Accepted answers

Gianni Ceresa

I don't remember if there is a swagger file somewhere (some of the APIs have one, other don't…).

You have the official documentation for the "documented paths", then you can reference https://docs.oracle.com/en/middleware/bi/analytics-server/enterprise-deploy-oas/installing-and-configuring-oracle-http-server.html#OASED-GUID-355836D6-377B-46A2-A4FB-51CCC9B2BACD to see where that documented path points behind the proxy, and hit that path directly.

In my example /dv/api/v3/items is the API documented as /api/20210901/catalog, https://docs.oracle.com/en/middleware/bi/analytics-server/oasri/op-20210901-catalog-get.html . And because I didn't pass any parameter, it doesn't return the whole catalog but the list of supported types (as documented).

In your environment, does /dv/api/v3/items work? (If your OAS works, this one will also work, I'm quite sure). And /api/20210901/catalog doesn't work?

If that's your situation, your web tier isn't configured fully or correctly. You can either go back and check your whole OHS configuration, or skip it using the above link to get the mapping of documented API paths to internal paths.

And from there you just build whatever you need.

Your task is to find all analyses objects built using a direct database request? Get the query, the connection pool used, modify them and write the modified objects back to the catalog? If this is the case (so no DV object is involved), I don't think the REST API currently has a feature for that. But the good old WSDL SOAP API does: it can get objects, get their definition (if it's analyses it will return the XML), you can search in the XML to check if it's a direct database request analysis, modify it as needed and you have a SOAP method to write the XML back to the object.

Gianni Ceresa

Because of how the product work, there isn't a property saying "this analysis is a direct database request, and this use a subject area".

The answer is inside the object definition itself.

If you look at the readObjects https://docs.oracle.com/en/middleware/bi/analytics-server/developer_guide_oas/c-webcatalogservice-service.html#OASDV-GUID-3834CEE7-95A6-439E-A8A6-8FFF4AEE5F03 method, you see it has a parameter "ReadObjectsReturnOptions". The current doc doesn't list the values, but if you look at the WSDL itself you find the values. If you use "ObjectAsString" you will get the property "catalalogObject" property of the returned list containing the XML of the object.

From there you need to parse the XML to find if it does use a direct database request, what is the query, what connection pool is referenced.

All comments

Gianni Ceresa

Hi,

Welcome to the Oracle AI and Analytics community.

When you say you installed the web tier, you mean you installed the proxy in front of your OAS?

If that's the one, it isn't required for the rest APIs, it is just a "translation" of URLs.

As you are requesting the URL of your proxy, you should look at the proxy logs to see if your requests get there, and what happen once they do.

RVohra

@User_TD15Q , Welcome to the Oracle Analytics and AI Community.

Are we sure this is the correct endpoint, as per REST API for Oracle Analytics Server - Get catalog items

Get catalog items

get

/api/20210901/catalog

Hope it helps!

Thanks

Rajesh

User_TD15Q

@Gianni Ceresa @RVohra thank you your kind help.

@Gianni Ceresa it has been mentioned OAS REST API doc that "You must configure the web tier to enable access to the REST APIs. See Understanding the Web Tier". So i installed it in front of OAS. not sure i should call it proxy or actual. @RVohra i have tried accessing this API end point "http://localhost:9502/api/20210901/catalog/items" and via curl command with few other samples, i am getting 404 error all the time. not sure what is wrong and how to troubleshoot. but i am stuck. my task is to find oas direct query analysis and report, pick their queries modify them and their connect to another platform and write it back using python.

Gianni Ceresa

The "Web Tier" is nothing else than a kind of Apache HTTP Server (OHS is a customized version of that) acting as a proxy. If you look at your configuration you see that you had to configure all the locations having ProxyPassReverse instructions, which are instructions of the mod_proxy module.

That's why I say it isn't mandatory to use the API, because the web tier is configured to proxy all the API urls to the real API urls on OAS. The public doc gives the paths exposed by the proxy, while in real the API has a different path behind the proxy, and you had to configure all those mappings yourself as part of your installation.

If the API doesn't give you anything useful when calling it through the proxy, you can test the direct call to the real API path to isolate the issue: is it an issue with the API, with OAS or with your configuration of the proxy?

And again, as you configured the web tier, you need to start by looking at the logs of that piece. The OHS logs should be able to tell you who returned the HTTP-404. Does it come from OHS? Then it means your web tier config isn't right or complete. Does it come from OAS and OHS is only forwarding it? Then your API call is the issue.

And as Rajesh mentioned, there isn't a method with a path /api/20210901/catalog/items, but there is a method with a path /api/20210901/catalog/{type}. I don't know all the types off the top of my head, but I'm quite sure "items" isn't a valid type. Maybe just start hiting /api/20210901/catalog to see the various types of objects, and from there you have a valid value to use for "{type}".

At the end of the day, difficult to know exactly if your local installation is 100% complete and working. That's why, repeating myself, you should follow the logs. The logs will let you check step by step, tracking a request through the layers, till you find where it's failing. Because you are going through a proxy, you need to start from your web tier, your proxy, because there are good chances your requests are just failing there because of a bad config…

As an example, on my OAS 2026 I don't have the web tier configured. Because of that I can't call /api/20210901/catalog, but looking at the web tier config, I see that /api/20210901/catalog is proxied to /dv/api/v3/items. Therefore I can send a request to that directly:

As you can see "items" isn't a valid type. therefore your call to /api/20210901/catalog/items can't work because there isn't a type named "items".

User_TD15Q

lets ignore OHS for now. i was facing 404 in OAS 2026 from beginning and so moved to OHS being new bee. so kindly how can i find right end point in my OAS installation like in yours is "/dv/api/v3/items". is there any swagger file, or page path available to test the end points within OAS pleasE?

Gianni Ceresa

I don't remember if there is a swagger file somewhere (some of the APIs have one, other don't…).

In your environment, does /dv/api/v3/items work? (If your OAS works, this one will also work, I'm quite sure). And /api/20210901/catalog doesn't work?

And from there you just build whatever you need.

User_TD15Q

@Gianni Ceresa thanks a lot. http://xx-xxxx:9502/dv/api/v3/items worked on my side. it was really not available directly anywhere in simple rest api docs. in my humble opinion both paths should be provided. and i will look into developer guide. Will ask if need further guidance on SOAP to update query and connection of analysis.

Gianni Ceresa

There are a number of reasons for the doc to document the "proxy" API paths. If you look at the various proxy rules you are supposed to configure on your OHS, you will spot that there are a number of different APIs involved.

It's mostly because those APIs at first were built to be internal APIs, the DV web GUI is fully based on APIs, and those were used internally for that. After multiple requests, Oracle decided that to make them public, they had to structure them a bit more cleanly. That's why there is the proxy layer unifying paths, wording, parameters etc. when possible.

It's "mostly" an aesthetic choice, but this allow Oracle to expose an API also handling changes more easily in the future. The internal APIs could change at any time because required by the product, the documented API in the doc is more stable. It is normal that the internal API path isn't documented, but after using the product for a bit you notice how things works and are designed, so you can take shortcuts like bypassing the proxy for the API ;-)