QPR Knowledge Base

Parameters and Options

Hide Navigation Pane

Parameters and Options

Previous topic Next topic No expanding text in this topic  

Parameters and Options

Previous topic Next topic JavaScript is required for expanding text Mail us feedback on this topic!  

Comments (...)

This section lists parameters and options commonly available for QPR Web Service query functions.

 

 

Global Parameters

These parameters are supported by all query functions:

 

Criteria=<query criteria (e.g. "Find(\"of\", name)")>

An expression that must return true for an element in order for it to be returned in the result set. Supported expressions include:

Logical operators: AND, OR, NOT. Note that these are case sensitive, so only the uppercase versions work.
Binary comparison operators: =, <>, <, <=, >, >=
Mathematical operators: +, -, *, /, ^
String constants using double quotes: “string constant”
Parentheses to group expressions and enforce calculation order: ()
Find function:
oExpression: Find(<what>, <attribute>)
Parameters:
<what> = Text to match (usually a string constant). Case sensitive.
<attribute> = A supported attribute.
oReturn value: True if the text is found in the given attribute.

 

Note: String constants must be escaped correctly (by preceding the double quotes with a backslash).

 

CriteriaRoot

Set containing the object (must have only one object) which is used as root object for the criteria function described in criteria-parameter. All the attributes referenced in the criteria are attributes of this criteriaroot. @_ can be used in criteria function to refer to the object for which the criteria is currently being evaluated. E.g. the following function call returns a set containing all the periods for which measure's (in @measure) ACT series has value lower than 118:

@measure = [SC.1.487];

@periodlevel = @measure.periodlevel;

@periodlevel.periods(criteriaroot="@measure", criteria="Measure.Value(period=\"@_\", series=\"ACT\") < 118");

 

ExcludeInaccessible=<0 | 1>

If this is set to 1, all objects the user does not have access rights to are removed from the result set. The default value is 0. Note: The only supported functions for inaccessible objects are "Related", "ParentObjects" and "ChildObjects".

 

 

Recursion Parameters

Parameters supported by all operations that may bring new elements into the set (not supported e.g. in filter functions).

 

Recursive=1

Enable recursion (disabled by default).

 

recursioncount=<number of recursions>

Set the maximum recursion depth (infinite by default).

keeporiginals=1

Ensure that all the objects in the original set are also in the result set.

 

 

Supported Options

These options are supported in all queries where applicable.

 

EnumAsNumber=<0 | 1>

Configures how enumerated types are shown in object query results. If set to 1, numbers are used instead of strings (e.g. the publishtype attribute for actions is an enumerated type). The default value is 0.

 

QueryModelingLanguage=<language code>

Sets the PG modeling language used when processing query and criteria phases of QueryObjects and QueryObjectsAsXml. In the case this option is defined without defining QueryLanguage, the QueryLanguage value is determined based on the UI language assigned for the modeling language provided here.

 

QueryLanguage=<UI language>

Sets the user interface language used when processing query- and criteria-phases of QueryObjects and QueryObjectsAsXml.

 

The following options are available also for GetGraph and GetBinaryData functions:

 

ModelingLanguage=<language code>

Sets the PG modeling language used when processing sort and result generation phases of QueryObjects and QueryObjectsAsXml. In the case this option is defined without defining Language, the Language value is determined based on the UI language assigned for the modeling language provided here.

 

Language=<UI language>

Sets the user interface language used when processing sort and result generation phases of QueryObjects and QueryObjectsAsXml.

 

<language code>

Language code given for modeling language in PG language properties dialog.

 

<UI language>

Language code defined in ISO639-standard (e.g. en=english, fi=finnish...). Can optionally be followed by a comma-separated sub language identifier (e.g. "en,1").

 

 

 

Comments (...)