The OneStream Community is temporarily frozen until June 29th due to the ongoing maintenance. Please read the blog post here to learn more.
Forum Discussion
Solved
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...
Yes. You can use that copy paste in the body of the API call.
{ "BaseWebServerUrl": "https://contoso.onestreamcloud.com/OneStreamWeb", "ApplicationName": "GolfStream_v37", "CubeViewName": "Gross Margin", "DataTablePerCubeViewRow": false, "ResultDataTableName": "ResultDataTableNames", "CustomSubstVarsAsCommaSeparatedPairs": "", "CubeViewDataTableOptions": { "IncludeTitle": false, "IncludeHeaderLeftLabel1" : true, "IncludeHeaderLeftLabel2" : true, "IncludeHeaderLeftLabel3" : true, "IncludeHeaderLeftLabel4" : true, "IncludeHeaderCenterLabel1" : true, "IncludeHeaderCenterLabel2" : true, "IncludeHeaderCenterLabel3" : true, "IncludeHeaderCenterLabel4" : true, "IncludeHeaderRightLabel1" : true, "IncludeHeaderRightLabel2" : true, "IncludeHeaderRightLabel3" : true, "IncludeHeaderRightLabel4" : true, "IncludePovCube" : true, "IncludePovEntity" : true, "IncludePovParent" : true, "IncludePovCons" : true, "IncludePovScenario" : true, "IncludePovTime" : true, "IncludePovView" : true, "IncludePovAccount" : true, "IncludePovFlow" : true, "IncludePovOrigin" : true, "IncludePovIC" : true, "IncludePovUD1" : true, "IncludePovUD2" : true, "IncludePovUD3" : true, "IncludePovUD4" : true, "IncludePovUD5" : true, "IncludePovUD6" : true, "IncludePovUD7" : true, "IncludePovUD8" : true, "IncludeMemberDetails": true, "IncludeRowNavigationLink" : true, "IncludeHasDataStatus" : true, "IncludeAnnotation" : true, "IncludeAssumptions" : true, "IncludeAuditComment" : true, "IncludeFootnote" : true, "IncludeVarianceExplanation" : true } }What I meant is: check the definition of your cubeview for things like the following:
That |WFYear| variable cannot be resolved automatically when executing the view from REST. So you have to pass the required value with the property "CustomSubstVarsAsCommaSeparatedPairs": [comma separated list of key value pairs as substitution variables with the following format: "VariableName1=[VariableValue1],VariableName2= [VariableValue2],..."]
In addition, make sure that all dimensions have a member specified either in the main POV or in row/columns, because via REST there won't be a UserPOV to fallback on.
JackLacava
OneStream Employee
OneStream EmployeeAs far as I know, that's supposed to return data as well - note the format is organized by rows... This requires however that the cubeview will return some data with default settings, without relying on UserPov (you can pass variables in the post call).
If that's not possible for whatever reason, a simple fallback is to configure a DataAdapter that uses the cubeview, and then use the GetAdoDataSetForAdapter instead.
Hi JackLacava Thanks for getting back so fast !
I have tried passing variables (the only ones I'm aware of are the ones from the doc - see screenshots below from the doc examples)
Are these the variables you're referring to ? If so, are you perhaps aware of other variables that would enable data to be visible? Otherwise I will attempt your DataAdapter suggestion instead
- JackLacava
What I meant is: check the definition of your cubeview for things like the following:
That |WFYear| variable cannot be resolved automatically when executing the view from REST. So you have to pass the required value with the property "CustomSubstVarsAsCommaSeparatedPairs": [comma separated list of key value pairs as substitution variables with the following format: "VariableName1=[VariableValue1],VariableName2= [VariableValue2],..."]
In addition, make sure that all dimensions have a member specified either in the main POV or in row/columns, because via REST there won't be a UserPOV to fallback on.
This was indeed what was messing with my data - I first tried to remove the variables and hardcode the values in my cubeview layout and was able to see the data when i made the call request ! Thank you so much !
Can you provide an example of how this would be used? "CustomSubstVarsAsCommaSeparatedPairs" .
If for example I wanted to be able to pass the specific entity I want using this property how would I set it up in the cube view row and what would I then pass using that property? There aren't any examples in the documentation that I can find.
Thanks!
- JackLacava
Anything in the Cube View would use the standard Parameter syntax, e.g. |!MyParam1!| where you need to parameterize a name. There should plenty of examples of that in docs.
Then in the body of your json call, you would have it as just another property:
{ ... all you other properties here ... "CustomSubstVarsAsCommaSeparatedPairs": "MyParam1=MyValue,MyParam2=AnotherValue" }
