Oracle Analytics Cloud and Server Idea Lab

Products Banner

API for Data Visualization in Oracle Analytics Server/OAC

Delivered
921
Views
24
Comments

Organization Name

CESKA NARODNI BANKA

Description

"Traditional" OBIEE components (part of Oracle Analytics solution) offers quite rich API (Web Services) for performing programatically various tasks.

Unfortunatelly there is no API (at least I have not found anything in documentation for Oracle Analytics Server) for Data Visualization part. So it would be highly wanted to have API (REST, Web Services...) which offers following funcionality :

  • Manipulation of data sets
    • Modification/Creation
    • Upload/Refresh file based data sets
    • Possibility to purge BI Server cache, connected with particular data set
  • DV projects
    • Listing DV projects and their key properties
    • Ability to change key properties
  • Data Flows
    • Ability to run/monitor data flows
    • Ability to monitor/change jobs for data flows
  • Snapshots 
    • Create/Apply/Download/Upload snapshots
  • System Settings - programatically change system setting (showing up in System Settings in DV console /analytics/systemsettings/)

There is already Idea created "REST API for Oracle Analytics Cloud" (https://cloudcustomerconnect.oracle.com/posts/4fc31f00db), but I dont consider my idea as duplicate to this one - it is more wider and it deals with Oracle Analytics Server (thus on-prem version).

 

Use Case and Business Need

Ability to programatically via API perform various tasks in Data Visualization, making the task and maintanance of OAS/OAC environment more effiective. For some repetetive tasks (like reload/upload new version of file-based data set) is mandatory requirement.

Original Idea Number: 689d60e3ff

13
13 votes

Delivered · Last Updated

OAC Workbooks Public JSON is now a supported option

Comments

  • Thanks for the Idea - I'm pleased to report that this is an area we are currently working on.

    Mike
    (Analytics PM)

  • Michal Zima
    Michal Zima ✭✭✭✭✭

    Hi Mike,

    thanks for your reaction - I am glad to hear that. I am looking forward to have it implemented in next release of OAS. I know, that it will come first to OAC, but we are (and for some time we will be) on on-premise sw and thus I will be eagerly expecting new release of OAS (I guess it will be no sooner than next year :-( )

    Kind regards

    Michal

  • Hi Michael,

    Some of the capabilities you mention should already be available, at least data set and data flow operations. Please check the Swagger REST API documentation of your service and this video as an example: 

    https://www.youtube.com/watch?v=mQY2vslle_8

    To access the REST API documentation, please modify this URL to match your OAC instance: https://[YOUR_OAC_HOST]/datasetsvc/public/swagger.json

    Kind regars,

    Philipp

  • As it stands today, those APIs are internal product use only and not publicly supported or documented for developer use. 
    Regards

    Mike 

  • Michal Zima
    Michal Zima ✭✭✭✭✭

    Thanks to both of you for your comments. I understand, that API, mentioned in Philipp's post is not a official one, but at least it can give us a notion, what we can expect when it will be publicly available.

    Michal

  • Hi Mike,

    I am glad to hear that, this is something currently being worked upon.

    Apart from API for Data Visualization (all that is mentioned in this idea), our business requirement is to have an API in OAC that allows us to grant any new user with required roles and permissions. Having an API in OAC, to this would help us automate this process and save us from the hassle of going to multiple places to provide the roles and permissions to a new user.

    Thanks,

    Chethana

  • Michal Zima
    Michal Zima ✭✭✭✭✭

    Hi Mike,

    just out of curiosity - when can we approximately expect, that this API will be made available in both OAC/OAS products ?

    Thanks and regards

    Michal

  • Any update on when this will be delivered by Oracle?

    Flexagon has a DevOps platform which supports many Oracle technologies including IaaS, PaaS, and SaaS and we are seeing ample customer demand to provide out of the box support for OAC as well

  • Michal Zima
    Michal Zima ✭✭✭✭✭

    Hi,

    we are desperately wating to have complete and rich API to manipulate/query Data Visualization objects (Data Sets, Connections, DV Projects...) and after one year  there is no sign of improvement. I am convinced, that this is not sole requirement of our company and many other customers/partners are calling for it. Could somebody from Oracle Product Development, pls, take care of it ? I know, that this is not "a perfectly visible and best selling option", but is it mandatory and missing for quite long time. I ask for more attention.

    Thanks and kind regards

    Michal

  • Michal,

    We are working on this, we had to make some changes to the approach we were taking hence it's taking longer than we'd hoped.

    Mike

  • Michal Zima
    Michal Zima ✭✭✭✭✭

    Hi Mike,

    glad to hear from you again. Thanks for your answer - can you, pls, reveal at least approximate schedule, when this API will be available ? Will it be this year in OAC , so we can expect to have it  included in OAS in next release at begining of 2022 ?

    Rgds

    Michal

  • HI

    We would like to Identify Via API - DV Canvases (under DV Projects) - currently we can identify only DV project without any information about related Canvases
    In our portal we integrate OAS objects into our home page. In order to do that , we use ORACLE SOAP API’s - http://:9502/analytics-ws/saw.dll/wsdl/V12 . We would like to give our customers the option to embed specific DV Canvases into their homepage and in order to do that we must identify the Canvases under the DV project (which we can identify currently) - Canvas name and Canvas number.

    In the WS we currently - in OBI - use the “webCatalogService” the "getSubItems" and the "getItemInfo" methods.
    We would like to the same with DV objects .

    Thanks!
    Yossi

  • Michal Zima
    Michal Zima ✭✭✭✭✭

    I am addressing this comment to Oracle Product Development - this Idea has been created quite long time ago (more than year) and it collected numerous reaction/thumbs up. 
    In May 2021, there was a reaction from Mike Durran, that API for DV (I guess REST API) is in progress. 
    So we would like to know (and I am sure, that our organization is not the only one) , what is the status of API - whether it is going to be implemented in some reasonable timeframe (I haven't seen anything in official roadmap for OAC/OAS: https://www.oracle.com/business-analytics/cloud-and-server-roadmap.html)

    Thanks for Product Development response in advance.

  • Jerry Ursetti
    Jerry Ursetti ✭✭✭✭

    In addition to the functionality already mentioned, we need to be able to extract security data for reporting and analysis. We have datasets and reports that should only be accessed by certain users. It is extremely cumbersome and time consuming to have to click on everything to try to figure out who has access to what.

  • Hi Michal, I'm the product manager, in the analytics product development team that is tracking our work on a public API layer. I can re-confirm that we're engaged in development of APIs. Our plan is for a single public layer that will grow incrementally over subsequent releases. We're planning for the initial set of APIs to cover snapshots in OAC.

    Regards
    Mike

  • Jerry Ursetti
    Jerry Ursetti ✭✭✭✭

    Will the public API layer be accessible from within a private network? Our OAC instances are deployed in private subnets.

    Jerry

  • Yes. By 'public', I mean an API layer that is not used 'internally' by the Oracle Analytics product itself. So, public in this sense implies a level of support and consistency over time through and versioning. The difference being that the internal APIs used by the product can change at any time as required by the ongoing development of the product.

    Mike

  • Michal Zima
    Michal Zima ✭✭✭✭✭

    Hi Mike,

    thanks for you response - good to hear, that work on API is under way. I hope, that after snapshot manipulation also other "parts" (for DV data sets, data flows, DV projects and also system settings) of public API will follow. Just to make sure (I am not intentionally asking again about time schedule for this feature, although it will be very good to know at least approximate timeframe of implementation): Will this "public" API also be available in OAS (on-premise sw) ?

    Thanks again in advance for your your clarification

    Rgds

    Michal

  • Hi Mike,

    I had a query on the similar lines. Is there a timeline, when we could expect this?

    Would the API (restApi) allow us to access the OAC charts (insights) that are part of the canvases.

    We have a requirement to automate the charts health status (if any of the charts are broken we would like to get an alert) and this requires access to the API. Is this something that would be available?

    Thanks,

    Chethana

  • Given the long list of APIs, this is not a single idea. New APIs are being published with every release, as service management is available, snapshots are already delivered and soon to be followed by system settings. We plan to continue into other product areas based on specific prioritization based on customer use cases. As such, I'm going to mark this Idea as delivered since the spirit of the request is being addressed. If you would like to impact our prioritization, please submit ideas for specific needs/use cases that the community will vote on.


    Thanks,

    Gabby

  • Michal Zima
    Michal Zima ✭✭✭✭✭

    @Gabby Rubin-Oracle Thanks for answer, Gabby. Are you planning to post some more concrete plans about future API extensions in OAC/OAS roadmap document (https://www.oracle.com/business-analytics/cloud-and-server-roadmap.html) ? What is of our interest as customer is the ability to "manipulate" DV objects through API (setting/getting "properties" of DV objects, automate file-based data set reload, setting/getting ACL for DV objects etc...). So I will create separate Ideas for those (hopefully you will not marked them as "Duplicate").

  • The What's New document in each update lists the new APIs, we'll work with the outbound team that is responsible for the published roadmap to see if some of these topics can be surfaced on the o.com page as well.

    When it comes to controlling visual content there are already capabilities to do some of that. Our focus is on use cases where content is embedded in a host page. There is also work on documenting our JSON structures which will give more control. Point is that not everything is an API call, in some cases, it is documented formats or SDKs.

    Feel free to create separate Ideas for specific topics, we prefer those vs. generic ones; e.g. 3 Ideas such as 'ACL API', 'Scheduler API', and 'System Setting API', are better than 'need API'. It helps us prioritize the work as we can see how much attention each one gets which is the purpose of the IdeaLab. You can search ahead of time to see if the use case is already there to avoid wasting time on something that will be flagged as a duplicate. I appreciate that it might take more of your time, if that is too much work then feel free to post the 'generic' ones as well, we prefer those to not having anything.

  • Michal Zima
    Michal Zima ✭✭✭✭✭

    @Gabby Rubin-Oracle Hi Gabby, I am opening again discussion within this Idea (which has been set to Delivered status). But there are new facts, which force me to open it again:

    Quite recently new release of OAS for 2023 has been launched and I was desperately looking in What’s New for Oracle Analytics Server' document (https://docs.oracle.com/en/middleware/bi/analytics-server/whats-new-oas/index.html) some basic REST API functionality (snapshot mgmt, reload of data sets) which has been launched in OAC during 2022, but there was simple nothing.

    So I am addressing you with my question/concern:

    Is this an intention from some reason , that this REST API has not been brought into new OAS release (because it is bound to other cloud services)? If this is true, I am really very disappointed, since there are promises about official REST API for more than 2 years... I hope, you will dispel my fears in your answer. Thanks and regards

    Michal

  • HI @Gabby Rubin-Oracle , I'm joining Michal's question here - when I heard that OAS server 7.0 was released, the first thing to do, was check what's new with DV API's !.. And I must say that I was also very disappointed to see that in the documentation there weren't any news about this.

    In our portal we integrate OAS objects into our home page. In order to do that , we use ORACLE SOAP API’s . For example, we are waiting for the ability to download DV canvases by API to different formats.

    Also, our customers and us, are really waiting for the ability to schedule exports of DV workbooks and send via email.

    I also hope, that these options will be available very soon.

    Thanks

    Yossi