Qibates REST API (v2)

Download OpenAPI specification:Download

QiBates Support: qibates.support@quartz-insight.com

Introduction

This API is documented in OpenAPI format. The REST API of Qibates (also known as QiBates REST API) allows third-party applications to navigate through the data made accessible by QiBates connectors. This documentation describes each endpoint of the Qibates REST API.

REST API Authentication

To use the REST API, the users need an API key authenticated with Google or Microsoft using OAuth protocol.

Generate an API key

This REST API endpoint redirects you to a Google or Microsoft Authentication page, and generates your REST API key authenticated to your profile. Each QiBates API key is mapped to an "API key name" you have to specify in the endpoint.

Responses

List your API keys

This REST API endpoint lists all the API keys QiBates related to your account.

Responses

Delete an API key

This REST API endpoint deletes your REST API key mapped the "API key name" specified in the endpoint.

Responses

Common Actions

login to ESSBASE - SSAS - PLANNING - PBCS connector

This API endpoint is used to log in to ESSBASE - SSAS - PLANNING - PBCS connector using a provided username, password and provider address. The user must be authenticated before it can perform any further actions within the application. Provider address for each connector:

ESSBASE : "https://yourdomain.com/aps/JAPI"
PLANNING : "https://yourdomain.com/HyperionPlanning/SmartView"
PBCS : "https://yourdomain.com/HyperionPlanning/SmartView"
ESSBASE-STDLN ( essbase 21C ) : "https://yourdomain.com/essbase/japi"
SSAS : "https://yourdomain.com/aps/JAPI"

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas planning essbase-stndln pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

User credential to access a connector

username	string
password	string
providerAddress	string

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"username": "string",
"password": "string",
"providerAddress": "string"
}

login to PBCS connector

This API endpoint is used to log in to PBCS connector using a provided username, password, and provider address. The user must be authenticated before they can perform any further actions within the application.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas planning essbase-stndln pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

User credential to access a connector

username	string
password	string
providerAddress	string

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"username": "string",
"password": "string",
"providerAddress": "string"
}

list servers

Gets the list of the available servers

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas planning essbase-stndln pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

The unique identifier of the session

loginid

string

session loginid

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string"
}

list applications

Returns a list of all the applications available under the specified server.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas planning essbase-stndln pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
sort	boolean Optional flag to indicate whether to sort the list of applications alphabetically. Default value is true.

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"sort": true
}

logout

Ends the current session and logs the user out.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas planning essbase-stndln pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

The unique identifier of the session

loginid

string

session loginid

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string"
}

ESSBASE and SSAS Actions

list cubes

Returns a list of all the cubes linked to the specified server and application.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string"
}

list dimensions

Returns a list of all the dimensions within the cube.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string"
}

show dimension tree

Returns the members of the dimension requested and displayed as a tree structure

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string",
"action": {"dimension": "string"
}
}

list filtered members

Returns a filtered list of the members under a specific dimension

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string",
"action": {"dimension": "string",
"filter": "string",
"arg1": 0
}
}

list scripts

Returns a list of all the scripts within the cube.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string"
}

launch script

Runs a script.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"action": {"script": "string"
}
}

list alias tables

Returns a list of all the alias tables within the cube.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string"
}

refresh grid

Refreshes the grid.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request
	object
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string",
"action": {"grid": [["string"
]
],
"rangesToDelete": [{"startRow": 0,
"startCol": 0,
"rows": 0,
"columns": 0
}
],
"codeAliasParam": {"displayCodeAndAlias": true,
"hasCodeAndAlias": true
}
},
"settings": {"missingSuppression": true,
"missingLabel": "string",
"locale": "string",
"navigateWithoutData": "string",
"withoutIndentation": true
}
}

adhoc grid

Initiates the grid with a given N-dimension array.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request
	object
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string",
"action": {"grid": [["string"
]
],
"rangesToDelete": [{"startRow": 0,
"startCol": 0,
"rows": 0,
"columns": 0
}
],
"codeAliasParam": {"displayCodeAndAlias": true,
"hasCodeAndAlias": true
}
},
"settings": {"missingSuppression": true,
"missingLabel": "string",
"locale": "string",
"navigateWithoutData": "string",
"withoutIndentation": true
}
}

