Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/cell/replace_bulk] >

request url

https://[SERVER]:[PORT]/cell/replace_bulk[?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 bulk can only be executed within a transaction block started with push_rule/begin and ended with push_rule/end when used within a worker.

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.
paths	path	Colon separated list of paths. Each path is a comma separated list of element identifiers.
name_paths	npath	Colon separated list of paths. Each path is a comma separated list of element names. Used only if paths parameter is omitted.
values	double/string	Colon separated list of values. Each value is the new numeric or string value for the cell corresponding to the above path. If you specify a string value, the value has to be csv encoded.
add	boolean	If 0 (the 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 mode 0 or 1.
splash	integer	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)
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.
mode	integer	If 1 use add_array, splash_array, locked_paths_array, event_processor_array instead of add, splash, locked_paths, event_processor, always wait and return values of the changed cells.
add_array	boolean	Comma separated list of add parameters for each cell (mode 1)
splash_array	integer	Comma separated list of splash parameters for each cell (mode 1)
locked_paths_array	path	Semicolon separated list of locked_paths parameters for each cell (mode 1)
event_processor_array	boolean	Comma separated list of event_processor parameters for each cell (mode 1)
use_audit	boolean	If audit is enabled for the cube, save all performed bulk operations to it (default false)

result

#	name	type	description
0	OK	boolean	"1" means OK (mode 0)
1	type	integer	Type of the value (1=NUMERIC, 2=STRING, 99=ERROR) (mode 1)
2	exists/error	integer	1 if value exists. In case of an error the error code. (mode 1)
3	value	double/string	Value of the cell. In case of an error the error message (mode 1)
4	rule	identifier	Identifier of the rule, this cell values originates from or empty. Only available if show_rule is 1. (mode 1)
5	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. (mode 1)
6	property_values	double/string	Values of specified cell properties. (mode 1)

examples

description

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

further information