Operation: data::entityBrowseRecords2
General Description
This method should be used instead of entityBrowseRecords. This method is used to browse or search for a list of entity records within the specified entity.
Operation Notes
- The required privilege level to invoke this operation is user.
- The supported database role for this operation is slave.
- The following rights and/or system privileges are required to invoke this operation: -
| System Privileges | Mail Privileges | Calendar Privileges | Database Privileges |
|---|---|---|---|
| -- | -- | -- | -- none -- |
Request Message
Input Parameters
The entityBrowseRecords2 method takes the following input parameters. It is important to note that the
parameters must be passed to the operation in the same order as they appear here in order to
satisfy the requirement of the input validation checks.
| Name | Type | Attributes | Description |
|---|---|---|---|
| application | appNameType | optional | Specify the name of the application this operation relates to. If not specified then "system" is assumed. |
| entity | simpleIdType | required once | The name of the entity you want to query. |
| matchScope | searchJoinType | optional | This can be either 'all' or 'any'. This determines if all fields in the search filter must match or if any field will match a result. Multiple values for the same column are always treated as a separate sub-criteria and 'any' value will match regardless of this setting. The default behaviour if this is not specified is 'all' |
| searchFilter | searchColumnType | optional minOccurs=0 maxOccurs=unbounded |
Specify one or more values as search criteria. You can only specify columns that are defined by the entity as searchable. Invoke data::entityGetBrowseMetaData operation to get the list of searchable columns and it's metadata. |
| orderBy | orderByColumnType | optional minOccurs=0 maxOccurs=unbounded |
One or more items to describe the order of the result set. If not specified then the order of the data will be dictated by the natural order of the underlying database. |
| formatValues | xs:boolean | optional | This is an optional parameter, the default value is 'false'. If you do not specify this parameter or specify false, the result set will be returned with the data values in their raw format. If you specify true, then the values will be formatted according to the application level format settings. |
| returnMeta | xs:boolean | optional | This is an optional parameter, the default value is 'false'. If you do not specify this parameter or specify false, the result set will be returned but will not include any meta data. If you specify true, then the meta data that describes the result set will be returned. |
| returnRawValues | xs:boolean | optional | This is an optional parameter, the default value is 'false'. If you specify true, then
the result data will include raw values for columns that have been formatted. The raw
values are returned as an attribute in the corresponding column value called "raw". The
raw value will only be present if: - - The value has been formatted and is now different to the raw value - The column is not a TEXT or BLOB data type. |
| maxResults | xs:integer | optional | This is an optional parameter, the default value is ZERO (0). If you wish to limit the results returned from your query you can set this value to the maximum number of records you want to get back. If you specify ZERO (0) then all records will be returned. If you do not want any data back you can specify -1, this is useful for obtaining just the meta data that would result from the query |
Response Message
Output Parameters
| Name | Type | Attributes | Description |
|---|---|---|---|
| metaData | anyDataType | optional | If the returnMeta input parameter is set to 'true', then the Example:
|
| rowData | anyDataType | optional | The data returned from this operation is dependant on the result of the SQL query. The result set
is formatted in a standard way and consists of (optional) meta data as well as zero or more rows of
data.
Example:
|
| queryExecTime | xs:unsignedInt | optional | The amount of time in microseconds that it took the database server to execute the query and return the results |
| queryResultsTime | xs:unsignedInt | optional | The amount of time in microseconds it took to process the results and serialize to XML/JSON (excluding any transmission time back to the caller) |
Code Generation & Samples
The links below will generate sample code in the respective languages. You can use these links as a convenient way of generating the correct code needed to invoke this methodJavaScript PHP C# Java C++ [ hide code ]