Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/cell/export] >

request url

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

short description

Exports values of cube cells

long description

Note that the last line of the result differs from the description below. The line contains two doubles. The first describes progress of the export, the second the maximal number of exported cells not including the condition. In order to provide a progress bar, take the quotient of the first and second integer as float. This will yield a number between 0.0 and 1.0 describing the progress.

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.
blocksize	integer	Maximal number of cells to export (default is 1000)
path	path	Comma separated list of element identifiers. Begin export after the path (default is to start with the first path)
name_path	npath	Comma separated list of element names. Begin export after the path (default is to start with the first path). Used only if path parameter is omitted.
area	area	Comma separated list of element identifiers lists. Each element identifiers list is colon separated. The area is the cartesian product. Default is the complete cube area.
name_area	narea	Comma separated list of element names lists. Each element names list is colon separated. The area is the cartesian product. Default is the complete cube area. Used only if database area is omitted.
condition	string	Condition on the value of numeric or string cells (default is no condition). A condition starts with >, >=, <, <=, ==, or != and is followed by a double or a string. Two condition can be combined by and, or, xor. If you specify a string value, the value has to be csv encoded. Do not forget to URL encode the complete condition string.
use_rules	boolean	If 1, then export rule based cell values (default is 0). Rule-based cell values of numeric type are extracted, even if the "type" parameter is set to 2 (only string). Rule-based cell values of string type are extracted, even if the Cell Types setting is set to 1 (only numeric).
base_only	boolean	If 1, then export only base cells (default is 0)
skip_empty	integer	0 - all cells, 1 - skip empty, 2 - skip empty, zero and empty string (default is 1)
type	integer	Type of exported cells. 0=numeric and string, 1=only numeric, 2=only string (default is 0)
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.
show_rule	boolean	If 1, then additional information about the cell value is returned, in case the value originates from an enterprise rule.

result

#	name	type	description
0	type	integer	Type of the value (1=NUMERIC, 2=STRING, 99=ERROR)
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	property_values	double/string	Values of specified cell properties.

examples

description

Exports cells from cube.

further information