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

Step 3. Read the Record

Step 3. Read the Record

Use the Read Record REST API to retrieve the details of a root record that you added. You can use the API to retrieve the details of the child records of a root record.
The Read Record URL has the following format:
http://<host>:<port>/<context>/<database ID>/<business entity>/<rowId of the root record>
Use the
depth
parameter to specify the number of child levels to return. Specify 2 to return the root node and its direct children, and 3 to return the root node, direct children, and grandchildren. Use the following URL to return the details of the child records:
http://<host>:<port>/<context>/<database ID>/<business entity>/<rowId of the record>?depth=n
The following sample request returns the details of the root node, the direct children, and the grandchildren:
GET http://localhost:8080/cmx/cs/localhost-hub101-ds_ui1/Person/658248?depth=3
The request returns the details of an active record.
If a workflow is started when you create a record, the record created is in pending state. By default, the Read Record request reads active records. Use the
recordStates
parameter to specify the pending state of the record.
The following sample request reads the details of a pending record:
GET http://localhost:8080/cmx/cs/localhost-hub101-ds_ui1/Person/658248?depth=3&recordStates=PENDING

0 COMMENTS

We’d like to hear from you!