Client-Side APIs for InterSystems IRIS Business

Using Business Intelligence

This page introduces the JavaScript and REST APIs for InterSystems IRIS® data platform Business Intelligence. These APIs let you execute MDX queries and retrieve information about Business Intelligence model elements.

1.1 Creating a Web Application

In any scenario (whether you use the JavaScript API or you use the REST services directly), a web application is responsible for handling the requests. You can use the system-defined web application ( /api/deepsee) or you can create and use a dif- ferent web application. The requirements for this web application are as follows:

You must place your client file or files within the directory structure serv
ed by this web application.

You must specify the Dispatch Class option, which specifies ho w this web application handles REST requests. For Business Intelligence REST requests, use one of the following:

– %Api.DeepSee — Use this class if your client application must be able to connect to different namespaces. In this

case, when you connect to an InterSystems IRIS server, you must specify the namespace to use.

The system-defined web application ( /api/deepsee) uses this dispatch class.

– %DeepSee.REST.v3 — Use this class if the REST requests should be tied to a specific namespace (the namespace

for the web application).

The classes %DeepSee.REST.v2 and %DeepSee.REST.v1 are also available for use, but are documented only within the class reference.

You must configure the web application to support the method that your client application will use to authenticate user requests. By default, /api/deepsee is configured to allo w basic password authentication.

1.2 Introduction to the Business Intelligence JavaScript API

The Business Intelligence JavaScript API is provided by the file DeepSee.js, which is in the install-dir/CSP/broker directory. This JavaScript library enables you to interact with Business Intelligence from a client that is based on JavaScript. The

functions in this library are a wrapper for a REST-based API for Business Intelligence. (You can also use the REST API directly.)

To use this library:

Create a web application as described in the previous section.

Or use the web application /api/deepsee, which is provided as part of the installation.

In your JavaScript client code:

Include the files DeepSee.js and zenCSLM.js.

b. Create a Business Intelligence connection object. This contains information needed to connect to an InterSystems

IRIS server.

c. Create a Business Intelligence data controller object that uses the connection object.

The data controller object enables you to interact with a Business Intelligence data source, which you specify either via an MDX query or via the name of a pivot table.

d. Use the runQuery() method of the data controller. If the data source is an MDX query, Business Intelligence executes that query. If the data source is a pivot table, Business Intelligence executes the query defined by the pivot table.

Invoke other methods of the data controller object to examine the query results, to drill down or drill through, and so on.

The following subsections give the details.

The library DeepSee.js also provides utility functions that provide information about Business Intelligence model elements. Use these to obtain lists of available cubes, available measures in a cube, and so on.

1.2.1 Creating a Business Intelligence Connection

To create a Business Intelligence connection object, use code like the following:

connection = new DeepSeeConnection(username,password,host,application,namespace);

Where:

username is an InterSystems IRIS username that can access the given host.
password is the associated password.
host is the server name for the machine on which InterSystems IRIS is running.
application is the name of the web application.
namespace is the name of the namespace to access. If the web application is tied to a namespace, this argument is not needed.

1.2.2 Creating and Using a Business Intelligence Data Controller

The data controller object enables you to interact with Business Intelligence data sources. The primary interaction is as follows:

In a suitable part of the page logic (such as when the page is loaded or when a button is pressed), create a Business Intelligence data controller and execute a query.

Introduction to the Business Intelligence JavaScript API

When you create a data controller, you specify one or two callback functions to be run when data is available; finalCallbac k is required, but pendingCallback is optional.

When pending results are available, Business Intelligence calls the method specified by pendingCallback, if specified.

This method, which you write, uses the results that are available in the data controller object. The method typically draws page contents.

When the query has completed, Business Intelligence calls the method specified by finalCallbac k.

This method, which you write, uses the results that are available in the data controller object. The method typically draws page contents.

Any method that executes a query uses the system described here; see the subsections for details and examples. Other methods return data synchronously.

1.2.2.1 Creating a Business Intelligence Data Controller and Executing a Query

In a suitable part of the client code (such as within the page initialization logic), do the following:

Create a configuration object that has the follo wing properties:

connection — Specifies the name of a Business Intelligence data connector object; see the previous section.
widget — Specifies the id of the HTML element on the page that will use the data controller
type — Specifies the type of data source; use either 'MDX' or 'PIVOT'
initialMDX — Specifies an MDX SELECT query; use this if type is 'MDX'
pivotName — Specifies the logical name of a pi vot table; use this if type is 'PIVOT'
showTotals — Specifies whether to display totals. Specify either true or false

Create a data controller object with code like the following:

var dc = new DeepSeeDataController(configuration,finalCallback,pendingCallback);

Where configur ation is the configuration object from the pre vious step, finalCallbac k is the name of a callback function on this page, and pendingCallback is the name of another callback function on this page. finalCallbac k is required, but pendingCallback is optional.

Call the runQuery() method of the data controller. Or run some other method that executes a query, such as

runDrillDown() or runListing().

For example:

function initializePage() { ... configuration.connection = new DeepSeeConnection(username,password,host,application,namespace); dc = new DeepSeeDataController(configuration,drawChart); dc.runQuery(); }

1.2.2.2 Using Data Returned by the Data Controller

The page must also implement the callback function or functions referred to in the previous step. These callbacks should update the page as needed, using data obtained from the data controller object.

In each case, the data controller object is passed to the function as the argument.

The following shows a partial example:

function drawChart(dataController) {

var resultSet = dataController.getCurrentData(); ... var chartDataPoint; var chartLabel; var chartData = [];

for (var i = 1; i <= resultSet.getRowCount(); ++i) { for (var j = 1; j <= resultSet.getColumnCount(); ++j) { chartDataPoint = resultSet.getOrdinalValue(i,j); chartLabel = resultSet.getOrdinalLabel(2,i); chartData[chartData.length] = { "country":chartLabel[0],"revenue":chartDataPoint}; } } ... }

The getCurrentData() method of the data controller returns another object, the result set object. That object provides methods for examining the results of the query. The example here shows some of them.

1.3 Introduction to the Business Intelligence REST API

Internally, the JavaScript API uses the Business Intelligence REST API, which you can also use directly, as follows:

Create a web application.

Or use the web application /api/deepsee, which is provided as part of the installation.

In your JavaScript client code, create and send HTTP requests to the desired target REST services.

If your web application uses the dispatch class %Api.DeepSee, the target URL must include the Business Intelligence REST API version number and the target namespace name as part of the application path. It should take the following form:

where [baseURL] refers to your instance, [appName] is the path which is defined as the web application’ s name, [version] is the version of the REST API which you want to invoke, [namespace] is the target namespace, and [APIcall] is the actual rest call (for example, /Info/Cubes). For example:

https://data.example.com/api/deepsee/v3/sales/Info/Cubes

If your web application uses the dispatch class %DeepSee.REST.v3, the REST API version number and the target namespace are implicit to the web application definition and can therefore be omitted from the tar get URL. In other words, the target URL should take the following form:

For example:

https://data.example.com/mycustombiapp/Info/Cubes

Note:

The client must accept JSON. The Accept header of the request must either specify application/json or not declare a format.

Examine the response objects and use as applicable.

Introduction to the Business Intelligence REST API

1.3.1 Use of Slashes in Cube and KPI Names

It is relatively common to use slashes (/) in the logical names of cubes and other items, because the slash character is the token that separates a folder name from a short item name. For example, a cube might have the logical name RelatedCubes/Patients

You can directly use these logical names unmodified in URL parameters (as well as in the request bodies). The applicable Business Intelligence REST services account for logical names that include slashes. The logic, however, requires you to follow a naming convention (depending on which REST services you plan to use). Specifically , do not have an item with a logical name that is the same as the name of a folder used by another logical name. For example, if you have an item called mycubes/test/test1, you should not have an item called mycubes/test.

The reason for this restriction is that when you use a REST service that uses another argument after the logical name, part of the name is interpreted as another argument if the first part of the name matches an e xisting item. Consider the following REST call:

https://localhost/biserver/api/deepsee/v3/samples/Info/FilterMembers/:mycubename/:filterspec

Here mycubename is the logical name of a cube and filter spec is the specification for a filter pro consider this REST call with mycubes/test/test1 as the name of the cube:

vided by that cube. Now

https://localhost/biserver/api/deepsee/v3/samples/Info/FilterMembers/:mycubes/test/test1/:filterspec

In order to interpret the slash characters, the system first attempts to find a cube named mycubes and then attempts to find a cube named mycubes/test, and so on. When the system finds the first item that matches the apparent name, the REST call uses that item, and the remainder of the string is interpreted as the next argument.

1.3.2 Notes on the Response Objects

For most of the REST calls, the response objects contain the property Info, which contains information about the request and response. This object contains the property Error, which equals one of the following:

Null — This indicates that no error occurred.
An object that contains the properties ErrorCode and ErrorMessage — This object contains details about the error that you can use to determine whether and how to proceed.

If no error occurred, the response object also contains the property Result, which is an object containing the requested values.

In general, your client code should first check the Info.Error property and then determine how to proceed.

For example, a response object might look like this (with white space added for readability):

{"Info": {"Error": {"ErrorCode":"5001", "ErrorMessage":"ERROR #5001: Cannot find Subject Area: 'SampleCube'"} } }

In contrast, if no error occurred, the Info.Error property is null and the Result contains the result that you requested. For example:

{"Info": {"Error":"", "BaseCube":"DemoMDX", "SkipCalculated":0}, "Result": {"Measures": [ {"name":"%COUNT","caption":"%COUNT","type":"integer","hidden":0,"factName":""}, {"name":"Age","caption":"Age","type":"integer","hidden":0,"factName":"MxAge"} ...] } }

DeepSee.js

This reference section provides information on the JavaScript API for InterSystems IRIS Business Intelligence. This API is provided by the file DeepSee.js.

DeepSee.js

DeepSeeConnector

Enables you to connect to Business Intelligence data sources.

This object is available in client-side JavaScript code, if that code includes DeepSee.js. See Introduction to DeepSee.js.

To create a Business Intelligence data connector object, use code like the following:

var connection = new DeepSeeConnection(username,password,host,application,namespace);

Where:

username is an InterSystems IRIS® data platform username that can access the given host.
password is the associated password.
host is the server name for the machine on which InterSystems IRIS is running.
application is the name of the web application.
namespace is the name of the namespace to access.

Properties of This Object This object provides the following properties:

username is an InterSystems IRIS username that can access the given host.
password is the associated password.
path is the base URL for the web services.

A data connector object does not provide any methods.

DeepSeeDataController

Enables you to work with a Business Intelligence data source.

This object is available in client-side JavaScript code, if that code includes DeepSee.js. See Introduction to DeepSee.js.

To create a Business Intelligence data controller object, use code like the following:

var controller = new DeepSeeDataController(configuration,finalCallback,pendingCallback);

Where:

configur ation is an object that has the following properties:

–

connection — Is a Business Intelligence data connector object.

– widget — Specifies the id of the HTML element on the page that will use the data controller

–

type — Specifies the type of data source; use either 'MDX' or 'PIVOT' (case-sensitive)

initialMDX — Specifies an MDX SELECT query; specify this property if

type is 'MDX'

pivotName — Specifies the logical name of a pi vot table; specify this property if type is 'PIVOT'

showTotals — Specifies whether to display totals; specify this property as true or false

finalCallbac k is the name of a callback function on this page
For runQuery() and other methods of this object, when the query is completed, the system invokes this function.

pendingCallback (optional) is the name of another callback function on this page.

For runQuery() and other methods of this object, when pending results are available, the system invokes this function, if this argument is supplied.

The Business Intelligence data controller object provides the following JavaScript methods:

applyFilter()

applyFilter(filterInfo)

Where filterInfo is an object that contains the filterName and filterSpec properties.

This method adds the given filter to the filters used by the data controller callback functions associated with the data controller object.

, reruns the query, and then invokes the

This method has no return value.

attachTotals()

attachTotals(rowTotals,columnTotals,reattach)

Where:

rowTotals is true or false, depending on whether you want to attach totals for the rows.

DeepSee.js

columnTotals is true or false, depending on whether you want to attach totals for the columns.
reattach is true or false, depending on whether you want to update the most recently saved state.

If reattach is true, the system updates the most recently saved state. If reattach is false, the system adds a new state object to the stack.

This method attaches totals to the data controller object and then invokes the callback functions associated with the data controller object.

This method has no return value.

getCurrentData()

Returns a Business Intelligence result set object that contains the results from the query currently defined by the data controller object. See the reference for the DeepSeeResultSet object.

getCurrentQueryText()

Returns the text of the query currently defined by the data controller object.

runDrillDown()

runDrillDown(axis, position)

Where:

axis is the number of the axis on which you want to perform the drilldown action. Specify 1 for column or 2 for rows.
position is the position (1–based) on that axis where you want to perform the drilldown action.

This method executes the given drilldown action, and then invokes the callback functions associated with the data controller object.

This method has no return value.

runListing()

runListing(startRow, startCol, endRow, endCol, listingName)

Where:

startRow and startCol are the first ro w and column number of the results for which you want a detail listing. Specify 1 for the first ro w or column.
endRow and endCol are the last row and column number for which you want a detail listing.
listingName is the logical name of a detail listing.

This method executes the given detail listing for one or more cells of the results, and then invokes the callback functions associated with the data controller object.

This method has no return value.

runQuery()

Executes the query currently defined by the data controller object. When the query is pending or completed, the system invokes the callback functions associated with the data controller object.

DeepSeeDataController

This method has no return value.

sortResults()

sortResults(axis, position, direction, sortType)

Where:

axis is the number of the axis you want to sort. Specify 1 for column or 2 for rows.
position is the position (1–based) on that axis where you want to sort.
For example, to sort by the third column, specify axis as 1 and position as 3.
direction is the direction in which to sort. Specify 1 for ascending sort or –1 or descending sort.

sortType specifies ho w to sort. If this is '' or 'numeric' (case-insensitive), numeric sorting is used. Otherwise, string sorting is used.

This method sorts the results as requested and then invokes the callback functions associated with the data controller object.

This method has no return value.

undoLastAction()

Undoes the last change and invokes the callback functions associated with the data controller object.

This method has no return value.

DeepSee.js

DeepSeeResultSet

Enables you to work with the results of a Business Intelligence query.

This object is available in client-side JavaScript code, if that code includes DeepSee.js. See Introduction to DeepSee.js.

To create a result set, call the getCurrentData() method of the data controller object.

Or use code like the following:

var resultset = new DeepSeeResultSet(connection,widget,wait,timeout);

Where:

connection — Is a Business Intelligence data connector object.
widget — Specifies the id of the HTML element on the page that will use the data controller .
wait — Boolean. If this parameter is false, the server should respond immediately. If this parameter is true, the server should not respond until the query has completed or timed out.
timeout — Specifies ho w long (in seconds) the server should wait before returning final b ut incomplete query results.

Properties of This Object The Business Intelligence result set object provides the following properties:

