/Info/PivotVariableDetails/:cube/:variable
Returns detailed information about the given pivot variable.
Request Method
GET or POST
URL Parameters
cube
Required. Logical name of a cube that has access to the given pivot variable. This name can include slashes; see Use of Slashes in Cube and KPI Names.
variable
Required. Logical name of the pivot variable.
Request Body Details
This endpoint ignores the request body.
Example Request
-
Request Method:
POST
-
Request URL:
https://localhost/api/deepsee/v3/Info/PivotVariableDetails/:holefoods/:Year
For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
Example Response
{
"Info": {
"Error":"",
"BaseCube":"holefoods",
"Variable":"Year"
},
"Result": {
"Details": {
"context":"literal",
"defaultValue":"NOW",
"description":"",
"displayList":"",
"displayName":"Year",
"name":"Year",
"sourceName":"HoleFoodsYears.kpi",
"sourceType":"kpi",
"type":"string",
"valueList":""
}
}
}
In the response object, the Result property contains a property called Details, which contains the details for the pivot variable.
For information that applies to all response objects, see Notes on the Response Objects.