home > API > [/cell/value] > |
request url |
https://[SERVER]:[PORT]/cell/value[?PARAMETER1=value[&...]] |
short description |
Shows the value of a cube cell |
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. |
path |
path |
Comma separated list of element identifiers |
name_path |
npath |
Comma separated list of element names. Used only if path parameter is omitted. |
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. |
use_default_write |
boolean |
If 1 (default 0) default write element is used for omitted dimensions instead of default read element. |
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 |
rule |
identifier |
Identifier of the rule, this cell values originates from or empty. Only available if show_rule is 1. |
4 |
lock_info |
identifier |
Lock info (0 - cell is not locked, 1 - cell is locked by user wich sent request, 2 - cell is locked by another user). Only available if show_lock_info is 1. |
5 |
property_values |
double/string |
Values of specified cell properties. |
|
examples |
description |
Show value of cell path "0,0,2,3,0,0" of cube "0" |
Show value of cell path "0,0,0,0,0,0" of cube "0" |
|
further information |
|