Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/database/cubes] >

request url

https://[SERVER]:[PORT]/database/cubes[?PARAMETER1=value[&...]]

short description

Returns the list of cubes.

long description

parameters

name	type	description
database	identifier	Identifier of the database
name_database	string	Name of the database. Used only if database parameter is omitted.
show_normal	identifier	Show cubes of type normal (0=do not show normal cubes, 1=show (default))
show_system	identifier	Show cubes of type system (0=do not show system cubes (default), 1=show)
show_attribute	identifier	Show cubes of type attribute (0=do not show attribute cubes (default), 1=show)
show_info	identifier	Show cubes of type user info (0=do not show user info cubes (default), 1=show)
show_permission	boolean	If 1 then additional information about the user's permission on cube is returned (optional, default is 0)
show_gpuflag	boolean	If 1 return also gpu_flag (optional, default is 0)
show_audit	boolean	If 1 return also audit_days (optional, default is 0)
show_virtual	boolean	If 1 then number_dimensions and dimensions contain also virtual attribute dimensions (optional, default is 0)
sid	string	Session identifier for a server connection. Use the /server/login request to get a valid session identifier.

result

#	name	type	description
0	cube	identifier	Identifier of the cube
1	name_cube	string	Name of the cube
2	number_dimensions	integer	Number of dimensions
3	dimensions	integer	Comma separated list of dimension identifiers
4	number_cells	double	Total number of cells
5	number_filled_cells	integer	Number of filled numeric base cells plus number of filled string cells
6	status	integer	Status of cube (0=unloaded, 1=loaded and 2=changed)
7	type	integer	Type of cube (0=normal, 1=system, 2=attribute, 3=user info)
8	cube_token	integer	The cube token of the cube
9	permission	string	User's permission on cube, maximum over all groups/roles ("N", "R", "W", "D")
10	gpu_flag	boolean	1 if cube is on GPU
11	audit_days	integer	The minimum number of days to store audit entries for the cube. 0 if audit disabled for whole server.

examples

description

further information