Business Entity Services Guide

10.4

Back Next

Query Parameters

You can append the query parameters to the request URL to filter the results.

The following table lists the query parameters:

Parameter	Description
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/1242?depth=10&suppressLinks=true query will display the record details up to 10 child levels, with no parent-child links visible in the response.
order	Used to list the lookup values in ascending or descending order. Use the character + as prefix to specify ascending order and the character - as prefix to specify descending order. By default, when you do not specify the prefix, the result set is ordered in ascending order. For example, the LUNamePrefix?action=list&order=-namePrefixDisp query lists the prefixes for name, which are sorted by the display names of the prefixes in descending order.

Parameter

Description

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/1242?depth=10&suppressLinks=true

query will display the record details up to 10 child levels, with no parent-child links visible in the response.

order

Used to list the lookup values in ascending or descending order. Use the character

as prefix to specify ascending order and the character

as prefix to specify descending order. By default, when you do not specify the prefix, the result set is ordered in ascending order.

For example, the

LUNamePrefix?action=list&order=-namePrefixDisp

query lists the prefixes for name, which are sorted by the display names of the prefixes in descending order.

Rename Saved Search

Table of Contents

Business Entity Services Guide

Business Entity Services Guide

Query Parameters

Query Parameters