Business Entity Services Guide

10.3 HotFix 1

Back Next

Query Parameters

Use the q or the fq query parameters to provide the string value for the search. The q and the fq query parameters are mutually exclusive. Use the fq parameter for a fielded search. Use the AND logical operator for multiple conditions.

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

Parameter	Description
q	Specifies the string value or the search term. The query searches for occurrences of the search term anywhere in a record. Used in a simple search. For example, the Person?q=STEVE query searches for records with the term STEVE. To search for two or more terms together, include the terms in double quotation marks. Use the character + before each term if you want the search results to contain the term. If the field value contains a space, enclose the field value in single quotes. Use the following query to search for an exact match to WILLIAM JOHN LAWSON: Person?q="WILLIAM JOHN LAWSON" Use the following query to search for WILLIAM, JOHN or LAWSON: Person?q=WILLIAM JOHN LAWSON Use the following query to search for WILLIAM, JOHN, and LAWSON: Person?q=WILLIAM JOHN LAWSON&queryOperator=AND
fq	Specifies the string value or search term in a particular field. The query searches for the term only in that part of a record. Used in a targeted search based on indexed fields. For example, the Person?fq=displayname=STEVE query searches for records with the display name STEVE.
facets	Specifies the fields that should be treated as facets or categories by which the search results are grouped. Specify only searchable fields. Used with the q and the fq parameters. Syntax is &facets=FieldName1,FieldName2,FieldNameN For example, the Person?q=STEVE&facets=department query searches for persons with the display name STEVE and groups the search results by the departments. Th search displays the records of the persons with the display name STEVE and these records are grouped by the departments.
filters	Specifies the fields by which you can narrow down the search results. Specify only filterable fields. Used with the q and the fq parameters. For example, the Person?fq=STEVE&filters=birthdate='1980-11-27T08:00:00Z' query searches for persons with the display name STEVE and filters the search results by the birth date. The search displays the records of the persons who have the display name STEVE and whose date of birth is 27 November, 1980. Specify a date within single quotation marks.
depth	Specifies the number of child levels to return. Specify 2 to return the root node and its direct children, and 3 to return the root node, direct children, and grandchildren. Specify 1 to return the root node alone. By default, no depth is specified. If no depth is specified, then the search results return the root node and children where a match for the search term is found. For example, the Person?q=STEVE&depth=2 query searches for records with the term STEVE and returns information about the root record and its direct children.
queryOperator	Specifies whether the search finds any of the strings in the search term or all of the strings in the search term. The parameter takes one of the following values: OR . Searches for any of the strings listed in the f or fq parameter. AND . Searches for all of the strings listed in the f or fq parameter. If you do not specify this parameter, the default is OR . For example, the Person?q=WILLIAM JOHN LAWSON&queryOperator=AND query searches for records that contains WILLIAM, JOHN, and LAWSON.
suppressLinks	Indicates whether the parent-child links are visible in the API response. Set the parameter to true to suppress all parent-child links in the response. Default is false. For example, the Person?q=STEVE&suppressLinks=true query searches for records with the term STEVE and returns the response where no parent-child links are visible.
readSystemFields	Indicates whether to return the system fields in the result. Default is false.
order	Comma-separated list of field names with an optional prefix of + or - . The prefix + indicates to sort the results in ascending order, and the prefix - indicates to sort the results in descending order. Default is + . If you want to use a child field to sort the results, use the full name of the field. For example, BillAddresses.Address.cityName . 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. For example, the Person?order=displayName,-BillAddresses.Address.cityName query sorts the results by display name in ascending order and then by city name in descending order.
maxRecordsToSort	Maximum number of search results that you want to sort. Default is 1000.

Specify a range with the
filters
parameter
:

You can use the filters parameter to narrow down the search results within a specified range. You can specify the range for filterable fields of the numeric and the date data types.

Use the following format for the integer data type:

fieldName1=[fromValue,toValue]

The range is from the fromValue to the toValue. Ensure that the fromValue is lower than the toValue. For example, the

filters=age=[35,45]

query narrows the search results and searches for records in the age group of 35 to 45.

Use the following format for the date data type:

fieldName1=[fromDate,toDate]

The range is from the fromDate to the toDate. For example, the

filters=birthdate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]

query specifies the date of birth between 12 June 2000 and 12 June 2015.

When you specify a exact match date filter, enclose it within single quotation marks. When you specify a date range, do not use quotation marks.

Rename Saved Search

Table of Contents

Business Entity Services Guide

Business Entity Services Guide

Query Parameters

Query Parameters