submit grid

Submits the grid.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request
	object
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string",
"action": {"grid": [["string"
]
],
"rangesToDelete": [{"startRow": 0,
"startCol": 0,
"rows": 0,
"columns": 0
}
],
"codeAliasParam": {"displayCodeAndAlias": true,
"hasCodeAndAlias": true
}
},
"settings": {"missingSuppression": true,
"missingLabel": "string",
"locale": "string",
"navigateWithoutData": "string",
"withoutIndentation": true
}
}

zoomin action

Triggers action Zoom In on at least 1 cell.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request
	object
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string",
"action": {"grid": [["string"
]
],
"preferences": "string",
"cells": [{"row": 0,
"column": 0
}
],
"rangesToDelete": [{"startRow": 0,
"startCol": 0,
"rows": 0,
"columns": 0
}
],
"codeAliasParam": {"displayCodeAndAlias": true,
"hasCodeAndAlias": true
}
},
"settings": {"missingSuppression": true,
"missingLabel": "string",
"locale": "string",
"navigateWithoutData": "string",
"withoutIndentation": true
}
}

zoomout action

Triggers action Zoom Out on at least 1 cell.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request
	object
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string",
"action": {"grid": [["string"
]
],
"cells": [{"row": 0,
"column": 0
}
],
"rangesToDelete": [{"startRow": 0,
"startCol": 0,
"rows": 0,
"columns": 0
}
],
"codeAliasParam": {"displayCodeAndAlias": true,
"hasCodeAndAlias": true
}
},
"settings": {"missingSuppression": true,
"missingLabel": "string",
"locale": "string",
"navigateWithoutData": "string",
"withoutIndentation": true
}
}

keeponly action

Triggers action Keep Only on at least 1 cell.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request
	object
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string",
"action": {"grid": [["string"
]
],
"cells": [{"row": 0,
"column": 0
}
],
"rangesToDelete": [{"startRow": 0,
"startCol": 0,
"rows": 0,
"columns": 0
}
],
"codeAliasParam": {"displayCodeAndAlias": true,
"hasCodeAndAlias": true
}
},
"settings": {"missingSuppression": true,
"missingLabel": "string",
"locale": "string",
"navigateWithoutData": "string",
"withoutIndentation": true
}
}

removeonly action

Triigers action Remove Only on at least 1 cell.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request
	object
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string",
"action": {"grid": [["string"
]
],
"cells": [{"row": 0,
"column": 0
}
],
"rangesToDelete": [{"startRow": 0,
"startCol": 0,
"rows": 0,
"columns": 0
}
],
"codeAliasParam": {"displayCodeAndAlias": true,
"hasCodeAndAlias": true
}
},
"settings": {"missingSuppression": true,
"missingLabel": "string",
"locale": "string",
"navigateWithoutData": "string",
"withoutIndentation": true
}
}

pivot action

Triggers action Pivot on at least 1 cell.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request
	object
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string",
"action": {"grid": [["string"
]
],
"row": 0,
"column": 0,
"rangesToDelete": [{"startRow": 0,
"startCol": 0,
"rows": 0,
"columns": 0
}
],
"codeAliasParam": {"displayCodeAndAlias": true,
"hasCodeAndAlias": true
}
},
"settings": {"missingSuppression": true,
"missingLabel": "string",
"locale": "string",
"navigateWithoutData": "string",
"withoutIndentation": true
}
}

pivotToPOV action

Triggers action pivotToPOV on at least 1 cell. It means dimension in row or column set back to POV section.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : essbase ssas essbase-stndln
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
aliastable	string aliastable used for the request
	object
	object

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"aliastable": "string",
"action": {"grid": [["string"
]
],
"row": 0,
"column": 0,
"rangesToDelete": [{"startRow": 0,
"startCol": 0,
"rows": 0,
"columns": 0
}
],
"codeAliasParam": {"displayCodeAndAlias": true,
"hasCodeAndAlias": true
}
},
"settings": {"missingSuppression": true,
"missingLabel": "string",
"locale": "string",
"navigateWithoutData": "string",
"withoutIndentation": true
}
}

