Business Entity Services Guide

10.3 HotFix 3

Back Next

Query Parameters

Use the

fuzzyFilter

parameter to specify the field values that you want to query. Use the

fuzzyFilter

parameter with the

action

parameter.

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

Parameter	Description
action	Required. Returns the matching records for the specified business entity. Set to match , and use the parameter with the fuzzyFilter parameter. For example, use the following query to search for a person with the first name STEVE: Person?action=match&fuzzyFilter=STEVE
fuzzyFilter	Required. Specifies a comma-separated list of field name and field value pairs that you want to use to query for records of a specific business entity type. For example, use the following query to search for records with the first name STEVE, who have a Toronto address: Person?action=match&fuzzyFilter=firstName=STEVE,Address.Address.City=TORONTO
matchRuleSet	Specifies a match rule set based on which you want to identify the matching records. If you do not have a specific match rule set, specify NONE. The automatic and the manual merge match rules are used.
filter	Specifies the field values to use to filter the results of a fuzzy search. For example, use the following query to search for records with the first name STEVE, who live in Toronto: Person?action=match&fuzzyFilter=firstName='STEVE',lastName="SMITH'&filter=city=Toronto
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=match&fuzzyFilter=firstName='STEVE'&filter=city=Toronto
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=match&fuzzyFilter=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.

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=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=city=Toronto AND gender=Male
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 last name JOHN, who live in the city Toronto or Ottawa:
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=city in [Toronto,Ottawa]
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=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=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=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&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