connection — Is a Business Intelligence data connector object.
widget — Specifies the id of the HTML element on the page that will use the data controller .
wait — Boolean. If this property is false, the server should respond immediately. If this property is true, the server should not respond until the query has completed or timed out.
timeout — Specifies ho w long (in seconds) the server should wait before returning final b ut incomplete query results.
data — Contains the query results.
pollInterval — Specifies ho w long (in milliseconds) to wait before asking the server for updates to pending results. The default is 1000.

The Business Intelligence result set object provides the following JavaScript methods:

getColumnCount()

Returns the number of columns in the result set.

getCubeName()

Returns the name of the cube currently in use.

DeepSeeResultSet

getErrorMessage()

This method returns the text of the error message contained in the response object, if any.

getOrdinalLabel()

getOrdinalLabel(axis, position)

Where:

axis is the number of the axis whose labels you want to obtain. Specify 1 for column or 2 for rows.
position is the position on that axis whose labels you want to obtain. Specify 1 for the first position on the axis.

Returns an array of strings, corresponding to the labels at the given position on the given axis.

getOrdinalValue()

getOrdinalValue(rowNo,colNo,formatted)

Where:

rowNo is the row number (1–based)
colNo is the column number (1–based) Returns the value in the given cell.

getQueryStatus()

Returns a numeric value indicating whether the query has completed. This number is 100 if the query has completed. Otherwise, this number is less than 100.

getRowCount()

Returns the number of rows in the result set.

isError()

This method returns true if the response object indicates that an error occurred. Returns false otherwise.

runMDXQuery()

runMDXQuery(mdx,finalCallback,pendingCallback,filters)

Where:

mdx is an MDX SELECT query.
finalCallbac k is the name of a callback function on this page.

DeepSee.js

pendingCallback (optional) is the name of another callback function on this page.
filter s specifies additional filters to apply to the query .

This method executes the given MDX query. When the query is pending or completed, the system invokes the given callback functions.

This method has no return value.

runMDXDrillQuery()

runMDXDrillQuery(mdx,finalCallback,pendingCallback,listing,fieldList,filters)

Where:

mdx is an MDX SELECT query.
finalCallbac k is the name of a callback function on this page.
pendingCallback (optional) is the name of another callback function on this page.
listing is the name of a detail listing.
fieldList specifies a list of listing fields. Specify either
listing or fieldList .

filter s specifies additional filters to apply to the query

This method executes the given drillthrough query. When the query is pending or completed, the system invokes the given callback functions.

This method has no return value.

runPivot()

runPivot(pivot,finalCallback,pendingCallback,filters)

Where:

pivot is the logical name of pivot table.
finalCallbac k is the name of a callback function on this page.
pendingCallback (optional) is the name of another callback function on this page.
filter s specifies additional filters to apply to the query .

This method executes the MDX query defined by the gi ven pivot table. When the query is pending or completed, the system invokes the given callback functions.

This method has no return value.

DeepSeeUtils

Provides additional methods for working with Business Intelligence.

This object is available in client-side JavaScript code, if that code includes DeepSee.js. See Introduction to DeepSee.js.

When you include DeepSee.js in your client code, the DeepSeeUtils object is automatically available.

The DeepSeeUtils object provides the following methods:

getCubeList()

getCubeList(connection,finalFunc)

Where:

connection — Is a Business Intelligence data connector object.
finalFunc — Specifies the name of the function to e xecute when results are available This method retrieves information about the available cubes. It calls the POST /Info/Cubes REST call. The response object from that call is available to the function specified by finalFunc .

getCubeListings()

getCubeListings(connection,finalFunc)

Where:

connection — Is a Business Intelligence data connector object.
cubename — Specifies the logical name of a cube.
finalFunc — Specifies the name of the function to e xecute when results are available This method retrieves information about the listings available to the given cube. It calls the POST /Info/Listings/:cube REST call. The response object from that call is available to the function specified by finalFunc .

getDashboardList()

getDashboardList(connection,finalFunc)

This method retrieves information about the available dashboards. It calls the POST /Info/Dashboards REST call. The response object from that call is available to the function specified by

finalFunc .

getErrorMessage()

getErrorMessage(data)

Where data is a response object returned by any of the Business Intelligence Business Intelligence REST services.

This method returns the text of the error message contained in that object, if any.

DeepSee.js

getFiltersForDataSource()

getFiltersForDataSource(connection,cubename,finalcallback)

Where:

connection — Is a Business Intelligence data connector object.
cubename — Specifies the logical name of a cube.
finalcallbac k — Specifies the name of the function to e xecute when results are available This method retrieves information about the available filters for the gi ven cube. It calls the POST /Info/Filters/:datasource REST call. The response object from that call is available to the function specified by finalFunc .

getMembersForFilter()

getMembersForFilter(connection,cubeName,filterSpec,finalCallback)

Where:

connection — Is a Business Intelligence data connector object.
cubename — Specifies the logical name of a cube.
filterSpec — Specifies the filter whose members you w ant to retrieve.
finalcallbac k — Specifies the name of the function to e xecute when results are available This method retrieves information about members of the given filter . It calls the POST /Info/FilterMembers/:datafinalFunc . source/:filterSpec REST call. The response object from that call is available to the function specified by getPivotList()

getPivotList(connection,finalFunc)

Where:

connection — Is a Business Intelligence data connector object.
finalFunc — Specifies the name of the function to e xecute when results are available This method retrieves information about the available pivot tables. It calls the POST /Info/Pivots REST call. The response object from that call is available to the function specified by finalFunc .

getResultsAsArray()

getResultsAsArray(data)

Where data is a response object returned by any of the Business Intelligence REST services.

This method returns an array of results from that object as follows:

If the response object contains an Result.Filters array, the method returns that array.

Otherwise, if the response object contains an Result.FilterMembers array, the method returns that array.
Otherwise, if the response object contains an Result.Listings array, the method returns that array.

Otherwise the method returns nothing.

isError()

isError(data)

Where data is a response object returned by any of the Business Intelligence REST services.

This method returns true if the response object indicates that an error occurred. Returns false otherwise.

DeepSeeUtils

This reference section provides information on the REST services for InterSystems IRIS® data platform Business Intelligence. As described, these services are provided by the classes %Api.DeepSee and %DeepSee.REST.v3. See Using the Business Intelligence REST API.

/Command/Action/:cube/:action

Executes the specified KPI action defined by the action class for the gi

ven cube.

cube

action

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

Required. Name of an action defined in the <actionClass> for the gi ven cube.

If applicable to the action, the request body can include the calling context (under the CONTEXT object), and will be returned as the Context object in the Result payload. In this case, you must use POST.

GET
https://localhost/biserver/api/deepsee/v3/sales/Command/Action/holefoods/ActionA For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

{ "Info": { "CubeName": "holefoods", "Action": "ActionA" }, "Result": { "Context": { "command": "navigate:http://www.intersystems.com" } } }

/Command/BuildAllRegisteredGroups

Builds all cubes registered in the current cube registry.

/Command/BuildAllRegisteredGroups

POST

None.

This endpoint is called with an empty body.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/BuildAllRegisteredGroups For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

{ "buildStats": { "buildStats_1": { "caption": "Filter RDoctors", "elapsedTime": 0.01413, "errors": 0, "event": "build", "eventId": "124", "expressionTime": 0.000039, "factCount": 40, "iKnowTime": 0, "missingReferences": 0, "status": 1 }, "buildStats_2": { "caption": "Filter RPatients", "elapsedTime": 0.148839, "errors": 0, "event": "build", "eventId": "126", "expressionTime": 0.053942, "factCount": 1000, "iKnowTime": 0, "missingReferences": 0, "status": 1 }, "buildStats_3": { "caption": "Patients", "elapsedTime": 0.490752, "errors": 0, "event": "build", "eventId": "122", "expressionTime": 0.343703, "factCount": 1000, "iKnowTime": 0,

"missingReferences": 0, "status": 1 }, "buildStats_4": { "caption": "RCities", "elapsedTime": 0.010991, "errors": 0, "event": "build", "eventId": "123", "expressionTime": 0.000003, "factCount": 9, "iKnowTime": 0, "missingReferences": 0, "status": 1 }, "buildStats_5": { "caption": "RCityRainfall", "elapsedTime": 0.006289, "errors": 0, "event": "build", "eventId": "127", "expressionTime": 0, "factCount": 0, "iKnowTime": 0, "missingReferences": 0, "status": 1 }, "buildStats_6": { "caption": "RDoctors", "elapsedTime": 0.014014, "errors": 0, "event": "build", "eventId": "125", "expressionTime": 0.000041, "factCount": 40, "iKnowTime": 0, "missingReferences": 0, "status": 1 }, "buildStats_7": { "caption": "RPatients", "elapsedTime": 0.136887, "errors": 0, "event": "build", "eventId": "128", "expressionTime": 0.051799, "factCount": 1000, "iKnowTime": 0, "missingReferences": 0, "status": 1 }, "buildStats_8": { "caption": "RPatientsDependsOn", "elapsedTime": 0.146196, "errors": 0, "event": "build", "eventId": "129", "expressionTime": 0.051907, "factCount": 1000, "iKnowTime": 0, "missingReferences": 0, "status": 1 }, "buildStats_9": { "caption": "RPatientsInherit", "elapsedTime": 0.163897, "errors": 0, "event": "build", "eventId": "130", "expressionTime": 0.059377, "factCount": 1000, "iKnowTime": 0, "missingReferences": 0, "status": 1 } }, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/BuildCube

Builds the target cube, and records and reports build event information.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeName

Required. The name of the cube to be built.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/BuildCube For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeName":"Patients" }

{ "buildStats": { "caption": "Patients", "elapsedTime": 0.594205, "errors": 0, "event": "build", "eventId": "119", "expressionTime": 0.396416, "factCount": 1000, "iKnowTime": 0, "missingReferences": 0, "status": 1 }, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/BuildOneRegisteredGroup

Builds all cubes in a registered cube group in the order in which they are listed and returns statistics on the build process.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

groupName

Required. The name of the cube group to be built.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/BuildOneRegisteredGroup For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "groupName":"Group 1" }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/BuildRegistryMap

Builds a map of the current state of the Cube Registry and all unregistered cubes on the system.

/Command/BuildRegistryMap

POST

None.

This endpoint is called with an empty body.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/BuildRegistryMap For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

{ "registryMap": "{"Groups":[{"Cubes":[{"CubeKey":"PATIENTS","CubeDisplayName":"Patients","NaturalGroup":"1","CustomBuildOrder":1,"NaturalBuildOrder":1,"LastModDate":"65499,50447.825152","UpdatePlan":"BuildSynch","Disabled":"false","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Minute","DSTimeEnabled":"true","BuildAsynch":"true","IndependentSync":"false"}],"GroupName":"Group

1","IsRegistered":"true","IsValid":"true","UpdatePlan":"BuildSynch","Disabled":"false","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","BuildAsynch":"true"},{"Cubes":[{"CubeKey":"RCITIES","CubeDisplayName":"RCities","NaturalGroup":"2","CustomBuildOrder":1,"NaturalBuildOrder":1,"LastModDate":"65499,50449.971574","UpdatePlan":"Build","Disabled":"false","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","DSTimeEnabled":"true","BuildAsynch":"true","DependentCubes":"FILTERRDOCTORS,FILTERRPATIENTS,RCITYRAINFALL,RDOCTORS,RPATIENTS,RPATIENTSDEPENDSON,RPATIENTSINHERIT","IndependentSync":"false"},{"CubeKey":"FILTERRDOCTORS","CubeDisplayName":"Filter

RDoctors","NaturalGroup":"2","CustomBuildOrder":2,"NaturalBuildOrder":2,"LastModDate":"65499,50450.255272","UpdatePlan":"BuildSynch","Disabled":"false","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","DSTimeEnabled":"true","BuildAsynch":"true","DependentCubes":"FILTERRPATIENTS","IndependentSync":"false"},{"CubeKey":"RDOCTORS","CubeDisplayName":"RDoctors","NaturalGroup":"2","CustomBuildOrder":3,"NaturalBuildOrder":3,"LastModDate":"65499,50450.0987","UpdatePlan":"Build","Disabled":"false","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","DSTimeEnabled":"true","BuildAsynch":"true","DependentCubes":"RPATIENTS,RPATIENTSDEPENDSON,RPATIENTSINHERIT","IndependentSync":"false"},{"CubeKey":"FILTERRPATIENTS","CubeDisplayName":"Filter

RPatients","NaturalGroup":"2","CustomBuildOrder":4,"NaturalBuildOrder":4,"LastModDate":"65499,50450.446923","UpdatePlan":"BuildSynch","Disabled":"false","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","DSTimeEnabled":"true","BuildAsynch":"true","IndependentSync":"false"},{"CubeKey":"RCITYRAINFALL","CubeDisplayName":"RCityRainfall","NaturalGroup":"2","CustomBuildOrder":5,"NaturalBuildOrder":5,"LastModDate":"65499,50450.099619","UpdatePlan":"BuildSynch","Disabled":"false","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","DSTimeEnabled":"true","BuildAsynch":"true","IndependentSync":"false"},{"SubjectAreas":[{"SAName":"MYRPATIENTS","SADisplayName":"MyRPatients","IsCompound":"false","LastModDate":"65499,50450.253272"}],"CubeKey":"RPATIENTS","CubeDisplayName":"RPatients","NaturalGroup":"2","CustomBuildOrder":6,"NaturalBuildOrder":6,"LastModDate":"65499,50450.253272","UpdatePlan":"BuildSynch","Disabled":"false","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","DSTimeEnabled":"true","BuildAsynch":"true","IndependentSync":"false"},{"CubeKey":"RPATIENTSDEPENDSON","CubeDisplayName":"RPatientsDependsOn","NaturalGroup":"2","CustomBuildOrder":7,"NaturalBuildOrder":7,"LastModDate":"65499,50450.449183","UpdatePlan":"BuildSynch","Disabled":"false","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","DSTimeEnabled":"true","BuildAsynch":"true","IndependentSync":"false"},{"CubeKey":"RPATIENTSINHERIT","CubeDisplayName":"RPatientsInherit","NaturalGroup":"2","CustomBuildOrder":8,"NaturalBuildOrder":8,"LastModDate":"65499,50450.445844","UpdatePlan":"BuildSynch","Disabled":"false","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","DSTimeEnabled":"true","BuildAsynch":"true","IndependentSync":"false"}],"GroupName":"Group

2","IsRegistered":"true","IsValid":"true","UpdatePlan":"BuildSynch","Disabled":"false","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","BuildAsynch":"true"}],"BuildStartHour":"21","BuildStartMinute":"00","Disabled":"false","IndependentSync":"false","SerialUpdates":"false","StorageClass":"DeepSee.CubeManager.CubeRegistryDefinition","Description":"This is a sample Cube Registry for QD testing"}", "lookup": { "cubes": [ { 2, 2 ], 2, 4 ], 1, 1 ], 2, 1 ], 2, 5 ],

