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

The ID of the record is a required parameter. The API uses the record ID to find all related history events.
The following table lists the query parameters:
Parameter
Description
startDate and
endDate
Optional. Date range for which you want to retrieve the data. If you specify a date range, the response contains only events within this range.
granularity
Optional. The level of detail to group history events. If specified, the response groups history events. Otherwise, the response does not group history events.
Use one of the following values:
  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • AUTO
recordStates
Optional. Record states returned in the list of history events. Provide a comma-separated list.
You can use the following values:
  • ACTIVE
  • PENDING
  • DELETED
contentMetadata
Optional. Metadata for the list of history events. Provide a comma-separated list.
You can use the following values:
  • XREF
  • PENDING_XREF
  • DELETED_XREF
  • HISTORY
  • MATCH
  • BVT
  • TRUST
children
Optional. Comma-separated list of the child node names. If specified, the response contains the child node names.
order
Optional.
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.
fields
Optional. Comma-separated list of business entity fields. If specified, the response only contains listed fields.
filter
Optional. Filter expression.
depth
Optional. Number of child levels to return.
recordsToReturn
Optional. Specifies the number of rows to return.
searchToken
Optional. Specifies the search token returned with previous request.
returnTotal
Optional. If set to
true
, returns the number of records in the result. Default is
false
.
firstRecord
Optional. Specifies the first row in the result.
changeType
Optional. Specifies the types of change returned in the result. Provide a comma-separated list.
You can use the following values:
  • BO
  • XREF
  • BVT
  • MERGE
  • MERGE_AS_SOURCE
  • MERGE_AS_TARGET
  • UNMERGE_AS_SOURCE
  • UNMERGE_AS_TARGET

0 COMMENTS

We’d like to hear from you!