Business Intelligence REST API

This reference section provides information on the REST services for InterSystems IRIS® Business Intelligence. These services are provided by the class %DeepSee.REST.v1Opens in a new tab. See Using the Business Intelligence REST API.

• GET /Data/GetDSTIME – Retrieves the last ^OBJ.DSTIME timestamp that the server processed for a given cube.
• GET /Data/TestConnection – Tests the connection to the server.
• GET /Info/TestConnection – Tests the connection to the server.
• POST /Command/BuildAllRegisteredGroups – Build all cubes registered in the current cube registry.
• POST /Command/BuildCube – Build the target cube, and record and report build event information.
• POST /Command/BuildOneRegisteredGroup – Build all cubes in a registered cube group in the order in which they are listed and return statistics on the build process.
• POST /Command/BuildRegistryMap – Build a map of the current state of the Cube Registry and all unregistered cubes on the system.
• POST /Command/GetActiveRegistry – Build all cubes in a registered cube group in the order in which they are listed and return statistics on the build process.
• POST /Command/GetCubeSize – Given the name of a cube, returns the number of rows in its fact table.
• POST /Command/GetLastUpdate – Retrieves the timestamp of the last registered data update for the cube. Updates performed outside of the Cuber Manager will not be recognized in this check.
• POST /Command/getSynchScheduleParameters – A convenience method that retrieves and displays the parameters of %SYS.Task.DeepSeeSynchronize.
• POST /Command/IsValidCubeSchedule – Performs validation on current cube settings.
• POST /Command/IsValidGroup – Tests if the group specified is equivalent to the union of the natural groups of its members; returns 1 if true.
• POST /Command/RepairBuild – Perform an unscheduled repair build of a registered cube.
• POST /Command/SetActiveRegistry – Change which cube registry is currently active.
• POST /Command/SynchronizeCube – A wrapper for %DeepSee.Utils.%SynchronizeCube which records cube event information when building the cube.
• POST /Command/WriteToRegistry – Traverse a CubeManager.RegistryMap object and register all the cubes.
• POST /Data/KPIExecute – Execute the query defined by a KPI.
• POST /Data/MDXCancelQuery/:queryID – Cancels a previously started query, given the ID of the query.
• POST /Data/MDXDrillthrough – Executes a detail listing.
• POST /Data/MDXExecute – Executes an MDX query and obtains the results.
• POST /Data/MDXUpdateResults/:queryID – Retrieves updated results for a given query that was previously incomplete.
• POST /Data/PivotExecute – Executes the MDX query defined by a pivot table and obtains the results.
• POST /Info/Cubes – Returns information about the cubes and subject areas available in the InterSystems IRIS® namespace that you access via this REST call.
• POST /Info/Dashboards – Returns information about the dashboards available in the InterSystems IRIS namespace that you access via this REST call.
• POST /Info/FilterMembers/:datasource/:filterSpec – Returns information about the members of the given filter, as defined by the given data source (which is either a cube or a KPI).
• POST /Info/Filters/:datasource – Returns information about the filters available for the given data source (which is either a cube or a KPI).
• POST /Info/KPIs – Returns information about the KPIs available in the InterSystems IRIS namespace that you access via this REST call.
• POST /Info/ListingFields/:cube – Returns information about the <listingField> elements available in the InterSystems IRIS namespace that you access via this REST call.
• POST /Info/Listings/:cube – Returns information about the detail listings available for the given cube.
• POST /Info/Measures/:cube – Returns information about the measures available to the given cube.
• POST /Info/NamedFilters/:cube – Returns information about the named filters available to the given cube.
• POST /Info/Pivots – Returns information about the pivot tables available in the InterSystems IRIS namespace that you access via this REST call.
• POST /Info/PivotVariableDetails/:cube/:variable – Returns detailed information about the given pivot variable.
• POST /Info/PivotVariables/:cube – Returns information about the pivot variables available to the given cube.
• POST /Info/QualityMeasures/:cube – Returns information about the quality measures available to the given cube.