2, 3 ], 2, 6 ], 2, 7 ], 2, 8 ] } ], "groups": [ { "Group 1": [ 1 ], "Group 2": [ 2 ] } ] }, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/GetActiveRegistry

Builds all cubes in a registered schedule group in the order in which they are listed and returns statistics on the build process.

/Command/GetActiveRegistry

POST

None.

This endpoint is called with an empty body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Command/GetActiveRegistry For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

{ "activeRegistry": "DeepSee.CubeManager.CubeRegistryDefinition", "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/GetCubeSize

Given the name of a cube, returns the number of rows in its fact table.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeKey

Required. The logical name of the cube whose size is in question.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/GetCubeSize For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeKey":"Patients" }

{ "cubeSize": 1000, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/GetLastUpdate

Retrieves the timestamp of the most recent update for the cube.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeKey

Required. The logical name of the cube for which to retrieve the last update.

POST
https://localhost/biserver/api/deepsee/v3/sales/Command/GetLastUpdate For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeKey":"Cube1" }

{ "tSC": 1, "lastUpdate": "2020-04-30 16:58:00", "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/getSynchScheduleParameters

A convenience method that retrieves and displays the parameters of %SYS.Task.DeepSeeSynchronize.

POST

None.

This endpoint is called with an empty body.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/getSynchScheduleParameters For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

{ "synchParams": { "dailyFrequency": 1, "dailyFrequencyTime": 0, "dailyIncrement": 32, "dailyStartTime": 0 }, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/IsValidCubeSchedule

Performs validation on current cube settings.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cube

Required. The name of the cube the schedule of which to validate.

POST
https://localhost/biserver/api/deepsee/v3/sales/Command/isValidCubeSchedule For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cube":"HoleFoods Base" }

{ "isValid": 1, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/IsValidGroup

Tests if the group specified is equi valent to the union of the natural groups of its members; returns 1 if true.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

group

Required. The name of the cube group to test.

POST
https://localhost/biserver/api/deepsee/v3/samples/Command/IsValidGroup For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "groupName":"HoleFoods Base" }

{ "isValid": 1, "group": "{"Cubes":[{"CubeKey":"EXPRESSIONHOLEFOODS","CubeDisplayName":"HoleFoods Base","NaturalGroup":"2","CustomBuildOrder":1,"NaturalBuildOrder":1,"LastModDate":"65499,67761.888342","UpdatePlan":"BuildSynch","Disabled":"true","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","DSTimeEnabled":"true","BuildAsynch":"true","IndependentSync":"false"}],"GroupName":"Group

"groups": { "1": [ { "DEPENDSONHOLEFOODS": [

1 ]

} ], "2": [ { "EXPRESSIONHOLEFOODS": [

1 ]

} ], "3": [ { "HOLEFOODS": [

1 ]

}

/Command/IsValidGroup

], "4": [ { "JMD1340": [

1 ]

} ], "5": [ { "MYCUBE89212": [

1 ]

} ], "6": [ { "NEWHOLEFOODS": [

1 ]

} ], "7": [ {

1 ]

} ], "8": [ { "PREBUILTHOLEFOODS": [

1 ]

} ], "9": [ {

2 ],

5 ],

1 ],

3 ],

4 ],

6 ],

7 ],

8 ]

} ] }, "cubes": { "DEPENDSONHOLEFOODS": [

1 ],

"EXPRESSIONHOLEFOODS": [

2 ],

9, { "dependents": [ 2, { "FILTERRPATIENTS": [], "RPATIENTS": [] } ] } ],

9 ],

"HOLEFOODS": [

3 ],

"JMD1340": [

4 ],

"MYCUBE89212": [

5 ],

"NEWHOLEFOODS": [

6 ],

7 ],

"PREBUILTHOLEFOODS": [

8 ],

9, { "dependents": [ 7, { "FILTERRDOCTORS": [], "FILTERRPATIENTS": [], "RCITYRAINFALL": [], "RDOCTORS": [], "RPATIENTS": [], "RPATIENTSDEPENDSON": [], "RPATIENTSINHERIT": [] } ] } ], 9 ], 9, { "dependents": [ 3, { "RPATIENTS": [], "RPATIENTSDEPENDSON": [], "RPATIENTSINHERIT": [] } ] } ], 9 ], 9 ], 9 ] }, "buildOrders": { "1": [ 1, { "1": [ "DEPENDSONHOLEFOODS" ] } ], "2": [ 1, { "1": [ "EXPRESSIONHOLEFOODS" ] } ], "3": [ 1, { "1": [ "HOLEFOODS"

/Command/IsValidGroup

] } ], "4": [ 1, { "1": [ "JMD1340" ] } ], "5": [ 1, { "1": [ "MYCUBE89212" ] } ], "6": [ 1, { "1": [ "NEWHOLEFOODS" ] } ], "7": [ 1, { "1": [ "PATIENTS" ] } ], "8": [ 1, { "1": [ "PREBUILTHOLEFOODS" ] } ], "9": [ 8, { "1": [ "RCITIES" ], "2": [ "FILTERRDOCTORS" ], "3": [ "RCITYRAINFALL" ], "4": [ "RDOCTORS" ], "5": [ "FILTERRPATIENTS" ], "6": [ "RPATIENTS" ], "7": [ "RPATIENTSDEPENDSON" ], "8": [ "RPATIENTSINHERIT" ] } ] }, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/RepairBuild

Performs an unscheduled repair build of a registered cube.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeName

Required. The name of the cube to repair.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/RepairBuild For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeName":"Patients" }

{ "buildStats": { "buildStats_1": { "caption": "Patients", "elapsedTime": 0.494022, "errors": 0, "event": "build", "eventId": "120", "expressionTime": 0.345886, "factCount": 1000, "iKnowTime": 0, "missingReferences": 0, "status": 1 } }, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/SetActiveRegistry

Changes which cube registry is currently active.

POST

None.

This endpoint uses an empty request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Command/setActiveRegistry For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

{ }

While this API call returns an empty response, it also sets ^DeepSee.CubeManager("activeRegistry") to DeepSee.CubeManager.CubeRegistryDefinition.

For information that applies to all response objects, see Notes on the Response Objects.

/Command/SynchronizeCube

A wrapper for %DeepSee.Utils.%SynchronizeCube which records cube event information when building the cube.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeName

Required. The name of the cube to synchronize.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/SynchronizeCube For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeName":"Patients" }

{ "factsUpdated": 0, "synchronizeStats": { "caption": "Patients", "event": "synchronize", "eventId": "132", "status": 1 }, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/WriteToRegistry

Traverses a CubeManager.RegistryMap object and registers all the cubes.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeMap

Required. The name of the RegistryMap object to traverse.

POST
https://localhost/biserver/api/deepsee/v3/sales/Command/WriteToRegistry For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeMap":"Groups" }

{ "cubeMap": "{"Groups":[{"Cubes":[{"CubeKey":"EXPRESSIONHOLEFOODS","CubeDisplayName":"HoleFoods Base","NaturalGroup":"2","CustomBuildOrder":1,"NaturalBuildOrder":1,"LastModDate":"65499,67761.888342","UpdatePlan":"BuildSynch","Disabled":"true","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","DSTimeEnabled":"true","BuildAsynch":"true","IndependentSync":"false"}],"GroupName":"Group

2","IsRegistered":"true","IsValid":"true","UpdatePlan":"BuildSynch","Disabled":"true","BuildFrequency":1,"BuildTimeUnit":"Week","BuildDayOfWeek":"1","BuildDayOfMonth":1,"SynchFrequency":1,"SynchTimeUnit":"Day","BuildAsynch":"true"}],"BuildStartHour":"23","BuildStartMinute":"30","Disabled":"false","IndependentSync":"false","SerialUpdates":"true","StorageClass":"DeepSee.REST.v2.T4"}",

"status": 1, "tSC": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Config

Sets (POST), retrieves (GET), or deletes (DELETE) a user configuration which a client application can access immediately after the user authenticates, before it has received information about the specific namespaces to which the user has access. Using this API, each authenticated user can store and retrieve their own configuration. A user who holds the appropriate administrator privilege (%DeepSee_Admin:U), can delete any existing user configuration. In addition, an administrator can save a configuration with the username %DEFAULT. %DEFAULT provides the application’s default user configuration for any user who has no custom configuration sa ved.

GET, POST, or DELETE

username

Optional. To delete the configuration associated with a username, an administrator can issue a DELETE request to this endpoint with the username supplied as the subpath (for example: https://localhost/biserver/api/deepsee/v3/Config/fbar)

This endpoint uses the following properties of the request body:

USERNAME

Optional. USERNAME allows an administrator to manage configurations for other users. If the user who has made the request is not an administrator, this property is ignored. If no USERNAME is specified, Business Intelligence attempts to retrieve or modify the configuration for the current user .

CONFIG

Optional. This property is a JSON object containing custom configuration information.

POST
https://localhost/biserver/api/deepsee/v3/Config For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

Note:

All valid versions of the Business Intelligence REST API support this service.

/Config

{ "USERNAME": "%DEFAULT", "CONFIG": { "Version": 3, "Namespace": "SALES", "Last": "TransactionMap.dashboard", "CUSTOM4": "value4", "CUSTOM5": "value5", "CUSTOM6": [ "value6", "value7", "value8" ] } }

Sample Response

{ "Info": { "Application": "/api/deepsee/", "CONFIG": { "Version": 3, "Namespace": "SALES", "Last": "TransactionMap.dashboard", "CUSTOM4": "value4", "CUSTOM5": "value5", "CUSTOM6": [ "value6", "value7", "value8" ] }, "USERNAME": "%DEFAULT" }, "Result": {} }

/Data/Favorites/:folderItem

Deletes or updates a favorite for the current user.

DELETE or PUT

folderItem

Full name of the folder item being removed or added as a favorite.

The request body is ignored.

DELETE
https://localhost/biserver/api/deepsee/v3/research/Data/Favorites/Data-Driven%20Colors.dashboard For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { } }

For information that applies to all response objects, see Notes on the Response Objects.

/Data/GetDSTIME

Retrieves the last ^OBJ.DSTIME timestamp that the server processed for a given cube.

/Data/GetDSTIME

GET

sourceClass

Required. Full name of the source class of the cube.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/sales/Data/GetDSTime/HoleFoods.Transation For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Class": "HoleFoods.Transaction" }, "Result":{ "lastDSTIME": "67393,33783" } }

/Data/GetDashboard/:dashboardName

Retrieves the definition of the gi ven dashboard.

GET

dashboardName

Full name of the dashboard.

The request body is ignored.

GET
https://localhost/biserver/api/deepsee/v3/billing/Data/GetDashboard/Listing%20with%20Filters.dashboard For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "DashboardName": "Listing with Filters.dashboard" }, "Result": { "name": "Listing with Filters", "fullName": "Listing with Filters.dashboard", "description": "", "title": "", "canModify": 1, "snapTo": 1, "snapGrid": 1, "gridCols": 6 "gridRows": 10 "widgets": [ { "name": "Widget1", "type": "pivot", "subtype": "pivot", "title": "", "dataSource": "Use in Dashboards/Patients Listing.pivot", "localDataSource": "", "drillDownDataSource": "", "width": 699, "height": 690, "sidebarContent": "", "showSidebar": 0, "sidebarWidth": "", "showToolbar": 1, "showToolbarBottomBorder": 1, "showToolbarOnlyWhenMaximized": 0, "colorToolbar": "#F0F0F0", "opacityToolbar": 1, "opacity": 1, "backgroundColor": "#F0F0F0", "theme": "", "subtypeClass": "",

/Data/GetDashboard/:dashboardName

"baseMDX": "DRILLTHROUGH SELECT FROM [PATIENTS]", "controls": [ { "name": "", "action": "applyFilter", "target": "", "targetPropertyDisplay": "", "type": "auto", "location": "widget", "controlClass": "", "timeout": "", "label": "Diagnoses", "title": "", "value": "", "valueRequired": 0, "text": "", "valueList": "", "displayList": "", "size": "", "readOnly": 0, "activeWhen": "" }, { "name": "", "action": "applyFilter", "target": "", "targetPropertyDisplay": "", "type": "auto", "location": "widget", "controlClass": "", "timeout": "", "label": "Diagnoses", "title": "", "value": "", "valueRequired": 0, "text": "", "valueList": "", "displayList": "", "size": "", "readOnly": 0, "activeWhen": "" }, { "name": "", "action": "applyFilter", "target": "*", "targetPropertyDisplay": "", "type": "auto", "location": "widget", "controlClass": "", "timeout": "", "label": "Diagnoses", "title": "", "value": "", "valueRequired": 0, "text": "", "valueList": "", "displayList": "", "size": "", "readOnly": 0, "activeWhen": "" } ], "properties": { "analyzer": "0" } } ], "widgetsGeometry": [ { "name": "Widget1", "homeRow": "", "homeCol": "", "rowSpan": "", "colSpan": "", "width": 699, "height": 690,

"top": 0, "left": 0 } ] } }

/Data/GetPivot/:pivotName

Retrieves the definition of the gi ven pivot table.

GET

pivotName

Full name of the pivot table.

The request body is ignored.

GET
https://localhost/biserver/api/deepsee/v3/research/Data/GetPivot/Use%20in%20Dashboards%2FPatients%20by%20Favorite%20Color.pivot For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "PivotName": "Use in Dashboards/Patients by Favorite Color.pivot" }, "Result": { "mdx": "", "sqlRestriction": "", "cellStyle": "", "columnHeaderStyle": "", "rowHeaderStyle": "", "cellWidth": "120", "cellHeight": "22", "rowLabelSpan": 1, "columnLabelSpan": 1, "showEmptyRows": 0, "showEmptyColumns": 0, "cubeName": "Patients", "caption": "", "listing": "", "defaultListing": "", "listingRows": "", "showStatus": 1, "pageSize": "100", "colorScale": "", "rowTotals": 1, "showZebra": 0, "showRowCaption": 1, "columnTotals": 0, "columnTotalAgg": "sum", "rowTotalAgg": "sum", "rowTotalSource": "page", "measureLocation": "columns", "hideMeasures": 1, "autoExecute": 1, "previewMode": 0, "canDrillDown": 1, "dataSource": "automatic",

