Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/cube/info] >

request url

https://[SERVER]:[PORT]/cube/info[?PARAMETER1=value[&...]]

short description

Shows cube data

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.
cube	identifier	Identifier of the cube
name_cube	string	Name of the cube. Used only if cube parameter is omitted.
show_permission	boolean	If 1 then additional information about the user's permission on cube is returned (optional, default is 0)
show_counters	boolean	If 1 then the cube's load time and memory size are returned (optional, default is 0)
wait	boolean	If 1 then waits until all write operations of the session are processed (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_zero	boolean	If 1 then store_zero_flag, zero_count and empty_string_count are returned (optional, default is 0)
mode	integer	If 1 only info about cube performance is returned (optional, default is 0)
timeout	integer	Timeout in seconds. Affects only mode 1. (optional, default 0)
show_virtual	boolean	If 1 return also the list of identifiers of virtual attribute dimensions' source dimensions (optional, default is 0)
show_data_token	boolean	If 1 return also data_token (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	identifier	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	load_time	double	Load time of the cube in seconds
11	memory_size	integer	Size of memory in bytes
12	gpu_flag	boolean	1 if cube is on GPU
13	audit_days	integer	The minimum number of days to store audit entries for the cube. 0 if audit disabled for whole server.
14	store_zero_flag	boolean	1 if cube can contain zeros and empty strings
15	zero_count	integer	Number of zeros in the cube
16	empty_string_count	integer	Number of empty strings in the cube
17	source_dimensions	identifier	Comma separated list of identifiers of virtual attribute dimensions' source dimensions
18	data_token	integer	Data token. Changed by every write operation.

examples

description

further information