PLANNING and PBCS Actions

list forms

Lists forms available in Planning or PBCS applications.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
folder	string folder used for the request

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"folder": "string"
}

open form

Opens a regular or composite form.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
folder	string folder used for the request
formName	string form used for the request
type	string Supported values are: regular or composite
	object
	object
	Array of objects (Optional) Only used when type is composite

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"folder": "string",
"formName": "string",
"type": "string",
"preferences": {"missingColSuppression": true,
"missingRowSuppression": true,
"missingLabel": "string",
"locale": "string"
},
"pov": {"property1": "string",
"property2": "string"
},
"subForms": [{"folder": "string",
"formname": "string",
"pov": {"property1": "string",
"property2": "string"
}
}
]
}

submit form

Submits a form.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
folder	string folder used for the request
formName	string form used for the request
type	string Supported values are: regular or composite
	object
	object
grid	Array of strings[ items ]
code	Array of strings[ items ]
	Array of objects
enableLargeCellSubmit	boolean When this setting is set to true, the user can set value of a cell to more than 255 characters but only the first 255 characters will be submitted. The default value is false.

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"folder": "string",
"formName": "string",
"type": "string",
"preferences": {"missingColSuppression": true,
"missingRowSuppression": true,
"missingLabel": "string",
"locale": "string"
},
"pov": {"property1": "string",
"property2": "string"
},
"grid": [["string"
]
],
"code": [["string"
]
],
"prompts": [{"ruleinfo": {"ruleName": "string",
"cube": "string",
"ruleType": "string"
},
"prompts": [{"name": "string",
"value": "string"
}
]
}
],
"enableLargeCellSubmit": true
}

lists tasks

Lists tasks.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string"
}

list onsave rules

Lists rules prompts used before trying to submit the grid linked to.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
folder	string folder used for the request
form	string form used for the request

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"folder": "string",
"form": "string"
}

set task status

Modifies the status of a specific task.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
taskListID	string
taskID	string
complete	boolean

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"taskListID": "string",
"taskID": "string",
"complete": true
}

list aliastables

Lists all alias tables related to a cube.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string"
}

set aliastable

Sets a chosen alias table for the given application.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
aliasId	string

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"aliasId": "string"
}

enum prompt

Enumerates all prompts related to a rule. A prompt is a set of at least 1 value given by the end user when trying to trigger the rule.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
ruleName	string
ruleType	string

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"ruleName": "string",
"ruleType": "string"
}

launch rule

Triggers the given rule.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
cube	string cube used for the request
ruleName	string
ruleType	string
	Array of objects

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"cube": "string",
"ruleName": "string",
"ruleType": "string",
"prompts": [{"name": "string",
"value": "string"
}
]
}

enum filters

Enumerates all filters.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
dim	string
aliastable	string aliastable used for the request

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"dim": "string",
"aliastable": "string"
}

enum members

Enumerates all members given the filter on a chose dimension.

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
dim	string
arg	string
aliastable	string aliastable used for the request
filter	string Hierarchy Substitution Descendants Children Children Inclusive Siblings Siblings Inclusive Parents Ancestors Inclusive Level 0 Descendants
cube	string cube used for the request

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"dim": "string",
"arg": "string",
"aliastable": "string",
"filter": "string",
"cube": "string"
}

enum members rule

enummembersrule

header Parameters

connector required	string Example: essbase The connector used for the request. Supported values are : planning pbcs
qibateskey required	string The QiBates key : The QiBates key is used tu authenticate the user and authorize him to use the API REST Qibates You can get your API key through this website https://qibates-api.quartz-insight.com/qibates/api/v2/generatekey/{keyname}

Request Body schema: application/json

loginid	string session loginid
server	string server used for the request
application	string application used for the request
aliastable	string aliastable used for the request
cube	string cube used for the request
ruleName	string
promptName	string

Responses

Request samples

Payload
HTTP
Google Apps Script

Content type

application/json

{"loginid": "string",
"server": "string",
"application": "string",
"aliastable": "string",
"cube": "string",
"ruleName": "string",
"promptName": "string"
}