| home > API > [/cell/area] > |
| request url |
https://[SERVER]:[PORT]/cell/area[?PARAMETER1=value[&...]] |
| short description |
Shows values of cube cells |
| long description |
The default aggregation function for consolidated cells is SUM. The type of aggregation can be changed by 'function' parameter. In such case the usage of 'expand' parameter is mandatory. |
| 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. |
| area |
area |
Comma separated list of element identifier lists. Identifier lists are separated by colons. The area is the cartesian product. |
| name_area |
narea |
Comma separated list of element name lists. Name lists are separated by colons. The area is the cartesian product. Used only if area parameter is omitted. |
| function |
integer |
Optional aggregation function.
(1=AVG, 2=COUNT, 3=MAX, 4=MIN, 5=MEDIAN) |
| expand |
integer |
Comma separated list of expand functions.
(1=SELF, 2=CHILDREN, 4=LEAVES) |
| show_rule |
boolean |
If 1, then additional information about the cell value is returned, in case the value originates from an enterprise rule. |
| show_lock_info |
boolean |
If 1, then additional information about the cell lock is returned. |
| properties |
identifier |
Comma separated list of cell property ids. |
| sid |
string |
Session identifier for a server connection. Use the /server/login request to get a valid session identifier. |
|
| result |
| # |
name |
type |
description |
| 0 |
type |
integer |
Type of the value (1=NUMERIC, 2=STRING) |
| 1 |
exists |
boolean |
1 if value exists |
| 2 |
value |
double/string |
Value of the cell |
| 3 |
path |
path |
Comma separated list of element identifiers (path of cube cell) |
| 4 |
rule |
identifier |
Identifier of the rule, this cell values originates from or empty. Only available if show_rule is 1. |
| 5 |
lock_info |
identifier |
Lock info (0 - cell is not locked, 1 - cell is locked by user which sent request, 2 - cell is locked by another user). Only available if show_lock_info is 1. |
| 6 |
property_values |
double/string |
Values of specified cell properties. |
|
| examples |
|
| further information |
|