"baseMDX": "SELECT NON EMPTY [Measures].[%COUNT] ON 0,NON EMPTY [ColorD].[H1].[Favorite Color].Members ON 1 FROM [PATIENTS]" "userMDX": "", "rowLevels": [ { "spec": "[ColorD].[H1].[Favorite Color].Members", "key": "", "value": "", "text": "Favorite Color", "enabled": 1, "headEnabled": 0, "headCount": "", "filterEnabled": 0, "filterExpression": "", "orderEnabled": 0, "orderExpression": "", "orderDirection": "BDESC", "aggEnabled": 0, "aggFunction": "", "levelCaption": "", "levelFormat": "", "levelType": "", "aggFunctionParm": "", "drillLevel": "0", "advanced": 0, "levelStyle": "", "levelHeaderStyle": "", "levelSummary": "", "suppress8020": 0, "drilldownSpec": "", "childLevels": [] } ], "columnLevels": [ { "spec": "[Measures].[%COUNT]", "key": "", "value": "", "text": "Patient Count", "enabled": 1, "headEnabled": 0, "headCount": "", "filterEnabled": 0, "filterExpression": "", "orderEnabled": 0, "orderExpression": "", "orderDirection": "BDESC", "aggEnabled": 0, "aggFunction": "", "levelCaption": "", "levelFormat": "", "levelType": "", "aggFunctionParm": "", "drillLevel": "0", "advanced": 0, "levelStyle": "", "levelHeaderStyle": "", "levelSummary": "", "suppress8020": 0, "drilldownSpec": "", "childLevels": [] } ], "filters": [], "listingFilters": [], "drillLevels": [], "measures": [], "listingFields": [], "formatRules": [], "calculatedMembers": [] } }

/Data/GetTermList/:termList

Retrieves the definition of the gi ven term list table.

GET

termList

Full name of the term list.

The request body is ignored.

GET
https://localhost/biserver/api/deepsee/v3/sales/Data/GetTermList/Region%20Colors For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "TermList": "Region Colors" }, "Result": { "Asia": "Aqua", "Europe": "BlueViolet", "N. America": "Firebrick", "S. America": "Green" } }

/Data/KPIDrillthrough

Executes a detail listing using a compiled KPI class.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following properties of the request body:

KPI

RANGE

ITEMS

Required. Logical name of the KPI. This must be a KPI that supports detail listings; that is, it must implement the %OnGetListingSQL() callback.

Specifies the range of cells in the KPI for which you are requesting a detail listing. The value of this property should be a string with the form “startRow,startColumn,endRow,endColumn”. (Note that numbering for rows and columns should be 1-based.)

Specifies the KPI v alues of the rows for which you are requesting a detail listing, as a comma-separated list. Any comma within these values should be replaced with a backslash character (). If no property of the KPI is configured as the KPI’s value, this property can specify the series name.

SORTCOL

Specifies the number of the column by which the detail listing’ s results should be sorted. If you do not wish to sort the results, specify 0.

SORTDIR

Specifies the order by which the results should be sorted: ascending ( "ASC") or descending ("DESC").

LISTING

Name of the listing to display.

FILTERS

An array that describes the filters which should be applied to the detail listing. Each filter should correspond to a JSON object in the array. The filter object should include the follo wing properties:

name — the logical name of the filter (for e xample: [aged].[h1].[agegroup])
value — the user-specified v alue for the filter (for e xample: [0 to 29])
POST
https://localhost/biserver/api/deepsee/v3/sales/Data/KPIDrillthrough For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

/Data/KPIDrillthrough

{ "KPI": "HoleFoods/KPISQL", "ITEMS": "Donuts (dozen)", "SORTCOL": 2, "SORTDIR": "DESC", "FILTERS": [ { "name": "City", "value": "Santiago" } ] }

{ "Info": { "KPI": "HoleFoods/KPISQL", "RANGE": "", "ITEMS": "Donuts (dozen)", "SORTCOL": 2, "SORTDIR": "DESC", "LISTING": "", "FILTERS": [ { "name": "City", "value": "Santiago" } ], "TimeStamp": "2025-09-24 08:49:06", }, "Result": { "children": [ { "ID": 1978, "DateOfSale": "12/01/2025", "Product": "SKU-101" }, { "ID": 1979, "DateOfSale": "12/01/2025", "Product": "SKU-192" }, { "ID": 1980, "DateOfSale": "12/01/2025", "Product": "SKU-192" }, ...] } }

For information that applies to all response objects, see Notes on the Response Objects.

/Data/KPIExecute

Executes the query defined by a KPI.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following properties of the request body:

KPI

Required. Logical name of the KPI.

FILTERS

Optional. Array of filter objects that specify ho w the KPI is filtered. Each filter object must pro properties:

vide the following

name — a filter specification such as [aged].[h1].[age group]
value — logical name of a member of a filter , such as &[0 to 29]
POST
https://localhost/biserver/api/deepsee/v3/research/Data/KPIExecute For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "KPI": "DemoMDX", "FILTERS": [ {"name" : "[aged].[h1].[age group]","value" : "&[0 to 29]" } ] }

{ "Info": { "KpiName": "DemoMDX" }, "Result": { "Properties": [ {"name": "PatCount","caption": "PatCount","columnNo": 1}, {"name": "AvgTestScore","caption": "AvgTestScore","columnNo": 2} ], "Series": [ {"PatCount": 482,"AvgTestScore": 73.62564102564102564,"seriesName": "Cedar Falls"}, {"PatCount": 473,"AvgTestScore": 74.54089709762532982,"seriesName": "Centerville"}, {"PatCount": 454,"AvgTestScore": 73.86532951289398281,"seriesName": "Cypress"},

/Data/KPIExecute

{"PatCount": 471,"AvgTestScore": 75.69459459459459459,"seriesName": "Elm Heights"}, {"PatCount": 468,"AvgTestScore": 74.00806451612903226,"seriesName": "Juniper"}, {"PatCount": 464,"AvgTestScore": 73.71925133689839572,"seriesName": "Magnolia"}, {"PatCount": 438,"AvgTestScore": 73.76123595505617978,"seriesName": "Pine"}, {"PatCount": 464,"AvgTestScore": 75.46537396121883657,"seriesName": "Redwood"}, {"PatCount": 445,"AvgTestScore": 75.19886363636363636,"seriesName": "Spruce"} ] } }

In the response object, the Result property contains the properties Series and Properties. The Series property contains an array of objects, one for each series (or row) in the KPI. The Properties property contains an array of objects, one for each row in the KPI.

For information that applies to all response objects, see Notes on the Response Objects.

/Data/MDXCancelQuery/:queryID

Cancels a previously started query, given the ID of the query.

POST

queryID

Required. ID of the query to cancel. If you started the query with the POST /Data/MDXExecute endpoint, obtain the ID of the query from the Info.QueryID property of the response object returned by that endpoint. If you started the query with the POST /Data/PivotExecute endpoint, obtain the ID of the query from the Info.QueryID property of the response object returned by that endpoint.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Data/MDXCancelQuery/:patients||en2515296118 For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

/Data/MDXDrillthrough

Executes a detail listing.

POST

None.

This endpoint uses the following properties of the request body:

Required. MDX SELECT QUERY, preceded by either DRILLTHROUGH or DRILLFACTS.

Use DRILLTHROUGH to use a named detail listing or to retrieve fields from the source class of the cube. Use DRILLFACTS to retrieve fields from the f act table.

If the base SELECT query returns more than one cell, only the top left cell is used for the detail listing.

LISTING

Optional. Logical name of the detail listing to use. You must specify either LISTING or RETURN, but not both.

WAIT

RETURN

Optional. Specify 0 or 1 (the default). If this property is 0, the server sends partial results. If this property is 1, the server assumes the client wishes to wait for complete results before sending a response.

Optional. List of fields in the applicable table, depending on the v alue in MDX. If you specify this, the listing consists of these fields.

POST
https://localhost/biserver/api/deepsee/v3/research/Data/MDXDrillthrough For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "MDX" : "DRILLTHROUGH SELECT FROM patients WHERE AGED.60", "LISTING" : "Patient details" }

For another example:

{ "MDX" : "DRILLTHROUGH SELECT FROM patients WHERE AGED.60", "RETURN":"Age,BirthDate" }

For another example:

{ "MDX" : "DRILLFACTS SELECT FROM patients WHERE AGED.60", "RETURN":"MxAge,MxTestScore" }

{ "Info": { "Error":"", "MDXText":"DRILLTHROUGH SELECT FROM [PATIENTS] WHERE [AGED].[60]", "QueryKey":"en2156087935", "CubeKey":"PATIENTS", "QueryID":"PATIENTS||en2156087935", "Cube":"patients", "ResultsComplete":1, "Pivot":"", "QueryType":"DRILLTHROUGH", "ListingSource":"source", "ColCount":5, "RowCount":0, "Error":"", "TimeStamp":"2016-08-14 15:43:04" }, "AxesInfo": [ {"%ID":"SlicerInfo","Text":"[AGED].[60]"}, {"%ID":"AxisInfo_1","Text":"[%SEARCH]"}, {"%ID":"AxisInfo_2","Text":"[%SEARCH]"} ], "Result":{"children": [ {"PatientID":"SUBJ_100508","Age":60,"Gender":"Female","Home City":"Elm Heights","Test Score":81}, {"PatientID":"SUBJ_100539","Age":60,"Gender":"Female","Home City":"Elm Heights","Test Score":90}, {"PatientID":"SUBJ_100701","Age":60,"Gender":"Female","Home City":"Redwood","Test Score":61},

{"PatientID":"SUBJ_100829","Age":60,"Gender":"Female","Home City":"Juniper","Test Score":98},

...] } }

For information that applies to all response objects, see Notes on the Response Objects.

/Data/MDXExecute

Executes an MDX query and obtains the results.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following properties of the request body:

Required. MDX SELECT QUERY.

FILTERS

Optional. Any additional filters to add to the query . If specified, this property must be an array of strings, each of which specifies a filter v

alue.

WAIT

TIMEOUT

Optional. Timeout for waiting for query results, in seconds. The default timeout for this wait is 2 seconds less than the session’s timeout setting.

POST
https://localhost/biserver/api/deepsee/v3/research/Data/MDXExecute For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{"MDX": "SELECT aged.[age group].MEMBERS ON 0 FROM PATIENTS"}

For another example:

{"MDX": "SELECT FROM PATIENTS"}

For another example:

{"MDX": "SELECT birthd.date.members on 0 FROM PATIENTS", "WAIT":1, "TIMEOUT":30}

For another example:

{ "MDX": "SELECT FROM PATIENTS", "FILTERS": [ "[HomeD].[H1].[ZIP].&[32006]","[HomeD].[H1].[ZIP].&[32007]"], "WAIT":1, "TIMEOUT":30 }

Response for MDX Query

Note that POST /Data/PivotExecute and POST /Data/MDXUpdateResults return the same response body.

The Info.QueryID property contains the query ID, which you need as input for the POST /Data/MDXCancelQuery and POST /Data/MDXUpdateResults services. An Info.ResultsComplete property with a value of 1 indicates that the MDX query has completed. Note that if the Info.PendingResults property has a value of 1, plugins are still computing, although the rest of the query may have completed. An Info.PendingResults property with a value of 0 indicates that any plugins have finished computing.

For information that applies to all response objects, see Notes on the Response Objects.

