Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/rule/create] >

request url

http://[SERVER]:[PORT]/rule/create[?PARAMETER1=value[&...]]

short description

Creates a new enterprise rule for a cube

long description

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.
definition	string	Urlencoded enterprise rule
activate	integer	create active rule with "1" (default) or a not active rule with "0"
external_identifier	string	Urlencoded external identifier
comment	string	Urlencoded comment
use_identifier	boolean	Use identifier in textual representation of the ACTIVE rule in the result. The definition can use name or identifier independent of the parameter. Default is 0.
position	double	Optional position of the rule in the list of cube rules. By default(0) the rule gets position of last rule +1
sid	string	Session identifier for a server connection. Use the /server/login request to get a valid session identifier.
source	string	Urlencoded query definition for template rules. Empty for regular rules.
ip_protection	boolean	If 1 rules is marked as prepared form IP protection. Default is 0.
show_protection	boolean	If 1 return also IP protection info. Default is 0.

result

#	name	type	description
0	ip_protection	identifier	0 - not protected, 1 - will be protected, 2 - protected
1	lic_id	identifier	License id for ip protected rules.
2	rule	identifier	Identifier of the rule
3	rule_string	string	Textual representation for the rule
4	external_identifier	string	external identifier of the rule
5	comment	string	comment for the rule
6	timestamp	string	creation time of the rule in seconds since 1970-01-01
7	active	integer	0=rule is not active, 1=rule is active
8	position	double	Position of the rule within list of cube rules
9	query	string	Query definition for template rules. Empty for regular rules.
10	template_rule	identifier	Identifier of template rule defining this instance. Empty for regular rules.

examples

description

further information