Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ElastiCubes

Metadata
Status
colourBlue
titleGET
/elasticubes/metadata
Expand
titleReturns a list of ElastiCubes with metadata, including the ElastiCube name, ElastiCube ID, the server address (URL), and the database name.

Parameters

ParameterDescriptionData Type
q

A query that returns all ElastiCubes beginning with the value. For example, a value of 'sa' will return ElastiCubes called 'Sample Ecommerce', 'Sample Lead generation' etc.

string
sortByThe order in which the ElastiCubes appear in the response (natural, title, lastupdatetime, createtime)string

Check property types

Code Block
titleResponse
 [
  {
    "title": "string",
    "id": "ObjectId",
    "address": "string",
    "database": "string"
  }
]

Properties

PropertyDescription
titleThe name of the ElastiCube.
idThe ID of the ElastiCube.
addressThe ElastiCube server address
databaseThe name of the database

Error Status Codes

HTTP Status CodeReason
403forbidden
Status
colourBlue
titleGET
/elasticubes/metadata/{elasticube}
Expand
titleReturns metadata for an ElastiCube by ElastiCube name. Metadata includes the ElastiCube name, ElasticCube ID, server address, and database name.

 

Status
colourBlue
titleGET

/elasticubes/metadata/{elasticube}/fields

 
Status
colourBlue
titleGET

/elasticubes/{elasticube}/Sql

 
Status
colourBlue
titleGET
/elasticubes/ 
Status
colourBlue
titleGET
/elasticubes/servers 
Status
colourBlue
titleGET
/elasticubes/servers/{server} 
Status
colourBlue
titleGET
/elasticubes/servers/{server}/simple 
Status
colourBlue
titleGET
/elasticubes/servers/{server}/status 
Status
colourBlue
titleGET
/elasticubes/{server}/{elasticube}/datasecurity 
Status
colourBlue
titleGET
/elasticubes/{server}/{cube}/{user}/datasecurity 
Status
colourBlue
titleGET
/elasticubes/{server}/{elasticube}/datasecurity/{table}/{column} 
Status
colourBlue
titleGET
/elasticubes/{server}/{elasticube}/permissions 
Actions
Status
colourGreen
titlepost
/elasticubes/{server}/{elasticube}/startStart the ElastiCube Server
Status
colourGreen
titlepost
/elasticubes/{server}/{elasticube}/stopStop the ElastiCube Server
Status
colourGreen
titlepost
/elasticubes/{server}/{elasticube}/restart 
Status
colourGreen
titlepost
/elasticubes/{server}/{elasticube}/startBuild 
Status
colourGreen
titlepost
/elasticubes/{server}/{elasticube}/stopBuild 
Status
colourGreen
titlepost
/elasticubes/{elasticube}/jaql 
Status
colourGreen
titlepost
/elasticubes/{server}/{elasticube}/datasecurity 
Status
colourGreen
titlepost
/elasticubes/datasecurity 
Status
colourGreen
titlepost
/elasticubes/{server}/{elasticube}/permissions 
Status
colourYellow
titlePUT
/elasticubes/{server}/{elasticube}/permissions 
Status
colourYellow
titlePUT
/elasticubes/server/{server}/permissions 
Status
colourRed
titleDELETE
/elasticubes/{server}/{elasticube}/datasecurity/{table}/{column} 
Status
colourRed
titleDELETE
/elasticubes/{server}/{elasticube}/permissions 

Users

Metadata
Status
colourBlue
titleGET
/usersReturns all users and related metadata.
Status
colourBlue
titleGET
/users/ad

Searches for users in Active Directory. This function does not search for users in the Sisense repository.

Status
colourBlue
titleGET
/users/allDirectories 
Status
colourBlue
titleGET
/users/count 
Status
colourBlue
titleGET
/users/{user} 
Status
colourBlue
titleGET
/users/loggedin 
Actions
Status
colourGreen
titlepost
/users/simulate 
Status
colourGreen
titlepost
/users 
Status
colourGreen
titlepost
/users/ad 
Status
colourGreen
titlepost
/users/forgetpassword 
Status
colourGreen
titlepost
/users/activate/{user} 
Status
colourGreen
titlepost
/users/recoverpassword/{user} 
Status
colourGreen
titlepost
/users/delete 
Status
colourGreen
titlepost
/users/validate 
Status
colourYellow
titlePUT
/users/{user} 
Status
colourRed
titleDELETE
/users/{user} 

Groups

Status
colourBlue
titleGET
/groups 
Status
colourBlue
titleGET
/groups/ad 
Status
colourBlue
titleGET
/groups/allDirectories 
Status
colourBlue
titleGET
/groups/{group} 
Status
colourBlue
titleGET
/groups/{group}/users 
Actions
Status
colourGreen
titlepost
/groups/byIds 
Status
colourGreen
titlepost
/groups 
Status
colourGreen
titlepost
/groups/ad 
Status
colourGreen
titlepost
/groups/{group}/users 
Status
colourGreen
titlepost
/groups/validateName 
Status
colourYellow
titlePUT
/groups/{group} 
Status
colourRed
titleDELETE
/groups 
Status
colourRed
titleDELETE
/groups/{group} 
Status
colourRed
titleDELETE
/groups/{group}/users 

Authorization

Status
colourBlue
titleGET
/auth/isauth 
Status
colourBlue
titleGET
/auth/logout 

Branding

Metadata
Status
colourBlue
titleGET
/branding 
Actions
   
Status
colourGreen
titlepost
/branding 
Status
colourRed
titleDELETE
/branding 

 

 

Table of Contents
maxLevel2

...