Learning
Community
Open Exchange
Global Masters
InterSystems IRIS Data Platform 2019.3 / Analytics / Client-Side APIs for InterSystems IRIS Business Intelligence / Business Intelligence REST API / POST /Info/Cubes
Previous section   Next section

POST /Info/Cubes

Returns information about the cubes and subject areas available in the InterSystems IRIS™ namespace that you access via this REST call.

URL Parameters

None.

Request Body Details

This service uses the following properties of the request body:
TYPE Optional. This property can be cubes or subjectareas. If this property is cubes, the server sends information only about cubes. If this property is subjectareas, the server sends information only about subject areas. If this property is not specified, the server sends information about both cubes and subject areas.
BASECUBE Optional. If specified, this property should equal the logical name of a cube. In this case, the server sends information only about cubes and subject areas based on this cube.

Example Request

Example Response

{ 
 "Info":
   {"Error":"","Type":"all","BaseCube":"patients"},
 "Result":
   {"Cubes":[
      {"name":"AsthmaPatients","displayName":"AsthmaPatients","modTime":"2016-11-14 20:49:14","type":"subjectArea"},
      {"name":"DemoMDX","displayName":"DemoMDX","modTime":"2016-11-14 20:49:14","type":"subjectArea"},
      {"name":"YoungPatients","displayName":"YoungPatients","modTime":"2016-11-14 20:49:14","type":"subjectArea"}
      ]
   }
}
In the response object, the Result property contains a property called Cubes, which contains an array of objects, one for each cube or subject area. In these objects, the type property indicates whether the item is a cube or a subject area.
For information that applies to all response objects, see the discussion at the start of this reference.
Previous section   Next section