Jedox OLAP documentation

home > API > [/delta/values] >
request url https://[SERVER]:[PORT]/delta/values[?PARAMETER1=value[&...]]
short description Exports cell values for delta synchronization.
long description The request exports cell values from the last delta calculation result set. Based on mode parameter the recalculation can happen before the retrieval. If no recalculation is requested then previous result is used (such as retrieving next page).
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. Used only with mode=1.
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. Used only with mode=1.
mode integer If 1, then recalculate new delta prior retrieval of the values.
use_rules boolean If 1, then calculate and export rule based cell values (default is 0). Used only with mode=1. Applied only when the delta area is created for the first time; ignored on subsequent recalculates.
external_identifier string Custom identifier to be paired with the area stream in case multiple areas per cube would be active (default is empty string).
max_cache integer Maximum number of filled cell values allowed in the delta area (0 means use default: 1% of cache barrier). If provided, overrides the default limit. Used only when the area is created for the first time; ignored on subsequent recalculates.
time_to_live integer Time to live in minutes for the delta area (0 means no limit, area can live forever). If omitted, the server uses the value from palo.ini (DeltaValues time_to_live). Used only when the area is created for the first time; ignored on subsequent recalculates.
sid string Session identifier for a server connection. Use the /server/login request to get a valid session identifier.
result
# name type description
0 type integer Type of the filled value (1=NUMERIC, 2=STRING, 99=ERROR), numeric for empty
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)
examples
description
Recalculates and retrieves new set of delta changes for given area.
further information