{ "Info":{ "Error":"", "MDXText":"SELECT [AGED].[AGE GROUP].MEMBERS ON 0 FROM [PATIENTS]", "QueryKey":"en2772997983", "CubeKey":"PATIENTS", "QueryID":"PATIENTS||en2772997983", "Cube":"PATIENTS", "ResultsComplete":1, "Pivot":"", "QueryType":"SELECT", "ListingSource":"", "ColCount":3, "RowCount":0, "TimeStamp":"2016-08-14 16:05:16" }, "AxesInfo":[ {"%ID":"SlicerInfo","Text":""}, {"%ID":"AxisInfo_1","Text":"[AGED].[AGE GROUP].MEMBERS"}, {"%ID":"AxisInfo_2","Text":"[%SEARCH]"} ], "Result": { "Axes":[ {"%ID":"Axis_1","Tuples": [ {"%ID":"Tuple_1", "Members":[ {"%ID":"Member_1","Name":"0 to 29"} ], "MemberInfo": [ {"%ID":"MemberInfo_1", "nodeNo":3,"text":"0 to 29", "dimName":"AgeD", "hierName":"H1", "levelName":"Age Group", "memberKey":"0 to 29", "dimNo":2, "hierNo":1, "levelNo":2, "aggregate":"", "orSpec":""} ] }, {"%ID":"Tuple_2",...}, {"%ID":"Tuple_3",...} ], "TupleInfo":[ {"%ID":"TupleInfo_1","childSpec":"[AgeD].[H1].[Age Group].&[0 to 29].children"}, {"%ID":"TupleInfo_2","childSpec":"[AgeD].[H1].[Age Group].&[30 to 59].children"} ...], "CellData":[ {"%ID":"Cell_1","ValueLogical":418,"Format":"","ValueFormatted":"418"}, {"%ID":"Cell_2","ValueLogical":421,"Format":"","ValueFormatted":"421"},

/Data/MDXExecute

...] } }

If the response is incomplete, it includes cell data objects like the following:

{"%ID":"Cell_9","ValueLogical":"@Computing 0.00%","Format":"","ValueFormatted":"@Computing 0.00%"}

Response for MDX DRILLTHROUGH Query

{ "Info": { "TimeStamp": "2017-09-26 15:31:23", "ResultsComplete": 1, "MDXText": "DRILLTHROUGH SELECT [AGED].[AGE GROUP].[0 TO 29] ON 0 FROM [PATIENTS]", "QueryKey": "en2983351588", "CubeKey": "PATIENTS", "QueryID": "PATIENTS||en2983351588", "Cube": "PATIENTS", "Pivot": "", "QueryType": "DRILLTHROUGH", "ListingSource": "source", "ColCount": 5, "RowCount": 0 }, "AxesInfo": [ {"%ID": "SlicerInfo", "Text": ""}, {"%ID": "AxisInfo_1", "Text": "[AGED].[AGE GROUP].[0 TO 29]"}, {"%ID": "AxisInfo_2", "Text": "[%SEARCH]"} ], "Result": { "children": [ {"PatientID": "SUBJ_100786", "Age": 0, "Home City": "Centerville", "Test Score": 77}, {"PatientID": "SUBJ_100960", "Age": 0, "Home City": "Elm Heights", "Test Score": 62}, {"PatientID": "SUBJ_100977", "Age": 0, "Home City": "Elm Heights", "Test Score": 54}, ...] } }

/Data/MDXUpdateResults/:queryID

Retrieves updated results for a given query that was previously incomplete.

POST

queryID

Required. ID of the query. If you started the query with the POST /Data/MDXExecute endpoint, obtain the ID of the query from the Info.QueryID property of the response object returned by that endpoint. If you started the query with the POST /Data/PivotExecute endpoint, obtain the ID of the query from the Info.QueryID property of the response object returned by that endpoint.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/research/Data/MDXUpdateResults/:patients||en2515296118 For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

This endpoint returns the same response object as POST /Data/MDXExecute.

/Data/PivotExecute

Executes the MDX query defined by a pi vot table and obtains the results.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following properties of the request body:

PIVOT

Required. Full logical name of the pivot table, including the name of the folder that contains it.

FILTERS

Optional. Specifies an y additional filters to add to the query . If specified, this property must be an array of strings, each of which specifies a filter v

alue.

WAIT

TIMEOUT

Optional. Timeout for waiting for query results, in seconds. The default timeout for this wait is 2 seconds less than the session’s timeout setting.

VARIABLES

Optional. Specifies the v alues for any pivot variables used in the pivot table. Specify this as an array of objects. Each object must specify the name and value properties.

POST
https://localhost/biserver/api/deepsee/v3/sales/Data/PivotExecute For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "PIVOT":"Use in Dashboards/Product Info" }

For another example:

{ "PIVOT":"Pivot Variables/Commission Calculator", "VARIABLES": [{"name":"commissionpercentage", "value":15}] }

This endpoint returns the same response object as POST /Data/MDXExecute.

/Data/TestConnection

Tests the connection to the server.

None.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/samples/Data/TestConnection For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Status": "OK", "DispatchClass": "%DeepSee.REST.v3.DataServer", "NameSpace": "SAMPLES" }

/Info/Config/:application

Configures ( POST), retrieves (GET), or deletes (DELETE) a user configuration for the specified application. Using this API, each user can store their own custom configuration to a pri vate location. A user who holds the appropriate administrator privilege (%DeepSee_Admin:U) can use this API to manage configurations for other users. An administrator can specify API returns the _PUBLIC a default configuration for an application by defining a configuration for the user _PUBLIC; the configuration for an y user for whom no custom configuration is recorded.

GET, POST or DELETE

application

Required. This is the name of the application.

This endpoint uses the following properties of the request body for POST requests:

USER

ACTION

CONFIG

Optional. Used in combination with the ACTION property, the USER property allows an administrator to manage application configurations for other users, including the _PUBLIC user . If the user who has made the request is not an administrator, this property is ignored and the API updates the user’s own configuration with the contents of the CONFIG property. If no USER is specified, the requested operation is performed upon the configuration of the user who submitted the request.

Optional. Used in combination with the USER property, the ACTION property allows an administrator to manage application configurations for other users: the v alue "GET" retrieves the configuration which is currently stored for the user; "DELETE" deletes it; "POST" updates its contents with the contents of the request’s CONFIG property. (When no ACTION value is specified, "POST" is assumed as the default.) If the user who has made the request is not an administrator, this property is ignored and the API updates the user’s own configuration with the contents of the CONFIG property.

Optional. This property is a JSON object containing custom configuration information.

For a given application, one JSON configuration object may be stored per user .

POST
https://localhost/biserver/api/deepsee/v3/research/Info/Config/myapp For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

/Info/Config/:application

{ "USER": "_PUBLIC", "ACTION": "", "CONFIG": { "CUSTOM1": "value1", "CUSTOM2": "value2", "CUSTOM3": [ "value3", "value4", "value5" ] } }

Sample Response

{ "Info": { "Application": "myapp", }, "Result": {} }

/Info/Cubes

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

None.

This endpoint 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 serv er 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 serv er sends information only about cubes and subject areas based on this cube.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/Cubes For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{"BASECUBE":"patients"}

{ "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 Notes on the Response Objects.

/Info/Cubes

/Info/Dashboards

Returns information about the dashboards available in the InterSystems IRIS namespace that you access via this REST call.

None.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/Dashboards For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Error":"" }, "Result": { "Dashboards": [ {"fullName":"Basic Dashboard Demo", "name":"Basic Dashboard Demo", "lastModified":"2016-11-14 19:39:14", "itemType":"dashboard"}, {"fullName":"Custom Drilldown Spec", "name":"Custom Drilldown Spec", "lastModified":"2016-11-14 19:39:14", "itemType":"dashboard"} ...] } }

In the response object, the Result property contains a property called Dashboards, which contains an array of objects, one for each dashboard.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/DataSources/:sourceType

Returns information about the specified type of BI data sources in the InterSystems IRIS namespace that you access via this REST call.

/Info/DataSources/:sourceType

sourceType

Required. Specifies the type of data source to return information about. This is one of the following: pivot, kpi, or metric

The type metric refers to business metrics.

For the pivot type, you can use POST with a request body that limits the sources to a particular BASECUBE. See /Info/Pivots.

GET
https://localhost/biserver/api/deepsee/v3/samples/Info/DataSources/kpi For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "SourceType": "kpi" }, "Result": { "KPIs": [ { "name": "BPDiastolic", "caption": "BPDiastolic", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "BPSystolic", "caption": "BPSystolic", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "BubbleChartDemo", "caption": "BubbleChartDemo", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "CrossjoinKPI", "caption": "CrossjoinKPI", "lastModified": "2024-03-11 16:02:35", "type": "kpi"

}, { "name": "DemoDataChanges", "caption": "DemoDataChanges", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "DemoInteroperability", "caption": "DemoInteroperability", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "DemoMDX", "caption": "DemoMDX", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "DemoMDXAutoFilters", "caption": "DemoMDXAutoFilters", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "DemoSQL", "caption": "DemoSQL", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "DemoTrendLines", "caption": "DemoTrendLines", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "Ens/DeepSee/ActivityVolumeAndDurationKPI", "caption": "Activity Volume And Duration", "lastModified": "1840-12-31", "type": "kpi" }, { "name": "Holefoods Actions", "caption": "Holefoods Actions", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "Holefoods/CFO", "caption": "Holefoods/CFO", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "HoleFoods/KPISQL", "caption": "KPI SQL", "lastModified": "2024-03-11 16:02:36", "type": "kpi" }, { "name": "Holefoods/SalesAgainstTargets", "caption": "Sales against Targets", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "HoleFoodsYears", "caption": "HoleFoodsYears", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "PatientsYears", "caption": "PatientsYears", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }, { "name": "PluginDemo", "caption": "PluginDemo", "lastModified": "2024-03-11 16:02:35", "type": "kpi" }

] } }

/Info/DataSources/:sourceType

/Info/Favorites

Returns information about favorites for the current user.

GET

None.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/sales/Info/Favorites For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "User": "TestUser" }, "Result": { "Favorites": [ { "fullName": "Data-Driven Colors.dashboard", "shortName": "Data-Driven Colors", "folder": "", "tip": "Data-Driven Colors", "type": "Dashboard", "icon": "deepsee/ds2_dashboard_44.png", "addDate": "2024-03-11 20:02:35.881", "url": "_DeepSee.UserPortal.DashboardViewer.zen?DASHBOARD=Data-Driven%20Colors.dashboard" }, { "fullName": "Ens/Analytics/ActivityVolumeAndDuration.dashboard", "shortName": "Activity Volume And Duration", "folder": "Ens/Analytics", "tip": "Activity Volume And Duration", "type": "Dashboard", "icon": "deepsee/ds2_dashboard_44.png", "addDate": "2024-03-11 19:55:12.236", "url": "_DeepSee.UserPortal.DashboardViewer.zen?DASHBOARD=Ens/Analytics/ActivityVolumeAndDuration.dashboard" }, { "fullName": "Listing with Filters.dashboard", "shortName": "Listing with Filters", "folder": "", "tip": "Listing with Filters", "type": "Dashboard", "icon": "deepsee/ds2_dashboard_44.png", "addDate": "2024-03-11 20:02:35.867", "url": "_DeepSee.UserPortal.DashboardViewer.zen?DASHBOARD=Listing%20with%20Filters.dashboard" } ] } }

/Info/Favorites

In the response object, the Result property contains a property called FilterMembers, which contains an array of objects, one for each filter member . The object for a given filter member contains the follo wing properties:

description contains the text description of the member, if any
text contains the display text for the member
value contains the logical value of the member (typically the MDX key) For information that applies to all response objects, see Notes on the Response Objects.

/Info/FilterMembers/:datasource/:filterSpec

Returns information about the members of the given filter , as defined by the gi ven data source (which is either a cube or a KPI).

datasource

Required. Name of the data source. This is one of the following:

cubename — a logical cube name
cubename.cube — a logical cube name, followed by .cube
kpiname.kpi — a logical KPI name, followed by .kpi

This name can include slashes; see Use of Slashes in Cube and KPI Names.

filterSpec

Required. Filter specification.

This endpoint uses the following properties of the request body. These properties both specify filters that are applied to the data source, thus limiting the list of members returned by the endpoint.

Optional. If specified, this property is an array of objects, each of which contains the spec property (a filter specification) and the value property (value of that filter). A value property should be an MDX set expression and should use member keys.

SEARCHKEY

Optional.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/FilterMembers/:demomdx.kpi/:homed.h1.zip For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "RELATED":[ {"spec":"gend.h1.gender","value":"&[female]"} ], "SEARCHKEY":"Jan" }

/Info/FilterMembers/:datasource/:filterSpec

{ "Info": { "Error":"", "DataSource":"demomdx.cube", "DataSourceType":"cube", "Default":"", "Filter":"[HomeD].[H1].[ZIP]" }, "Result": { "FilterMembers": [ {"text":"32006","value":"&[32006]","description":""}, {"text":"32007","value":"&[32007]","description":""}, {"text":"34577","value":"&[34577]","description":""}, {"text":"36711","value":"&[36711]","description":""}, {"text":"38928","value":"&[38928]","description":""} ] } }

description contains the text description of the member, if any
text contains the display text for the member
value contains the logical value of the member (typically the MDX key) For information that applies to all response objects, see Notes on the Response Objects.

/Info/Filters/:datasource

Returns information about the filters a vailable for the given data source (which is either a cube or a KPI).

datasource

Required. Name of the data source. This is one of the following:

cubename — a logical cube name
cubename.cube — a logical cube name, followed by .cube
kpiname.kpi — a logical KPI name, followed by .kpi

This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/Filters/:aviationevents For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Error":"", "DataSource":"aviationevents.cube", "DataSourceType":"cube" }, "Result": { "Filters": [ {"caption":"Year","value":"[EventDateD].[H1].[Year]","type":"year"}, {"caption":"Month","value":"[EventDateD].[H1].[Month]","type":""}, {"caption":"Day","value":"[EventDateD].[H1].[Day]","type":""} ...] } }

In the response object, the Result property contains a property called Filters, which contains an array of objects, one for each filter . Each object has the following properties:

caption contains the display value for the filter .
type contains the filter type, if it e xists. This can be "calc" or can be the name of a time function. In other cases it is empty.
value contains the filter specification, which is the logical identifier for the filter fication, see POST /Info/FilterMembers/:datasource/:filterSpec .

. For information on the filter speci-

For information that applies to all response objects, see Notes on the Response Objects.

/Info/Filters/:datasource

/Info/KPIs

Returns information about the KPIs available in the InterSystems IRIS namespace that you access via this REST call.

None.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/samples/Info/KPIs For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Error":"" }, "Result": { "KPIs": [ {"name":"Aviation Actions","caption":"Aviation Actions","moddate":"2016-11-14 11:22:08","type":"kpi"}, {"name":"AviationTopConcepts","caption":"AviationTopConcepts","moddate":"2016-11-14 11:22:08","type":"kpi"}, {"name":"BPDiastolic","caption":"BPDiastolic","moddate":"2016-11-14 11:22:08","type":"kpi"}

...] } }

In the response object, the Result property contains a property called KPIs, which contains an array of objects, one for each KPI.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/ListingFields/:cube

Returns information about the <listingField> elements available in the InterSystems IRIS namespace that you access via this REST call.

/Info/ListingFields/:cube

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/ListingFields/:holefoods For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Error":"", "BaseCube":"holefoods" }, "Result": { "ListingFields": [ {"caption":"Channel","expression":"%EXTERNAL(Channel) Channel"}, {"caption":"City","expression":"Outlet->City"}, {"caption":"Comment","expression":"Comment"}, ...] } }

In the response object, the Result property contains a property called ListingFields, which contains an array of objects, one for each <listingField> element.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/Listings/:cube

Returns information about the detail listings available for the given cube.

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint uses the following property of the request body:

TYPE

Optional. This property can be map or table. If this property is map, the server sends information only about map listings. If this property is table, the server sends information only about non-map listings. If this property is not specified, the serv er sends information about all kinds of listings.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/Listings/:holefoods For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{"TYPE":"map"}

For another example:

{ "Info": { "Error":"", "DataSource":"holefoods", "Type":"all" }, "Result": { "Listings": [ {"name":"Custom Listing"}, {"name":"Another Sample Listing by Date", "fields":"%ID As "ID #",DateOfSale As "Sale Date"", "order":"DateOfSale,%ID", "type":"table", "source":"listingGroup", "edit":1}, {"name":"Another Sample Listing with Customer Info", "fields":"%ID,Outlet->City "Store Location",Outlet->Country->Name Country,Product->Name Product,ZipCode "Customer ZipCode",Latitude,Longitude","order":"", "type":"map", "source":"listingGroup", "edit":1},

/Info/Listings/:cube

{"name":"Customer Info", "fields":"%ID,Outlet->City "Store Location",Outlet->Country->Name Country,Product->Name Product,ZipCode "Customer ZipCode",Latitude,Longitude","order":"", "type":"map", "source":"cube", "edit":0}, ...] } }

In the response object, the Result property contains a property called Listings, which contains an array of objects, one for each detail listing.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/Measures/:cube

Returns information about the measures available to the given cube.

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint uses the following property of the request body:

SKIPCALCULATED

Optional.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/Measures/:demomdx For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Error":"", "BaseCube":"DemoMDX", "SkipCalculated":0 }, "Result": { "Measures": [ {"name":"%COUNT","caption":"%COUNT","type":"integer","hidden":0,"factName":""}, {"name":"Age","caption":"Age","type":"integer","hidden":0,"factName":"MxAge"} ...] } }

In the response object, the Result property contains a property called Measures, which contains an array of objects, one for each measure.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/Metrics

Returns information about the business metrics in the InterSystems IRIS namespace that you access via this REST call.

/Info/Metrics

GET

None.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/samples/Info/Metrics For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "SourceType": "metric" }, "Result": { "Pivots": [ { "fullName": "MyProduction.NewProduction/MyProduction.MyMetric", "name": "MyProduction.MyMetric", "lastModified": "1840-12-31", "itemType": "metric" } ] } }

/Info/NamedFilters/:cube

Returns information about the named filters a vailable to the given cube.

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/NamedFilters/:holefoods For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Error":"", "BaseCube":"holefoods" }, "Result": { "NamedFilters": [ {"name":"Sample Named Filter", "description":"", "spec":"[Product].[P1].[Product Category].&[Seafood]","cube":"HOLEFOODS"} ] } }

In the response object, the Result property contains a property called NamedFilters, which contains an array of objects, one for each named filter .

For information that applies to all response objects, see Notes on the Response Objects.

/Info/Pivots

Returns information about the pivot tables available in the InterSystems IRIS namespace that you access via this REST call.

/Info/Pivots

None.

This endpoint uses the following property of the request body:

BASECUBE

Optional. If specified, this property should equal the logical name of a cube. In this case, the serv er sends information only about pivot tables based on this cube.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/Pivots For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{"BASECUBE":"PATIENTS"}

