Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/cube/holds] >

request url

https://[SERVER]:[PORT]/cube/holds[?PARAMETER1=value[&...]]

short description

Lists holds of a cube

long description

Lists holds of a cube. If 'path' or 'name_path' is specified then only holds containing this cell are returned.

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 (default is an empty list).
name_path	npath	Comma separated list of element names. Used only if path parameter is omitted (default is an empty list).
blocksize	integer	Maximal number of listed holds (default is 1000).
hold	identifier	Hold identifier. List of holds starts with the next hold (default is to start with the first hold).
sid	string	Session identifier for a server connection. Use the /server/login request to get a valid session identifier.

result

#	name	type	description
0	hold	identifier	Identifier of the hold.
1	area	area	Comma separated list of element identifiers lists. Each element identifiers list is colon separated. The area is the cartesian product.
2	user	string	The name of the user who created the hold.
3	timestamp	string	creation time of the hold in seconds since 1970-01-01.

examples

description

further information