Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/rule/info] >

request url

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

short description

Returns information about a defined rule.

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 shown
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.
show_protection	boolean	If 1 return also IP protection info. Default is 0.
sid	string	Session identifier for a server connection. Use the /server/login request to get a valid session identifier.

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

further information