Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/rule/parse] >

request url

https://[SERVER]:[PORT]/rule/parse[?PARAMETER1=value[&...]]

short description

Parse an enterprise rule

long description

Parse a definition of an enterprise rule. You can either supply a database and a cube or a list of functions. If you supply a database and a cube then the areas are validated against the cube and the allowed functions are the standard functions. If you supply a list of functions than no validation of the areas are performed and only functions and operators from the given list are allowed.

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.
rule	identifier	Optional Identifier of the rule using CONTINUE() or 4294967294 for STET() reference. Used by calculation tracker.
functions	string	List of function names
definition	string	Urlencoded enterprise rule
use_identifier	boolean	Use identifier in textual representation of the rule in the result. The definition can use name or identifier independent of the parameter. Default is 0.
path	path	Comma separated list of element identifiers (database or name_database has to be specified) the rule calculation is evaluated for
name_path	npath	Comma separated list of element names (database or name_database has to be specified) the rule calculation is evaluated for
sid	string	Session identifier for a server connection. Use the /server/login request to get a valid session identifier.

result

#	name	type	description
0	xml_rule	string	XML representation of the enterprise rule.

examples

description

Simple Rule

further information