Business Entity Services Guide

10.3 HotFix 3

Back Next

Query Parameters

Define the query as a list of field-value pairs.

The following table describes the query parameters that you can use in the URL:

Parameter	Description
action	Required. Returns all the records of the specified business entity type in the query results. Set to query , and use the parameter with the filter parameter. When used without the filter parameter, the query searches for all the records of the specified business entity type. For example, use the following query to search for all the Person business entity records: Person?action=query
filter	Required. Specifies a list of field-value pairs separated by operators. Valid operators are AND, IN, and Range. For example, use the following query to search for the Person records with the first name STEVE and the last name SMITH: Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'
depth	Specifies the number of child record levels to return. For example, you can specify the following levels: 1. Return the root record. 2. Returns the root record and its direct child records. 3. Returns the root record, the direct child records, and grandchild records. For example, use the following query to search for records with the first name STEVE and return information about the root record and its direct child records: Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'&depth=2
suppressLinks	Indicates whether the parent-child links are visible in the API response. Set the parameter to true to suppress all the parent-child links in the response. Default is false. For example, use the following query to search for records with the first name STEVE and return a response where no parent-child links are visible: Person?action=query&filter=firstName='STEVE'&suppressLinks=true
readSystemFields	Indicates whether to return the system fields in the result. Default is false.
fields	Specifies the fields to display in the query results.
outputView	Specifies the business entity view that you want to use to display the query results. When you configure the business entity view for the query results, include the fields that you want to display in the query results.
Order	Specifies the sort order of the query results. Use the plus (+) character as prefix to specify ascending order and the minus (-) character as prefix to specify descending order. By default, the query result is in ascending order. When you specify more than one parameter, the result set is ordered by the parameter that is first in the list, followed by the next parameter.

You can use the following operators within the filter parameter:

AND: Searches for records with all the field values listed in the filter parameter.; For example, use the following query to search for records with the first name STEVE and the last name SMITH:
Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'
IN: Searches for records with any of the values listed in the filter parameter.; For example, use the following query to search for records with the first name STEVE or JOHN:
Person?action=query&filter=firstName IN [STEVE,JOHN]
Range: Searches for records within a specified range. You can specify a range for the numeric and the date data type fields.; Use the following format for the integer data type:
<business entity field name>=[fromValue,toValue]
The range is from the fromValue to the toValue. Ensure that the fromValue is lower than the toValue.; For example, use the following query to search for records in the age group 35 to 45:
Person?action=query&filter=firstName IN [STEVE,JOHN] AND age=[35,45]; Use the following format for the date data type:
<business entity field name>=[fromDate,toDate]
The range is from the fromDate to the toDate.; For example, use the following query to search for records with the date of birth between 12 June 2000 and 12 June 2015:
Person?action=query&filter=birthDate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]

Rename Saved Search

Table of Contents

Business Entity Services Guide

Business Entity Services Guide

Query Parameters

Query Parameters