Data Provider API v7.2.0
| Method | Endpoint | Description |
| Post | DataProvider/ GetadoDataSetForAdapter |
Executes a Data Provider HTTP Post request and and returns a JSON representation of a DataSet for a given Dashboard Adapter. Requires a SessionInfo (SI) object obtained from Application/OpenApplication endpoint. |
DataProvider/GetAdoDataSetForAdapter
POST https://{BaseWebServer}/Onestreamapi/api/DataProvider/GetAdoDataSetForAdapter?api-version=7.2.0
Query Parameters
| Key | Value | Required |
| api-version | 7.2.0 | Yes |
Authorization
| Type | Value | Required |
| Bearer Token | (your access token) | Yes |
Headers
| Key | Value | Required |
| Content-Type | application/json | Yes |
Request Body
| Key | Type | Description | Required |
| IsSystemLevel | boolean | An indication of whether the Dashboard Adapter is defined at the System Level (True) or for the specified Application (False). | Yes |
| AdapterName | string | The name of the Dashboard Adapter used for data retrieval. | Yes |
| ResultDataTableName | string | Name of the resulting table in the DataSet | Yes |
| CustomSubstVarsAsCommaSeparatedPairs | string | Comma separated list of Variable name/value pairs requiring a user prompt. These must be specified using the following format: "VariableName1=[VariableValue1],VariableName2=[VariableValue2],...". | No |
| SI | array (bytes) | The SessionInfo (SI) object obtained from Application/OpenApplication endpoint. | Yes |
Sample Request
Copy
{
"IsSystemLevel": true,
"AdapterName": "Sales Mix (WF)",
"ResultDataTableName": "ResultsTable",
"CustomSubstVarsAsCommaSeparatedPairs": "",
"SI": {
"XfBytes": " QB8AACNodHRwOi8vbG9jYWxob3N0OjUwMDAxL09uZVN0cm
VhbVdlYhQAAAAep0GewgsakcN4GJDmuwyaaIMazfN/aHyhnXNLgg+hUxy6c
pQIT0tUQV9NMk27tnn6+VZaR544CKlYPCFe0BusL1iM2ggUAAAArL9Q04eP
ExHJxVU89Y1MAeNxrh8UT25lU3RyZWFtX0dvbGZTdHJlYW3xShfEXWxvRbO
x2hWDSCd0BWVuLVVTAAAAAAAAAAAAAAAAAAAAAAAAAAD//////////wAAAA
ACAFABAABQAfD///8AAAAAYHzddwMAAABCAfAAGfz//5z///+c////FQAQA
CYAIAARAGAAAwCQABn8//8Z/P//Gfz//xn8//8="
}
}
Sample Response
Copy
{
"ResultsTable": [
{
"RowId": 0,
"RowName": "Row1",
"PovCubeNameAndDesc": "GolfStream - Corporate",
"Pov00EntityNameAndDesc": "Total GolfStream",
"Pov02ScenarioNameAndDesc": "Actual - Actual",
"Pov03TimeNameAndDesc": "2011M2 - Feb 2011",
"Pov04ViewNameAndDesc": "YTD",
"RowHdr0NameAndDesc": "Drivers",
"RowHdr0Indent": 0,
"Col0Hdr0NameAndDesc": "60000 - Operating Sales",
"Col0Hdr0Indent": 0,
"Col0Value": 25552270.482000000000000000,
"Col0ValueAsText": "25,552,270.48"
},
}
"RowId": 1,
"RowName": "Row1",
"PovCubeNameAndDesc": "GolfStream - Corporate",
"Pov00EntityNameAndDesc": "Total GolfStream",
"Pov02ScenarioNameAndDesc": "Actual - Actual",
"Pov03TimeNameAndDesc": "2011M2 - Feb 2011",
"Pov04ViewNameAndDesc": "YTD",
"RowHdr0NameAndDesc": "Fairway Woods",
"RowHdr0Indent": 0,
"Col0Hdr0NameAndDesc": "60000 - Operating Sales",
"Col0Hdr0Indent": 0,
"Col0Value": 17476089.966000000000000000,
"Col0ValueAsText": "17,476,089.97"
}
]
}