Business Entity Services Guide

10.5

Back Next

Query Parameters

You can append the query parameters to the request URL to filter the details of the record.

The following table lists the query parameters:

Parameter	Description
depth	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. Default is 1.
effectiveDate	Date for which you want to retrieve the data.
readSystemFields	Indicates whether to return the system fields in the result. Default is false.
recordStates	State of the record. Provide a comma-separated list of states. The supported record states are ACTIVE, PENDING, and DELETED. Default is ACTIVE.
contentMetadata	Metadata of the record. Provide a comma-separated list. For example, XREF, PENDING_XREF, DELETED_XREF, HISTORY, XREF_HISTORY, and MATCH. When you select MATCH, the response contains a list of matched records that are retrieved from the _MTCH table.
historyDate	Date for which you want to retrieve history data. The response contains record data for the specified date retrieved from the _HIST table. You can use historyDate together with the contentMetadata parameter to retrieve historical metadata. Set contentMetadata to XREF, BVT, or TRUST. XREF. The response contains historical cross-reference data from the _HXRF table. BVT. The response contains historical best version of the truth from the _HCTL table. TRUST. The response contains historical trust settings from the _HCTL and _HVXR tables.
children	Comma-separated list of child node names or paths.
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	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 + . 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/1242/Names?order=-name query will display the result with the names in descending order. The Person/1242/BillAddresses?order=rowidObject,-effStartDate query will display the billing addresses with the rowid in ascending order and then, the effective start date in descending order.
resolveLookup	Retrieves the entire lookup field for a specified business entity. Set the parameter to true to load the lookup field and include it in the response. Default is false. For example, the addressType field is a lookup field at the child level of the Person business entity. When the resolveLookup parameter is set to false, you might receive the following REST API response: { "label": "LU Address Type", "addressType": "BILL" } When the resolveLookups parameter is set to true, the REST API response includes additional details and you might receive the following REST API response: { "label": "LU Address Type", "addressType": "BILL", "addressTypeDisp": "BILLING" }

The following example shows how to filter the details of a record:

GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/123/Phone/SFA:456/PhoneUse?recordsToReturn=100&recordStates=ACTIVE,PENDING&contentMetadata=XREF

Rename Saved Search

Table of Contents

Business Entity Services Guide

Business Entity Services Guide

Query Parameters

Query Parameters