The executeDomainQuery operation takes these parameters:
| • | domainUri - a string containing the path to the Domain on the server, for example /domains/John/ExpenseDomain. |
| • | queryStr - a string containing the Domain query composed of fields and a filter expression (see below for the syntax). |
| • | localeStr - a string giving the user locale, for example en, en_US, or es_ES_Traditional_WIN. |
| • | dateFormatStr - a string giving the date format desired in date fields, for example MM/dd/yyyy or h:mm a. |
|  | Be sure the format has date and time portions if you expect to have both date and time fields, for example yyyy.MM.dd G 'at' HH:mm:ss z |
The query string is composed of the following elements that create a syntax for the Domain query:
| • | <query> - encapsulates the whole query. |
| • | <queryFields> - contains a sequence of <queryField> elements. The order of fields will be preserved in the results. |
| • | <queryField id="<fullyQualifiedID>" /> - an empty element where <fullyQualifiedID> gives the unique identifier of an item you want to appear as a column in the results. The identifier must be fully qualified, which means it includes the identifiers of the set and super-sets to which the item belongs. The fully qualified identifier is similar to the path of the item in the Domain, using a period (.) to separate each set identifier. |
| • | <queryFilterString> - the filter string for the query uses an application-specific syntax called Domain Expression Language (DomEL). |
The following example shows a filter string that must match two values:
Note that when the query string appears in the SOAP example below, special characters such as < and > are converted to their corresponding character entities, < and > respectively.
The executeDomainQuery operation returns results in the following objects:
| • | ResultSetData. Encapsulates the results of the Domain query. It contains column names and rows of data: |
| • | names. Array of column names in the result set. These names match the order and items in the query fields. |
| • | data. An array of data rows. |
| • | DataRow. Represents a record and contains values for each column in a row: |
| • | data. An array of strings, one for the value in each column, in the same order as the names array. |
| | Note that all values are given in string format. |
The following example shows the full SOAP request for an executeDomainQuery operation on a sample Domain:
The response to the request contains the current values in the specified Domain:
Recommended Comments
There are no comments to display.