Query parameters

Regardless of whether the query is submitted using HTTP Request or the SOAP service, the query interface supports the following parameters.

Parameter

Description

favoritename

Name of the favorite including path, e.g., My Favorites/Test favorite

favoritefolder

Defines whether the favorite specified using favoritename is a private or shared favorite. Valid values: FAVORITES_SHARED FAVORITES_PRIVATE.

Default value: FAVORITES_SHARED

language
(optional)

The language in which the data is to be supplied, e.g., EN.

Unless specified, data is output in the language in which the PPM server was started.

Filter list in the form of key value pairs
(optional)

Specifies additional filters (key value pairs), linked to the filters set in the favorite with AND. For example: TIME=2008

filterfavoritename
(optional)

The filters set in the specified favorite are linked with the specified filter list with AND.

filterfavoritefolder
(optional)

Defines whether the favorite specified using filterfavorite is a private or shared favorite. Valid values: FAVORITES_SHARED FAVORITES_PRIVATE.

Default value: FAVORITES_SHARED