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

Sample API Requests

Sample API Requests

The following sample request returns the details of the root record in the Person business entity.
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/102
The following sample request returns the details of a child record with rowId 2. The child base object is genderCd and the child record is at a depth of 2.
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/102/genderCd/2?depth=2
The following sample request uses the system name and source key to returns the details of the root record:
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/SFA:9000000000
The following sample request returns the details of the root record and its XREF records:
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/102?contentMetadata=XREF
The following sample request returns the details of the root record, with the names in descending order:
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/1242/Names?order=-name
The folllowing sample request returns the billing addresses with the rowid in ascending order and then, the effective start date in descending order:
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/1242/BillAddresses?order=rowidObject,-effStartDate

0 COMMENTS

We’d like to hear from you!