{ "Info": { "Error":"", "BaseCube":"" }, "Result": { "Pivots": [ {"fullName":"Calculated Members/Alternative Avg Allergy Count", "name":"Alternative Avg Allergy Count", "lastModified":"2016-11-14 11:22:08", "itemType":"pivot"}, {"fullName":"Calculated Members/Average Patient Count per Decade", "name":"Average Patient Count per Decade", "lastModified":"2016-11-14 11:22:08", "itemType":"pivot"} ...] } }

In the response object, the Result property contains a property called Pivots, which contains an array of objects, one for each pivot table.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/PivotVariableDetails/:cube/:variable

Returns detailed information about the given pivot variable.

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.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/PivotVariableDetails/:holefoods/:Year For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "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.

/Info/PivotVariables/:cube

Returns information about the pivot variables available to the given cube.

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/PivotVariables/:holefoods For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Error":"", "BaseCube":"holefoods" }, "Result": { "PivotVariables": [ {"name":"CommissionPercentage", "caption":"Commission Percentage", "defValue":"0", "context":"literal", "desc":""}, {"name":"Year", "caption":"Year", "defValue":"NOW", "context":"literal", "desc":""} ] } }

In the response object, the Result property contains a property called PivotVariables, which contains an array of objects, one for each pivot variable.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/QualityMeasures/:cube

Returns information about the quality measures available to the given cube.

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/QualityMeasures/:holefoods For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Error":"", "BaseCube":"holefoods" }, "Result": { "QualityMeasures": [ {"name":"TestCatalog/TestSet/TestQM", "caption":"Sample Quality Measure", "description":""} ] } }

In the response object, the Result property contains a property called QualityMeasures, which contains an array of objects, one for each quality measure.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/TermLists

Returns information about all the term lists.

GET

None.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/TermLists For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { }, "Result": { "TermLists": [ { "name": "Patients Pivots", "caption": "Patients Pivots", "modDate": "2024-03-11 16:02:57", "type": "termlist" }, { "name": "PATIENTS ROWSPECS", "caption": "PATIENTS ROWSPECS", "modDate": "2024-03-11 16:02:57", "type": "termlist" }, { "name": "Region Colors", "caption": "Region Colors", "modDate": "2024-03-11 16:03:00", "type": "termlist" } ] } }

For information that applies to all response objects, see Notes on the Response Objects.

/Info/TestConnection

Tests the connection to the server.

None.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/samples/Info/TestConnection For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Status": "OK", "DispatchClass": "%DeepSee.REST.v3.InfoServer", "NameSpace": "SAMPLES" }

/Namespaces

Provides a JSON array that lists the namespaces which are accessible to the current user.

/Namespaces

GET

None.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/Namespaces For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

Note:

All valid versions of the Business Intelligence REST API support this service.

{ "Info": { } "Result: [ "SALES", "MARKETING" ] }

Client-Side APIs for InterSystems IRIS Business

Using Business Intelligence

1.1 Creating a Web Application

You must place your client file or files within the directory structure serv
ed by this web application.

You must specify the Dispatch Class option, which specifies ho w this web application handles REST requests. For Business Intelligence REST requests, use one of the following:

– %Api.DeepSee — Use this class if your client application must be able to connect to different namespaces. In this

case, when you connect to an InterSystems IRIS server, you must specify the namespace to use.

The system-defined web application ( /api/deepsee) uses this dispatch class.

– %DeepSee.REST.v3 — Use this class if the REST requests should be tied to a specific namespace (the namespace

for the web application).

The classes %DeepSee.REST.v2 and %DeepSee.REST.v1 are also available for use, but are documented only within the class reference.

You must configure the web application to support the method that your client application will use to authenticate user requests. By default, /api/deepsee is configured to allo w basic password authentication.

1.2 Introduction to the Business Intelligence JavaScript API

functions in this library are a wrapper for a REST-based API for Business Intelligence. (You can also use the REST API directly.)

To use this library:

Create a web application as described in the previous section.

Or use the web application /api/deepsee, which is provided as part of the installation.

In your JavaScript client code:

Include the files DeepSee.js and zenCSLM.js.

b. Create a Business Intelligence connection object. This contains information needed to connect to an InterSystems

IRIS server.

c. Create a Business Intelligence data controller object that uses the connection object.

The data controller object enables you to interact with a Business Intelligence data source, which you specify either via an MDX query or via the name of a pivot table.

Invoke other methods of the data controller object to examine the query results, to drill down or drill through, and so on.

The following subsections give the details.

1.2.1 Creating a Business Intelligence Connection

To create a Business Intelligence connection object, use code like the following:

connection = new DeepSeeConnection(username,password,host,application,namespace);

Where:

username is an InterSystems IRIS username that can access the given host.
password is the associated password.
host is the server name for the machine on which InterSystems IRIS is running.
application is the name of the web application.
namespace is the name of the namespace to access. If the web application is tied to a namespace, this argument is not needed.

1.2.2 Creating and Using a Business Intelligence Data Controller

The data controller object enables you to interact with Business Intelligence data sources. The primary interaction is as follows:

In a suitable part of the page logic (such as when the page is loaded or when a button is pressed), create a Business Intelligence data controller and execute a query.

Introduction to the Business Intelligence JavaScript API

When you create a data controller, you specify one or two callback functions to be run when data is available; finalCallbac k is required, but pendingCallback is optional.

When pending results are available, Business Intelligence calls the method specified by pendingCallback, if specified.

This method, which you write, uses the results that are available in the data controller object. The method typically draws page contents.

When the query has completed, Business Intelligence calls the method specified by finalCallbac k.

This method, which you write, uses the results that are available in the data controller object. The method typically draws page contents.

Any method that executes a query uses the system described here; see the subsections for details and examples. Other methods return data synchronously.

1.2.2.1 Creating a Business Intelligence Data Controller and Executing a Query

In a suitable part of the client code (such as within the page initialization logic), do the following:

Create a configuration object that has the follo wing properties:

connection — Specifies the name of a Business Intelligence data connector object; see the previous section.
widget — Specifies the id of the HTML element on the page that will use the data controller
type — Specifies the type of data source; use either 'MDX' or 'PIVOT'
initialMDX — Specifies an MDX SELECT query; use this if type is 'MDX'
pivotName — Specifies the logical name of a pi vot table; use this if type is 'PIVOT'
showTotals — Specifies whether to display totals. Specify either true or false

Create a data controller object with code like the following:

var dc = new DeepSeeDataController(configuration,finalCallback,pendingCallback);

Call the runQuery() method of the data controller. Or run some other method that executes a query, such as

runDrillDown() or runListing().

For example:

1.2.2.2 Using Data Returned by the Data Controller

In each case, the data controller object is passed to the function as the argument.

The following shows a partial example:

function drawChart(dataController) {

var resultSet = dataController.getCurrentData(); ... var chartDataPoint; var chartLabel; var chartData = [];

1.3 Introduction to the Business Intelligence REST API

Internally, the JavaScript API uses the Business Intelligence REST API, which you can also use directly, as follows:

Create a web application.

Or use the web application /api/deepsee, which is provided as part of the installation.

In your JavaScript client code, create and send HTTP requests to the desired target REST services.

https://data.example.com/api/deepsee/v3/sales/Info/Cubes

For example:

https://data.example.com/mycustombiapp/Info/Cubes

Note:

The client must accept JSON. The Accept header of the request must either specify application/json or not declare a format.

Examine the response objects and use as applicable.

Introduction to the Business Intelligence REST API

1.3.1 Use of Slashes in Cube and KPI Names

https://localhost/biserver/api/deepsee/v3/samples/Info/FilterMembers/:mycubename/:filterspec

Here mycubename is the logical name of a cube and filter spec is the specification for a filter pro consider this REST call with mycubes/test/test1 as the name of the cube:

vided by that cube. Now

https://localhost/biserver/api/deepsee/v3/samples/Info/FilterMembers/:mycubes/test/test1/:filterspec

1.3.2 Notes on the Response Objects

Null — This indicates that no error occurred.
An object that contains the properties ErrorCode and ErrorMessage — This object contains details about the error that you can use to determine whether and how to proceed.

If no error occurred, the response object also contains the property Result, which is an object containing the requested values.

In general, your client code should first check the Info.Error property and then determine how to proceed.

For example, a response object might look like this (with white space added for readability):

{"Info": {"Error": {"ErrorCode":"5001", "ErrorMessage":"ERROR #5001: Cannot find Subject Area: 'SampleCube'"} } }

In contrast, if no error occurred, the Info.Error property is null and the Result contains the result that you requested. For example:

DeepSee.js

This reference section provides information on the JavaScript API for InterSystems IRIS Business Intelligence. This API is provided by the file DeepSee.js.

DeepSee.js

DeepSeeConnector

Enables you to connect to Business Intelligence data sources.

This object is available in client-side JavaScript code, if that code includes DeepSee.js. See Introduction to DeepSee.js.

To create a Business Intelligence data connector object, use code like the following:

var connection = new DeepSeeConnection(username,password,host,application,namespace);

Where:

username is an InterSystems IRIS® data platform username that can access the given host.
password is the associated password.
host is the server name for the machine on which InterSystems IRIS is running.
application is the name of the web application.
namespace is the name of the namespace to access.

Properties of This Object This object provides the following properties:

username is an InterSystems IRIS username that can access the given host.
password is the associated password.
path is the base URL for the web services.

A data connector object does not provide any methods.

DeepSeeDataController

Enables you to work with a Business Intelligence data source.

This object is available in client-side JavaScript code, if that code includes DeepSee.js. See Introduction to DeepSee.js.

To create a Business Intelligence data controller object, use code like the following:

var controller = new DeepSeeDataController(configuration,finalCallback,pendingCallback);

Where:

configur ation is an object that has the following properties:

–

connection — Is a Business Intelligence data connector object.

– widget — Specifies the id of the HTML element on the page that will use the data controller

–

type — Specifies the type of data source; use either 'MDX' or 'PIVOT' (case-sensitive)

initialMDX — Specifies an MDX SELECT query; specify this property if

type is 'MDX'

pivotName — Specifies the logical name of a pi vot table; specify this property if type is 'PIVOT'

showTotals — Specifies whether to display totals; specify this property as true or false

finalCallbac k is the name of a callback function on this page
For runQuery() and other methods of this object, when the query is completed, the system invokes this function.

pendingCallback (optional) is the name of another callback function on this page.

For runQuery() and other methods of this object, when pending results are available, the system invokes this function, if this argument is supplied.

The Business Intelligence data controller object provides the following JavaScript methods:

applyFilter()

applyFilter(filterInfo)

Where filterInfo is an object that contains the filterName and filterSpec properties.

This method adds the given filter to the filters used by the data controller callback functions associated with the data controller object.

, reruns the query, and then invokes the

This method has no return value.

attachTotals()

attachTotals(rowTotals,columnTotals,reattach)

Where:

rowTotals is true or false, depending on whether you want to attach totals for the rows.

DeepSee.js

columnTotals is true or false, depending on whether you want to attach totals for the columns.
reattach is true or false, depending on whether you want to update the most recently saved state.

If reattach is true, the system updates the most recently saved state. If reattach is false, the system adds a new state object to the stack.

This method attaches totals to the data controller object and then invokes the callback functions associated with the data controller object.

This method has no return value.

getCurrentData()

Returns a Business Intelligence result set object that contains the results from the query currently defined by the data controller object. See the reference for the DeepSeeResultSet object.

getCurrentQueryText()

Returns the text of the query currently defined by the data controller object.

runDrillDown()

runDrillDown(axis, position)

Where:

axis is the number of the axis on which you want to perform the drilldown action. Specify 1 for column or 2 for rows.
position is the position (1–based) on that axis where you want to perform the drilldown action.

This method executes the given drilldown action, and then invokes the callback functions associated with the data controller object.

This method has no return value.

runListing()

runListing(startRow, startCol, endRow, endCol, listingName)

Where:

startRow and startCol are the first ro w and column number of the results for which you want a detail listing. Specify 1 for the first ro w or column.
endRow and endCol are the last row and column number for which you want a detail listing.
listingName is the logical name of a detail listing.

This method executes the given detail listing for one or more cells of the results, and then invokes the callback functions associated with the data controller object.

This method has no return value.

runQuery()

Executes the query currently defined by the data controller object. When the query is pending or completed, the system invokes the callback functions associated with the data controller object.

DeepSeeDataController

This method has no return value.

sortResults()

sortResults(axis, position, direction, sortType)

Where:

axis is the number of the axis you want to sort. Specify 1 for column or 2 for rows.
position is the position (1–based) on that axis where you want to sort.
For example, to sort by the third column, specify axis as 1 and position as 3.
direction is the direction in which to sort. Specify 1 for ascending sort or –1 or descending sort.

sortType specifies ho w to sort. If this is '' or 'numeric' (case-insensitive), numeric sorting is used. Otherwise, string sorting is used.

This method sorts the results as requested and then invokes the callback functions associated with the data controller object.

This method has no return value.

undoLastAction()

Undoes the last change and invokes the callback functions associated with the data controller object.

This method has no return value.

DeepSee.js

DeepSeeResultSet

Enables you to work with the results of a Business Intelligence query.

This object is available in client-side JavaScript code, if that code includes DeepSee.js. See Introduction to DeepSee.js.

To create a result set, call the getCurrentData() method of the data controller object.

Or use code like the following:

var resultset = new DeepSeeResultSet(connection,widget,wait,timeout);

Where:

connection — Is a Business Intelligence data connector object.
widget — Specifies the id of the HTML element on the page that will use the data controller .
wait — Boolean. If this parameter is false, the server should respond immediately. If this parameter is true, the server should not respond until the query has completed or timed out.
timeout — Specifies ho w long (in seconds) the server should wait before returning final b ut incomplete query results.

Properties of This Object The Business Intelligence result set object provides the following properties:

connection — Is a Business Intelligence data connector object.
widget — Specifies the id of the HTML element on the page that will use the data controller .
wait — Boolean. If this property is false, the server should respond immediately. If this property is true, the server should not respond until the query has completed or timed out.
timeout — Specifies ho w long (in seconds) the server should wait before returning final b ut incomplete query results.
data — Contains the query results.
pollInterval — Specifies ho w long (in milliseconds) to wait before asking the server for updates to pending results. The default is 1000.

The Business Intelligence result set object provides the following JavaScript methods:

getColumnCount()

Returns the number of columns in the result set.

getCubeName()

Returns the name of the cube currently in use.

DeepSeeResultSet

getErrorMessage()

This method returns the text of the error message contained in the response object, if any.

getOrdinalLabel()

getOrdinalLabel(axis, position)

Where:

axis is the number of the axis whose labels you want to obtain. Specify 1 for column or 2 for rows.
position is the position on that axis whose labels you want to obtain. Specify 1 for the first position on the axis.

Returns an array of strings, corresponding to the labels at the given position on the given axis.

getOrdinalValue()

getOrdinalValue(rowNo,colNo,formatted)

Where:

rowNo is the row number (1–based)
colNo is the column number (1–based) Returns the value in the given cell.

getQueryStatus()

Returns a numeric value indicating whether the query has completed. This number is 100 if the query has completed. Otherwise, this number is less than 100.

getRowCount()

Returns the number of rows in the result set.

isError()

This method returns true if the response object indicates that an error occurred. Returns false otherwise.

runMDXQuery()

runMDXQuery(mdx,finalCallback,pendingCallback,filters)

Where:

mdx is an MDX SELECT query.
finalCallbac k is the name of a callback function on this page.

DeepSee.js

pendingCallback (optional) is the name of another callback function on this page.
filter s specifies additional filters to apply to the query .

This method executes the given MDX query. When the query is pending or completed, the system invokes the given callback functions.

This method has no return value.

runMDXDrillQuery()

runMDXDrillQuery(mdx,finalCallback,pendingCallback,listing,fieldList,filters)

Where:

mdx is an MDX SELECT query.
finalCallbac k is the name of a callback function on this page.
pendingCallback (optional) is the name of another callback function on this page.
listing is the name of a detail listing.
fieldList specifies a list of listing fields. Specify either
listing or fieldList .

filter s specifies additional filters to apply to the query

This method executes the given drillthrough query. When the query is pending or completed, the system invokes the given callback functions.

This method has no return value.

runPivot()

runPivot(pivot,finalCallback,pendingCallback,filters)

Where:

pivot is the logical name of pivot table.
finalCallbac k is the name of a callback function on this page.
pendingCallback (optional) is the name of another callback function on this page.
filter s specifies additional filters to apply to the query .

This method executes the MDX query defined by the gi ven pivot table. When the query is pending or completed, the system invokes the given callback functions.

This method has no return value.

DeepSeeUtils

Provides additional methods for working with Business Intelligence.

This object is available in client-side JavaScript code, if that code includes DeepSee.js. See Introduction to DeepSee.js.

When you include DeepSee.js in your client code, the DeepSeeUtils object is automatically available.

The DeepSeeUtils object provides the following methods:

getCubeList()

getCubeList(connection,finalFunc)

Where:

connection — Is a Business Intelligence data connector object.
finalFunc — Specifies the name of the function to e xecute when results are available This method retrieves information about the available cubes. It calls the POST /Info/Cubes REST call. The response object from that call is available to the function specified by finalFunc .

getCubeListings()

getCubeListings(connection,finalFunc)

Where:

connection — Is a Business Intelligence data connector object.
cubename — Specifies the logical name of a cube.
finalFunc — Specifies the name of the function to e xecute when results are available This method retrieves information about the listings available to the given cube. It calls the POST /Info/Listings/:cube REST call. The response object from that call is available to the function specified by finalFunc .

getDashboardList()

getDashboardList(connection,finalFunc)

This method retrieves information about the available dashboards. It calls the POST /Info/Dashboards REST call. The response object from that call is available to the function specified by

finalFunc .

getErrorMessage()

getErrorMessage(data)

Where data is a response object returned by any of the Business Intelligence Business Intelligence REST services.

This method returns the text of the error message contained in that object, if any.

DeepSee.js

getFiltersForDataSource()

getFiltersForDataSource(connection,cubename,finalcallback)

Where:

connection — Is a Business Intelligence data connector object.
cubename — Specifies the logical name of a cube.
finalcallbac k — Specifies the name of the function to e xecute when results are available This method retrieves information about the available filters for the gi ven cube. It calls the POST /Info/Filters/:datasource REST call. The response object from that call is available to the function specified by finalFunc .

getMembersForFilter()

getMembersForFilter(connection,cubeName,filterSpec,finalCallback)

Where:

connection — Is a Business Intelligence data connector object.
cubename — Specifies the logical name of a cube.
filterSpec — Specifies the filter whose members you w ant to retrieve.
finalcallbac k — Specifies the name of the function to e xecute when results are available This method retrieves information about members of the given filter . It calls the POST /Info/FilterMembers/:datafinalFunc . source/:filterSpec REST call. The response object from that call is available to the function specified by getPivotList()

getPivotList(connection,finalFunc)

Where:

connection — Is a Business Intelligence data connector object.
finalFunc — Specifies the name of the function to e xecute when results are available This method retrieves information about the available pivot tables. It calls the POST /Info/Pivots REST call. The response object from that call is available to the function specified by finalFunc .

getResultsAsArray()

getResultsAsArray(data)

Where data is a response object returned by any of the Business Intelligence REST services.

This method returns an array of results from that object as follows:

If the response object contains an Result.Filters array, the method returns that array.

Otherwise, if the response object contains an Result.FilterMembers array, the method returns that array.
Otherwise, if the response object contains an Result.Listings array, the method returns that array.

Otherwise the method returns nothing.

isError()

isError(data)

Where data is a response object returned by any of the Business Intelligence REST services.

This method returns true if the response object indicates that an error occurred. Returns false otherwise.

DeepSeeUtils

/Command/Action/:cube/:action

Executes the specified KPI action defined by the action class for the gi

ven cube.

cube

action

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

Required. Name of an action defined in the <actionClass> for the gi ven cube.

GET
https://localhost/biserver/api/deepsee/v3/sales/Command/Action/holefoods/ActionA For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

{ "Info": { "CubeName": "holefoods", "Action": "ActionA" }, "Result": { "Context": { "command": "navigate:http://www.intersystems.com" } } }

/Command/BuildAllRegisteredGroups

Builds all cubes registered in the current cube registry.

/Command/BuildAllRegisteredGroups

POST

None.

This endpoint is called with an empty body.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/BuildAllRegisteredGroups For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

For information that applies to all response objects, see Notes on the Response Objects.

/Command/BuildCube

Builds the target cube, and records and reports build event information.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeName

Required. The name of the cube to be built.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/BuildCube For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeName":"Patients" }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/BuildOneRegisteredGroup

Builds all cubes in a registered cube group in the order in which they are listed and returns statistics on the build process.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

groupName

Required. The name of the cube group to be built.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/BuildOneRegisteredGroup For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "groupName":"Group 1" }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/BuildRegistryMap

Builds a map of the current state of the Cube Registry and all unregistered cubes on the system.

/Command/BuildRegistryMap

POST

None.

This endpoint is called with an empty body.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/BuildRegistryMap For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

2, 3 ], 2, 6 ], 2, 7 ], 2, 8 ] } ], "groups": [ { "Group 1": [ 1 ], "Group 2": [ 2 ] } ] }, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/GetActiveRegistry

