Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/dimension/info] >

request url

http://[SERVER]:[PORT]/dimension/info[?PARAMETER1=value[&...]]

short description

Returns dimension information.

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.
dimension	identifier	Identifier of the dimension
name_dimension	string	Name of the dimension. Used only if dimension parameter is omitted.
show_permission	boolean	If 1 then additional information about the user's permission on dimension is returned (optional, default is 0)
show_counters	boolean	If 1 then the dimension's load time and memory size are returned (optional, default is 0)
show_default_elements	boolean	If 1 then additional information about default read, default write, default parent, total and NA elements are returned (optional, default is 0)
show_count_by_type	boolean	If 1 then additional information about count of N, C and S elements returned (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	dimension	identifier	Identifier of the dimension
1	name_dimension	string	Name of the dimension
2	number_elements	integer	Number of elements
3	maximum_level	integer	Maximum level of the dimension
4	maximum_indent	integer	Maximum indent of the dimension
5	maximum_depth	integer	Maximum depth of the dimension
6	type	integer	Type of dimension (0=normal, 1=system, 2=attribute, 3=user info, 4=system id)
7	attributes_dimension	identifier	Identifier of the attributes dimension of a normal dimension or the identifier of the normal dimension associated to a attributes dimension.
8	attributes_cube	identifier	Identifier of the attributes cube. (only for normal dimensions)
9	rights_cube	identifier	Identifier of the rights cube. (only for normal dimensions)
10	dimension_token	integer	The dimension token of the dimension
11	permission	string	User's permission on dimension, maximum over all groups/roles ("N", "R", "W", "D")
12	load_time	double	Load time of the dimension in seconds
13	memory_size	intenger	Size of memory in bytes
14	default_read_element	identifier	Identifier of the default read element
15	default_write_element	identifier	Identifier of the default write element
16	default_parent_element	identifier	Identifier of the default parent element
17	total_element	identifier	Identifier of the total element
18	NA_element	identifier	Identifier of the NA element
19	count_n	integer	Count of N elements
20	count_c	integer	Count of C elements
21	count_s	integer	Count of S elements

examples

description

further information