Jedox OLAP documentation

home > API > [/dimension/elements] >
request url https://[SERVER]:[PORT]/dimension/elements[?PARAMETER1=value[&...]]
short description Shows all elements of a dimension
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.
parent identifier Identifier of parent for element filtering or empty parameter for root elements. Root elements includes children of hidden elements. (no filter by default)
limit identifier Optional comma delimited offset of first element returned (0-default) and maximal count of returned element (all elements by default)
element identifier Element identifier. If it's specified, server goes from limit start and finds block that contains this element. Actual start is returned before the list of elements.
show_permission boolean If 1 then additional information about the user's permission on element is returned (optional, default is 0)
squash_list boolean If 1 then children and parents list are shortened to intervals (1-10) and weights are shortened to weight:count
sid string Session identifier for a server connection. Use the /server/login request to get a valid session identifier.
result
# name type description
0 element identifier Identifier of the element
1 name_element string Name of the element
2 position integer Position of the element
3 level integer Level of the element
4 indent integer Indent of the element
5 depth integer Depth of the element
6 type integer Type of the element (1=NUMERIC, 2=STRING, 4=CONSOLIDATED)
7 number_parents integer Number of parents
8 parents identifier Comma separated list of parent identifiers
9 number_children integer Number of children
10 children identifier Comma separated list of children identifiers
11 weights double Comma separated list of children weights
12 permission string User's permission on element, maximum over all groups/roles ("N", "R", "W", "D")
examples
description
Show elements of dimension "0" of database "1"
Show first 10 root elements of dimension "0"
Show first 5 child elements of element "7" in dimension "0"
further information