Builds all cubes in a registered schedule group in the order in which they are listed and returns statistics on the build process.

/Command/GetActiveRegistry

POST

None.

This endpoint is called with an empty body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Command/GetActiveRegistry For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

{ "activeRegistry": "DeepSee.CubeManager.CubeRegistryDefinition", "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/GetCubeSize

Given the name of a cube, returns the number of rows in its fact table.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeKey

Required. The logical name of the cube whose size is in question.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/GetCubeSize For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeKey":"Patients" }

{ "cubeSize": 1000, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/GetLastUpdate

Retrieves the timestamp of the most recent update for the cube.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeKey

Required. The logical name of the cube for which to retrieve the last update.

POST
https://localhost/biserver/api/deepsee/v3/sales/Command/GetLastUpdate For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeKey":"Cube1" }

{ "tSC": 1, "lastUpdate": "2020-04-30 16:58:00", "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/getSynchScheduleParameters

A convenience method that retrieves and displays the parameters of %SYS.Task.DeepSeeSynchronize.

POST

None.

This endpoint is called with an empty body.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/getSynchScheduleParameters For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

{ "synchParams": { "dailyFrequency": 1, "dailyFrequencyTime": 0, "dailyIncrement": 32, "dailyStartTime": 0 }, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/IsValidCubeSchedule

Performs validation on current cube settings.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cube

Required. The name of the cube the schedule of which to validate.

POST
https://localhost/biserver/api/deepsee/v3/sales/Command/isValidCubeSchedule For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cube":"HoleFoods Base" }

{ "isValid": 1, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/IsValidGroup

Tests if the group specified is equi valent to the union of the natural groups of its members; returns 1 if true.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

group

Required. The name of the cube group to test.

POST
https://localhost/biserver/api/deepsee/v3/samples/Command/IsValidGroup For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "groupName":"HoleFoods Base" }

"groups": { "1": [ { "DEPENDSONHOLEFOODS": [

1 ]

} ], "2": [ { "EXPRESSIONHOLEFOODS": [

1 ]

} ], "3": [ { "HOLEFOODS": [

1 ]

}

/Command/IsValidGroup

], "4": [ { "JMD1340": [

1 ]

} ], "5": [ { "MYCUBE89212": [

1 ]

} ], "6": [ { "NEWHOLEFOODS": [

1 ]

} ], "7": [ {

1 ]

} ], "8": [ { "PREBUILTHOLEFOODS": [

1 ]

} ], "9": [ {

2 ],

5 ],

1 ],

3 ],

4 ],

6 ],

7 ],

8 ]

} ] }, "cubes": { "DEPENDSONHOLEFOODS": [

1 ],

"EXPRESSIONHOLEFOODS": [

2 ],

9, { "dependents": [ 2, { "FILTERRPATIENTS": [], "RPATIENTS": [] } ] } ],

9 ],

"HOLEFOODS": [

3 ],

"JMD1340": [

4 ],

"MYCUBE89212": [

5 ],

"NEWHOLEFOODS": [

6 ],

7 ],

"PREBUILTHOLEFOODS": [

8 ],

/Command/IsValidGroup

For information that applies to all response objects, see Notes on the Response Objects.

/Command/RepairBuild

Performs an unscheduled repair build of a registered cube.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeName

Required. The name of the cube to repair.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/RepairBuild For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeName":"Patients" }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/SetActiveRegistry

Changes which cube registry is currently active.

POST

None.

This endpoint uses an empty request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Command/setActiveRegistry For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{}

{ }

While this API call returns an empty response, it also sets ^DeepSee.CubeManager("activeRegistry") to DeepSee.CubeManager.CubeRegistryDefinition.

For information that applies to all response objects, see Notes on the Response Objects.

/Command/SynchronizeCube

A wrapper for %DeepSee.Utils.%SynchronizeCube which records cube event information when building the cube.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeName

Required. The name of the cube to synchronize.

POST
https://localhost/biserver/api/deepsee/v3/billing/Command/SynchronizeCube For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeName":"Patients" }

{ "factsUpdated": 0, "synchronizeStats": { "caption": "Patients", "event": "synchronize", "eventId": "132", "status": 1 }, "status": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Command/WriteToRegistry

Traverses a CubeManager.RegistryMap object and registers all the cubes.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following property of the request body:

cubeMap

Required. The name of the RegistryMap object to traverse.

POST
https://localhost/biserver/api/deepsee/v3/sales/Command/WriteToRegistry For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "cubeMap":"Groups" }

"status": 1, "tSC": 1 }

For information that applies to all response objects, see Notes on the Response Objects.

/Config

GET, POST, or DELETE

username

This endpoint uses the following properties of the request body:

USERNAME

CONFIG

Optional. This property is a JSON object containing custom configuration information.

POST
https://localhost/biserver/api/deepsee/v3/Config For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

Note:

All valid versions of the Business Intelligence REST API support this service.

/Config

{ "USERNAME": "%DEFAULT", "CONFIG": { "Version": 3, "Namespace": "SALES", "Last": "TransactionMap.dashboard", "CUSTOM4": "value4", "CUSTOM5": "value5", "CUSTOM6": [ "value6", "value7", "value8" ] } }

Sample Response

/Data/Favorites/:folderItem

Deletes or updates a favorite for the current user.

DELETE or PUT

folderItem

Full name of the folder item being removed or added as a favorite.

The request body is ignored.

DELETE
https://localhost/biserver/api/deepsee/v3/research/Data/Favorites/Data-Driven%20Colors.dashboard For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { } }

For information that applies to all response objects, see Notes on the Response Objects.

/Data/GetDSTIME

Retrieves the last ^OBJ.DSTIME timestamp that the server processed for a given cube.

/Data/GetDSTIME

GET

sourceClass

Required. Full name of the source class of the cube.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/sales/Data/GetDSTime/HoleFoods.Transation For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Class": "HoleFoods.Transaction" }, "Result":{ "lastDSTIME": "67393,33783" } }

/Data/GetDashboard/:dashboardName

Retrieves the definition of the gi ven dashboard.

GET

dashboardName

Full name of the dashboard.

The request body is ignored.

GET
https://localhost/biserver/api/deepsee/v3/billing/Data/GetDashboard/Listing%20with%20Filters.dashboard For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

/Data/GetDashboard/:dashboardName

"top": 0, "left": 0 } ] } }

/Data/GetPivot/:pivotName

Retrieves the definition of the gi ven pivot table.

GET

pivotName

Full name of the pivot table.

The request body is ignored.

GET
https://localhost/biserver/api/deepsee/v3/research/Data/GetPivot/Use%20in%20Dashboards%2FPatients%20by%20Favorite%20Color.pivot For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

/Data/GetTermList/:termList

Retrieves the definition of the gi ven term list table.

GET

termList

Full name of the term list.

The request body is ignored.

GET
https://localhost/biserver/api/deepsee/v3/sales/Data/GetTermList/Region%20Colors For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "TermList": "Region Colors" }, "Result": { "Asia": "Aqua", "Europe": "BlueViolet", "N. America": "Firebrick", "S. America": "Green" } }

/Data/KPIDrillthrough

Executes a detail listing using a compiled KPI class.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following properties of the request body:

KPI

RANGE

ITEMS

Required. Logical name of the KPI. This must be a KPI that supports detail listings; that is, it must implement the %OnGetListingSQL() callback.

SORTCOL

Specifies the number of the column by which the detail listing’ s results should be sorted. If you do not wish to sort the results, specify 0.

SORTDIR

Specifies the order by which the results should be sorted: ascending ( "ASC") or descending ("DESC").

LISTING

Name of the listing to display.

FILTERS

name — the logical name of the filter (for e xample: [aged].[h1].[agegroup])
value — the user-specified v alue for the filter (for e xample: [0 to 29])
POST
https://localhost/biserver/api/deepsee/v3/sales/Data/KPIDrillthrough For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

/Data/KPIDrillthrough

{ "KPI": "HoleFoods/KPISQL", "ITEMS": "Donuts (dozen)", "SORTCOL": 2, "SORTDIR": "DESC", "FILTERS": [ { "name": "City", "value": "Santiago" } ] }

For information that applies to all response objects, see Notes on the Response Objects.

/Data/KPIExecute

Executes the query defined by a KPI.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following properties of the request body:

KPI

Required. Logical name of the KPI.

FILTERS

Optional. Array of filter objects that specify ho w the KPI is filtered. Each filter object must pro properties:

vide the following

name — a filter specification such as [aged].[h1].[age group]
value — logical name of a member of a filter , such as &[0 to 29]
POST
https://localhost/biserver/api/deepsee/v3/research/Data/KPIExecute For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "KPI": "DemoMDX", "FILTERS": [ {"name" : "[aged].[h1].[age group]","value" : "&[0 to 29]" } ] }

