Learning
Community
Open Exchange
Global Masters
InterSystems IRIS Data Platform 2019.3 / Application Development / Client-Side APIs for InterSystems IRIS Business Intelligence / Business Intelligence REST API / POST /Info/PivotVariableDetails/:cube/:variable
Previous section   Next section

POST /Info/PivotVariableDetails/:cube/:variable

Returns detailed information about the given pivot variable.

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,” earlier in this book.
variable Required. Logical name of the pivot variable.

Request Body Details

This service ignores the request body.

Example Request

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 the discussion at the start of this reference.
Previous section   Next section