REST Api

32 Topics

REST API USE
Hello OneStream Community, I'm working on how to implement a REST API in OS, but i'm not sure to understand all the steps, i've already read the documentation and i've found it very hard to understand, can anyone please explain how can we implement it in OS what are the steps to follow, i started by downloading and installing POSTMAN for the tests but i don't know what should do i do after, please any help will be much appreciated. I'm also woundering if there any data management that should be used for this Thanks and merry christmas.
Solved
hoaphan
4 years ago Place Workflow and Data Integration
9.3KViews
0likes
15Comments
Is there a REST API for quickviews?
I have some experience retrieving structured cube data from the REST API named "GetAdoDataSetForCubeViewCommand". However, I'd like to get ad-hoc information. Ideally there would be another method that is analogous to retrieving data from an Excel "quickview". Did I overlook a "quickview" mechanism in the REST API? I am using the documentation named "REST API Implementation Guide", but it doesn't mention anything that looks promising. Perhaps there may be some undocumented approach? The cubeview already does much of what I need. However it requires preparation (the cubeviews must be prepared ahead of time and deployed to the server). It would be better if the API allowed "quickviews", since they don't require any previous preparation or infrastructure. Currently we are using Onestream v.6.3.0.
Solved
dbeavon
4 years ago Place Workflow and Data Integration
7.6KViews
0likes
10Comments
REST API reliability challenges in Azure
For those of us that are software developers, we are accustomed to this message. "The underlying connection was closed: A connection that was expected to be kept alive was closed by the server. This issue occurred after 68 seconds." When this issue comes up, it is normally because of some event that breaks TCP connectivity. Occasionally this happens because of network misconfiguration, or load-balancer misconfiguration. This is one of two errors we are seeing after migrating our REST api workloads to onestream's Azure environment. It happens fairly frequently, albeit in an unpredictable way. I haven't found a pattern yet. It doesn't happen on-premise. If anyone has experience deploying a REST api solution to Azure, please let me know if this is an error message you encounter frequently. It may not even be a problem with onestream's software; perhaps the root cause is with the Azure load-balancer. I am also looking into other possible explanations, like SSL inspection. Any tips would be greatly appreciated!
dbeavon
3 years ago Place Workflow and Data Integration
5.4KViews
1like
6Comments
REST API Endpoint to extract data from cube view
Is there a way to extract data from a cubeview with the OneStream REST API? I've tried using the "DataProvider/GetAdoDataSetForCubeViewCommand?api-version=5.2.0" endpoint from the doc via Python - however when I try to print the result from the response, it doesn't contain data, only metadata ( i.e 'Title', 'HeaderLeftLabel1' etc as seen in the screenshot below) Im trying to see the numerical values within the cells. Can this be done ?
Solved
dbug
3 years ago Place Workflow and Data Integration
5.1KViews
0likes
11Comments
Issue with REST API connectivity to OS
Hi, We are trying to setup REST API by following the OS documentation. Here we are using Azure as external authentication provider. We are able to get the token successfully, but passing back to the OS fails. Please advise on how to resolve this. Below the error message in Postman, "Error processing External Provider Sign In information. Token Validation Failed. IDX10214: Audience validation failed. Audiences: '00000002-0000-0000-c000-000000000000'. Did not match: validationParameters.ValidAudience: '3ace3d44-xxxxxxxxxxx-2651d589213e' or validationParameters.ValidAudiences: 'null'"
Solved
Vasanth
3 years ago Place Workflow and Data Integration
5.1KViews
0likes
6Comments
Any configuration requirements to use REST API
We have recently upgraded to version 6.5 from 5.1. Our Power BI consultants want to try the REST API to pull data out from OneStream repositories. Anyone has done this before and knows what setup/configuration need to perform before using REST API? Thanks
MZ
4 years ago Place Workflow and Data Integration
4.9KViews
0likes
8Comments
WEBAPI through SIC ???
Hi - Has anyone done WEBAPI through SIC ? I followed the document and I am not successful connecting to the endpoint. All I am trying to get the HTTP response. There are no issue from the firewall and thr port are open. We are able to successfully execute the endpoint from POSTMAN. Any help would be appreciated. Thanks
Solved
Krishna
2 years ago Place Workflow and Data Integration
4.7KViews
0likes
13Comments
REST API - Authentication/Logon - Missing Parameter(s)
I am trying to connect to a OneStream Cloud environment for which the REST API has been enabled and tested by OneStream Support. I am working in PostMan and following the REST API guide at System Guides > REST API Implementation > REST API Overview > Authentication, but i am hitting an error "One or more required parameters are missing." I can retrieve the AzureAD token fine, but when I then try and use it to authenticate with OneStream (expecting the SI to use later on), I get the above error message returned (along with a HTTP/400 Bad Request). As far as I can see I am not missing any Parameters as per that section of the REST API Guide. The POST request is to: https://xxxx.onestreamcloud.com/onestreamapi/api/authentication/logon?api-version=7.2.0 Params: api-version=7.20 Authorization: Bearer Token returned from Azure AD (via a PostMan variable) Content-Type: application/json Body: BaseWebServerURL: https://xxxx.onestreamcloud.com/onestreamweb What am I missing? Thanks Steve
Solved
SteveK
2 years ago Place Workflow and Data Integration
4.3KViews
0likes
3Comments
REST API stopped working after upgrade to 7.1
In the prior version of onestream we had configured AAD authentication, and we had a service principal that would be used to process REST API requests (aka the onestream "web api"). This service principal was simply to make all the requests for gettting data (cubeviews, adapters). However since we upgraded to 7.1, the REST API has stopped working. Whenever we present the onestream-web-api with the access token from AAD, it simply generates a bogus error: No Supported Authorization Provider Configured. The reason the error seems bogus is because the AAD authentication provider is working for all interactive users. It is only this particular AAD service principal that fails (the one associated with this REST api). We noticed that the release notes for 7.1.0 says: Microsoft is ending support for Azure Active Directory Authentication Library (ADAL) in December 2022. As a result, we have migrated to the Microsoft Authentication Library (MSAL) for authentication and authorization. Based on this, I'm guessing there was a breaking change in the way that the REST API must be configured. The upgrade did change the xml config, to some degree, but not in relation to this web API. Can someone please tell me where to find additional information that supports the unhelpful message that is sent to API clients: "No Supported Authorization Provider Configured"? There has to be a log somewhere with the actual exception that is triggering this message. The message is clearly not accurate as it stands. We do have AAD identities working everywhere except in the web API. Any help would be greatly appreciated. I would guess that the developer(s) who worked on the migration from ADAL to MSAL would be able to help interpret this error message.
Solved
dbeavon
3 years ago Place Workflow and Data Integration
3.3KViews
0likes
3Comments
Ad-hoc interface or query language for programmatically extracting data
We recently migrated from the legacy “client API” to the “REST API”. They are fairly similar and the migration was straightforward. We use these interfaces to retrieve data via custom “cubeviews”. The cubeviews act as a vehicle for exporting business data from onestream cubes. However it would be more convenient if we did NOT have to build and deploy cubeviews each time we needed a new piece of data. I have not found any mechanism for this yet, either in the old “client API” or in the “REST API”. In other words, it would be nice if there was an “ad-hoc” mechanism for retrieving data programmatically from dimensions and cubes. I haven’t found this yet, in the OneStream “DataProvider” interface. I see that there is an option for running SQL queries but I was told to avoid it since it is low-level and is used to interact with raw/internal SQL tables whose schemas would not be meaningful from a business perspective. In short, I’m wondering if there is a way to extract data programmatically with a “quick view” (similar to what is possible in Excel). Please let me know. What I would really like to have is a general-purpose MDX or DAX query interface … but I’m guessing that is not available.
Solved
dbeavon
4 years ago Place Workflow and Data Integration
2.9KViews
0likes
4Comments