Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/cell/replace] >

request url

https://[SERVER]:[PORT]/cell/replace[?PARAMETER1=value[&...]]

short description

Sets or changes the value of cube cell

long description

The server calculates the list of all base element for a numeric path, which contains one or more consolidate element. The given value will be distributed among these base paths using the following method:

no splashing: will result in an error message
default:
- value = 0.0:
  clear all base paths
- value <> 0.0 and old_value = 0.0:
  compute the splash value according to the weights of the path and set this value to all base paths.
- value <> 0.0 and old_value <> 0.0:
  scale all value so that the sum is the new value.
add: add given value to all base paths
set: set all base paths to the given value

Note that a cell replace might not get executed immediately if a push rule is active. In this case the function will block until the push rule has finished.

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, 4=set to populated base cells, 5=add to populated 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).
check_threshold	boolean	Used only when mode is 1. If 1, then the number of empty cells into which a value can be written during the # and ## commands is limited by the splash-threshold (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.
wait	boolean	If 1 then waits until the asynchronous part of operation is finished (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	OK	boolean	"1" means OK

examples

description

Set value of cell path "1,1,1,1,1,1" to value "123.00" (default splash)

further information