Jedox OLAP documentation

home > API > [/rule/modify] >
request url https://[SERVER]:[PORT]/rule/modify[?PARAMETER1=value[&...]]
short description Modifies an enterprise rule for a cube. Use the parameter "definition" for changing the rule or use the parameter "activate" for activating and deactivating.
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.
rule identifier Comma separated list of rule identifiers to be modified. If definition is specified, only first rule is modified!
definition string Urlencoded enterprise rule
activate integer activate rule with "1", deactivate rule with "0" or toggle rule active state with "2"
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 the position stays unchanged. If multiple rules are specified in parameter 'rule' all these rules will get new position. First rule from the list get position 'position', second gets 'position'+1 etc.
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 rule identifier Identifier of the rule
1 rule_string string Textual representation for the rule
2 external_identifier string external identifier of the rule
3 comment string comment for the rule
4 timestamp string creation time of the rule in seconds since 1970-01-01
5 active integer 0=rule is not active, 1=rule is active
6 position double Position of the rule within list of cube rules
7 query string Query definition for template rules. Empty for regular rules.
8 template_rule identifier Identifier of template rule defining this instance. Empty for regular rules.
9 ip_protection identifier 0 - not protected, 1 - will be protected, 2 - protected
10 lic_id identifier License id for ip protected rules.
examples
description
Modify rule 0: Budget = Variance - 2 * Actual
Toggle active state of rules 0,1 and 2. Active rules are deactivated and vice versa.
Set new position of rules 0,2 and 1. Rule 0 gets position 100, rule 2 gets position 200 and rule 1 position 300.
further information