/Data/KPIExecute

For information that applies to all response objects, see Notes on the Response Objects.

/Data/MDXCancelQuery/:queryID

Cancels a previously started query, given the ID of the query.

POST

queryID

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Data/MDXCancelQuery/:patients||en2515296118 For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

/Data/MDXDrillthrough

Executes a detail listing.

POST

None.

This endpoint uses the following properties of the request body:

Required. MDX SELECT QUERY, preceded by either DRILLTHROUGH or DRILLFACTS.

Use DRILLTHROUGH to use a named detail listing or to retrieve fields from the source class of the cube. Use DRILLFACTS to retrieve fields from the f act table.

If the base SELECT query returns more than one cell, only the top left cell is used for the detail listing.

LISTING

Optional. Logical name of the detail listing to use. You must specify either LISTING or RETURN, but not both.

WAIT

RETURN

Optional. List of fields in the applicable table, depending on the v alue in MDX. If you specify this, the listing consists of these fields.

POST
https://localhost/biserver/api/deepsee/v3/research/Data/MDXDrillthrough For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "MDX" : "DRILLTHROUGH SELECT FROM patients WHERE AGED.60", "LISTING" : "Patient details" }

For another example:

{ "MDX" : "DRILLTHROUGH SELECT FROM patients WHERE AGED.60", "RETURN":"Age,BirthDate" }

For another example:

{ "MDX" : "DRILLFACTS SELECT FROM patients WHERE AGED.60", "RETURN":"MxAge,MxTestScore" }

{"PatientID":"SUBJ_100829","Age":60,"Gender":"Female","Home City":"Juniper","Test Score":98},

...] } }

For information that applies to all response objects, see Notes on the Response Objects.

/Data/MDXExecute

Executes an MDX query and obtains the results.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following properties of the request body:

Required. MDX SELECT QUERY.

FILTERS

Optional. Any additional filters to add to the query . If specified, this property must be an array of strings, each of which specifies a filter v

alue.

WAIT

TIMEOUT

Optional. Timeout for waiting for query results, in seconds. The default timeout for this wait is 2 seconds less than the session’s timeout setting.

POST
https://localhost/biserver/api/deepsee/v3/research/Data/MDXExecute For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{"MDX": "SELECT aged.[age group].MEMBERS ON 0 FROM PATIENTS"}

For another example:

{"MDX": "SELECT FROM PATIENTS"}

For another example:

{"MDX": "SELECT birthd.date.members on 0 FROM PATIENTS", "WAIT":1, "TIMEOUT":30}

For another example:

{ "MDX": "SELECT FROM PATIENTS", "FILTERS": [ "[HomeD].[H1].[ZIP].&[32006]","[HomeD].[H1].[ZIP].&[32007]"], "WAIT":1, "TIMEOUT":30 }

Response for MDX Query

Note that POST /Data/PivotExecute and POST /Data/MDXUpdateResults return the same response body.

For information that applies to all response objects, see Notes on the Response Objects.

/Data/MDXExecute

...] } }

If the response is incomplete, it includes cell data objects like the following:

{"%ID":"Cell_9","ValueLogical":"@Computing 0.00%","Format":"","ValueFormatted":"@Computing 0.00%"}

Response for MDX DRILLTHROUGH Query

/Data/MDXUpdateResults/:queryID

Retrieves updated results for a given query that was previously incomplete.

POST

queryID

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/research/Data/MDXUpdateResults/:patients||en2515296118 For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

This endpoint returns the same response object as POST /Data/MDXExecute.

/Data/PivotExecute

Executes the MDX query defined by a pi vot table and obtains the results.

POST

None. Note that a request body is required; see the next heading.

This endpoint uses the following properties of the request body:

PIVOT

Required. Full logical name of the pivot table, including the name of the folder that contains it.

FILTERS

Optional. Specifies an y additional filters to add to the query . If specified, this property must be an array of strings, each of which specifies a filter v

alue.

WAIT

TIMEOUT

Optional. Timeout for waiting for query results, in seconds. The default timeout for this wait is 2 seconds less than the session’s timeout setting.

VARIABLES

Optional. Specifies the v alues for any pivot variables used in the pivot table. Specify this as an array of objects. Each object must specify the name and value properties.

POST
https://localhost/biserver/api/deepsee/v3/sales/Data/PivotExecute For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "PIVOT":"Use in Dashboards/Product Info" }

For another example:

{ "PIVOT":"Pivot Variables/Commission Calculator", "VARIABLES": [{"name":"commissionpercentage", "value":15}] }

This endpoint returns the same response object as POST /Data/MDXExecute.

/Data/TestConnection

Tests the connection to the server.

None.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/samples/Data/TestConnection For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Status": "OK", "DispatchClass": "%DeepSee.REST.v3.DataServer", "NameSpace": "SAMPLES" }

/Info/Config/:application

GET, POST or DELETE

application

Required. This is the name of the application.

This endpoint uses the following properties of the request body for POST requests:

USER

ACTION

CONFIG

Optional. This property is a JSON object containing custom configuration information.

For a given application, one JSON configuration object may be stored per user .

POST
https://localhost/biserver/api/deepsee/v3/research/Info/Config/myapp For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

/Info/Config/:application

{ "USER": "_PUBLIC", "ACTION": "", "CONFIG": { "CUSTOM1": "value1", "CUSTOM2": "value2", "CUSTOM3": [ "value3", "value4", "value5" ] } }

Sample Response

{ "Info": { "Application": "myapp", }, "Result": {} }

/Info/Cubes

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

None.

This endpoint uses the following properties of the request body:

TYPE

BASECUBE

Optional. If specified, this property should equal the logical name of a cube. In this case, the serv er sends information only about cubes and subject areas based on this cube.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/Cubes For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{"BASECUBE":"patients"}

For information that applies to all response objects, see Notes on the Response Objects.

/Info/Cubes

/Info/Dashboards

Returns information about the dashboards available in the InterSystems IRIS namespace that you access via this REST call.

None.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/Dashboards For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

In the response object, the Result property contains a property called Dashboards, which contains an array of objects, one for each dashboard.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/DataSources/:sourceType

Returns information about the specified type of BI data sources in the InterSystems IRIS namespace that you access via this REST call.

/Info/DataSources/:sourceType

sourceType

Required. Specifies the type of data source to return information about. This is one of the following: pivot, kpi, or metric

The type metric refers to business metrics.

For the pivot type, you can use POST with a request body that limits the sources to a particular BASECUBE. See /Info/Pivots.

GET
https://localhost/biserver/api/deepsee/v3/samples/Info/DataSources/kpi For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

] } }

/Info/DataSources/:sourceType

/Info/Favorites

Returns information about favorites for the current user.

GET

None.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/sales/Info/Favorites For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

/Info/Favorites

description contains the text description of the member, if any
text contains the display text for the member
value contains the logical value of the member (typically the MDX key) For information that applies to all response objects, see Notes on the Response Objects.

/Info/FilterMembers/:datasource/:filterSpec

Returns information about the members of the given filter , as defined by the gi ven data source (which is either a cube or a KPI).

datasource

Required. Name of the data source. This is one of the following:

cubename — a logical cube name
cubename.cube — a logical cube name, followed by .cube
kpiname.kpi — a logical KPI name, followed by .kpi

This name can include slashes; see Use of Slashes in Cube and KPI Names.

filterSpec

Required. Filter specification.

This endpoint uses the following properties of the request body. These properties both specify filters that are applied to the data source, thus limiting the list of members returned by the endpoint.

SEARCHKEY

Optional.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/FilterMembers/:demomdx.kpi/:homed.h1.zip For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{ "RELATED":[ {"spec":"gend.h1.gender","value":"&[female]"} ], "SEARCHKEY":"Jan" }

/Info/FilterMembers/:datasource/:filterSpec

description contains the text description of the member, if any
text contains the display text for the member
value contains the logical value of the member (typically the MDX key) For information that applies to all response objects, see Notes on the Response Objects.

/Info/Filters/:datasource

Returns information about the filters a vailable for the given data source (which is either a cube or a KPI).

datasource

Required. Name of the data source. This is one of the following:

cubename — a logical cube name
cubename.cube — a logical cube name, followed by .cube
kpiname.kpi — a logical KPI name, followed by .kpi

This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/Filters/:aviationevents For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

In the response object, the Result property contains a property called Filters, which contains an array of objects, one for each filter . Each object has the following properties:

caption contains the display value for the filter .
type contains the filter type, if it e xists. This can be "calc" or can be the name of a time function. In other cases it is empty.
value contains the filter specification, which is the logical identifier for the filter fication, see POST /Info/FilterMembers/:datasource/:filterSpec .

. For information on the filter speci-

For information that applies to all response objects, see Notes on the Response Objects.

/Info/Filters/:datasource

/Info/KPIs

Returns information about the KPIs available in the InterSystems IRIS namespace that you access via this REST call.

None.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/samples/Info/KPIs For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

...] } }

In the response object, the Result property contains a property called KPIs, which contains an array of objects, one for each KPI.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/ListingFields/:cube

Returns information about the <listingField> elements available in the InterSystems IRIS namespace that you access via this REST call.

/Info/ListingFields/:cube

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/ListingFields/:holefoods For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

In the response object, the Result property contains a property called ListingFields, which contains an array of objects, one for each <listingField> element.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/Listings/:cube

Returns information about the detail listings available for the given cube.

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint uses the following property of the request body:

TYPE

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/Listings/:holefoods For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{"TYPE":"map"}

For another example:

/Info/Listings/:cube

In the response object, the Result property contains a property called Listings, which contains an array of objects, one for each detail listing.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/Measures/:cube

Returns information about the measures available to the given cube.

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint uses the following property of the request body:

SKIPCALCULATED

Optional.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/Measures/:demomdx For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Error":"", "BaseCube":"DemoMDX", "SkipCalculated":0 }, "Result": { "Measures": [ {"name":"%COUNT","caption":"%COUNT","type":"integer","hidden":0,"factName":""}, {"name":"Age","caption":"Age","type":"integer","hidden":0,"factName":"MxAge"} ...] } }

In the response object, the Result property contains a property called Measures, which contains an array of objects, one for each measure.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/Metrics

Returns information about the business metrics in the InterSystems IRIS namespace that you access via this REST call.

/Info/Metrics

GET

None.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/samples/Info/Metrics For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

/Info/NamedFilters/:cube

Returns information about the named filters a vailable to the given cube.

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/NamedFilters/:holefoods For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

In the response object, the Result property contains a property called NamedFilters, which contains an array of objects, one for each named filter .

For information that applies to all response objects, see Notes on the Response Objects.

/Info/Pivots

Returns information about the pivot tables available in the InterSystems IRIS namespace that you access via this REST call.

/Info/Pivots

None.

This endpoint uses the following property of the request body:

BASECUBE

Optional. If specified, this property should equal the logical name of a cube. In this case, the serv er sends information only about pivot tables based on this cube.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/Pivots For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
{"BASECUBE":"PATIENTS"}

In the response object, the Result property contains a property called Pivots, which contains an array of objects, one for each pivot table.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/PivotVariableDetails/:cube/:variable

Returns detailed information about the given pivot variable.

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.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/PivotVariableDetails/:holefoods/:Year For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

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.

/Info/PivotVariables/:cube

Returns information about the pivot variables available to the given cube.

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/PivotVariables/:holefoods For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

In the response object, the Result property contains a property called PivotVariables, which contains an array of objects, one for each pivot variable.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/QualityMeasures/:cube

Returns information about the quality measures available to the given cube.

cube

Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/sales/Info/QualityMeasures/:holefoods For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Info": { "Error":"", "BaseCube":"holefoods" }, "Result": { "QualityMeasures": [ {"name":"TestCatalog/TestSet/TestQM", "caption":"Sample Quality Measure", "description":""} ] } }

In the response object, the Result property contains a property called QualityMeasures, which contains an array of objects, one for each quality measure.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/TermLists

Returns information about all the term lists.

GET

None.

This endpoint ignores the request body.

POST
https://localhost/biserver/api/deepsee/v3/research/Info/TermLists For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

For information that applies to all response objects, see Notes on the Response Objects.

/Info/TestConnection

Tests the connection to the server.

None.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/samples/Info/TestConnection For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

{ "Status": "OK", "DispatchClass": "%DeepSee.REST.v3.InfoServer", "NameSpace": "SAMPLES" }

/Namespaces

Provides a JSON array that lists the namespaces which are accessible to the current user.

/Namespaces

GET

None.

This endpoint ignores the request body.

GET
https://localhost/biserver/api/deepsee/v3/Namespaces For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

Note:

All valid versions of the Business Intelligence REST API support this service.

{ "Info": { } "Result: [ "SALES", "MARKETING" ] }

Adoption

sorodriguezz/skills/client-side-apis-for-intersystems-iris-business-intelligence

$ install --global

Security Scan Results

SKILL.md

Client-Side APIs for InterSystems IRIS Business

1.1 Creating a Web Application

1.2 Introduction to the Business Intelligence JavaScript API

1.2.1 Creating a Business Intelligence Connection

1.2.2 Creating and Using a Business Intelligence Data Controller

1.2.2.1 Creating a Business Intelligence Data Controller and Executing a Query

1.2.2.2 Using Data Returned by the Data Controller

1.3 Introduction to the Business Intelligence REST API

1.3.1 Use of Slashes in Cube and KPI Names

1.3.2 Notes on the Response Objects

1 ]

1 ]

1 ]

1 ]

1 ]

1 ]

1 ]

1 ]

2 ],

5 ],

1 ],

3 ],

4 ],

6 ],

7 ],

8 ]

1 ],

2 ],

9 ],

3 ],

4 ],

5 ],

6 ],

7 ],

8 ],

Related Skills

sorodriguezz/skills/xdbc-gateway

sorodriguezz/skills/windows-installation-guide

sorodriguezz/skills/windows-installation-details

sorodriguezz/skills/web-gateway-guide

sorodriguezz/skills/client-side-apis-for-intersystems-iris-business-intelligence

$ install --global

Security Scan Results

SKILL.md

Client-Side APIs for InterSystems IRIS Business

1.1 Creating a Web Application

1.2 Introduction to the Business Intelligence JavaScript API

1.2.1 Creating a Business Intelligence Connection

1.2.2 Creating and Using a Business Intelligence Data Controller

1.2.2.1 Creating a Business Intelligence Data Controller and Executing a Query

1.2.2.2 Using Data Returned by the Data Controller

1.3 Introduction to the Business Intelligence REST API

1.3.1 Use of Slashes in Cube and KPI Names

1.3.2 Notes on the Response Objects

1 ]

1 ]

1 ]

1 ]

1 ]

1 ]

1 ]

1 ]

2 ],

5 ],

1 ],

3 ],

4 ],

6 ],

7 ],

8 ]

1 ],

2 ],

9 ],

3 ],

4 ],