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 query parameters to the request URL to filter the relationships.
The following table describes the query parameters:
Parameter
Description
effectiveDate
Date for which you want to retrieve the relationships.
interactionId
ID of the interaction.
readLabelsOnly
Indicates whether to return only labels in the result. Values are
true
or
false
.
readSystemFields
Indicates whether to return the system fields in the result. Values are
true
or
false
.
recordsToReturn
Specifies the number of rows to return.
rejectInteractionId
ID of the interaction for rejecting changes.
relationshipType
Comma-separated list of relationship types. For example, the
relationshipType=Employee,Employer list
returns related records of the
Employee
and
Employer
relationship types.
returnTotal
Returns the number of records in the result set. Set to
true
to get the number of records in the result set.
rootId
ID of the hierarchy root.

0 COMMENTS

We’d like to hear from you!