Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/database/dimensions] >

request url

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

short description

Returns the list of dimensions.

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 dimensions of type normal (0=do not show normal dimensions, 1=show (default))
show_system	identifier	Show dimensions of type system (0=do not show system dimensions (default), 1=show)
show_attribute	identifier	Show dimensions of type attribute (0=do not show attribute dimensions (default), 1=show)
show_info	identifier	Show dimensions of type user info (0=do not show user info dimensions (default), 1=show)
show_virtual_attribute	identifier	Show dimensions of type virtual attribute (0=do not show virtual attribute dimensions (default), 1=show).
show_virtual	boolean	If 1 then the identifier of the dimension's source dimension and a list of derived virtual attribute dimensions' identifiers are returned (optional, default is 0)
show_permission	boolean	If 1 then additional information about the user's permission on dimension is returned (optional, default is 0)
name_element	string	Return only dimensions containing specified element
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)
cube	identifier	Cube identifier. Return only dimensions of this cube.
name_cube	string	Cube name. Return only dimensions of this cube. Used only if cube parameter is omitted.
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, 5=virtual attribute)
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	source_dimension	identifier	Identifier of the source dimension of a virtual attribute dimension
12	virtual_dimensions	identifier	Comma separated list of identifiers of virtual attribute dimensions derived from the dimension
13	source_attribute_id	identifier	Identifier of the source attribute of a virtual attribute dimension
14	source_attribute_name	string	Name of the source attribute of a virtual attribute dimension
15	permission	string	User's permission on dimension, maximum over all groups/roles ("N", "R", "W", "D")
16	default_read_element	identifier	Identifier of the default read element
17	default_write_element	identifier	Identifier of the default write element
18	default_parent_element	identifier	Identifier of the default parent element
19	total_element	identifier	Identifier of the total element
20	NA_element	identifier	Identifier of the NA element
21	count_n	integer	Count of N elements
22	count_c	integer	Count of C elements
23	count_s	integer	Count of S elements

examples

description

List the dimensions of database "1"

List the system dimensions of database "1"

List the attribute dimensions of database "1"

further information