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

Parameters

Parameters

Specify the parameters to return business entity records that are edited and replaced with new values.
The following table describes the parameters in the request body.
Parameter
Type
Description
entity
Path
The name of the business entity records to return.
orsId
Path
Operational Reference Store ID of the database to return the replaced business entity records.
firstRecord
Query
Optional. The row of the records list.
order
Query
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.
recordsToReturn
Query
Optional. Specifies the number of rows to return.
returnTotal
Query
Optional. If set to
true
, returns the number of records in the result. Default is
false

0 COMMENTS

We’d like to hear from you!