Table of Contents

Search

  1. Preface
  2. Introduction to Business Entity Services
  3. EJB Business Entity Service Calls
  4. REST Business Entity Service Calls
  5. REST APIs for Data Director
  6. SOAP Business Entity Service Calls
  7. Cross-reference Records and BVT Calculations Services
  8. Supporting Corporate Linkage Service
  9. External Calls to Cleanse, Analyze, and Transform Data
  10. Appendix A: Using REST APIs to Add Records
  11. Appendix B: Using REST APIs to Upload Files
  12. Appendix C: Using REST APIs to Manage Reports

Query Parameters

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.
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" }

0 COMMENTS

We’d like to hear from you!