Jedox OLAP documentation

home > API > [/cell/replace_estimate] >
request url https://[SERVER]:[PORT]/cell/replace_estimate[?PARAMETER1=value[&...]]
short description Returns an estimation of the number of affected cells. No writing is performed.
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.
value double/string The numeric or string value of the cube cell. Do not forget to URL encode string values.
add boolean Used only when mode is 0. If 0 (default), then a numeric value given is stored in the cube. If 1, then a numeric value given is added to the existing value or set if no value currently exists. Setting add to 1, requires splash type 0 or 1.
splash integer Used only when mode is 0. Optional splash type for setting values if the comma separated list of elements contains consolidated elements.
(0=no splashing, 1=default, 2=add to base cells, 3=set to base cells)
use_rules boolean Used only when mode is 1. If 1, then copy, like and predict commands write rule based cell values (default is 0).
mode integer If 0 (default) the value is written to the cube.
If 1 then the value is checked to see if it contains a command (#, ##, !, !!, ?, copy, like, predict, from, to, hold), which is then executed. If the value does not contain a command then it is written to the cube as in mode 0.
locked_paths path Optional colon separated list of paths. Each path is a comma separated list of element identifiers. Splashing will not change locked paths and sources areas of these paths if they are consolidated.
event_processor boolean If 1 (the default), then setting a new value will possibly call the supervision event processor. If 0, then the supervision event processor is circumvented. Note that you need extra permissions to use this feature.
show_splash_threshold boolean If 1 return also splash_threshold (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 cell_count double Number of affected cells
1 splash_threshold double Splash threshold
examples
description
Estimates the number of affected cells of "set value of cell path "1,1,1,8,1,1" to value "123.00" (default splash)" operation.
further information