REST API Endpoint to extract data from cube view

[dbug]

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 ?

[NicolasArgente · Accepted solution]

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
				}
}

[JackLacava]

As 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.

[dbug]

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 · Accepted solution]

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.

[dbug]

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 !

[__brandon]

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"
}

[IBK]

Hi Jack,

     One question on the REST API itself:

          How can we return something like a list of attributes that are not present in the receiving system to the calling system please? Any help would be greatly appreciated.

Thank You,

Indu 

[JackLacava]

You can't, you have to know what the CubeView expects. Getting CV data requires admin rights, it is assumed that admins can log on and check. The REST API is not meant to be exploratory, but rather to automate admin tasks.

[NicolasArgente · Accepted solution]

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
				}
}

[dbug]

Thanks a lot for the reply @NicolasArgente ! At first I was going to omit them but then realized omitting them seems to set everything to 'True', which would show some unnecessary data for my purpose - hence I indeed needed to include them in the body.

As @JackLacava mentioned above, I had an issue with my custom variables in my cubeview which seemed to be hiding the data.

Thanks to you both !

[IBK]

Could someone please help with the BR code to parse the CustomSubstVarsAsCommaSeparatedPairs please. If I use an Extender then will that work. Any help is appreciated. 

Thank You.