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

Request URL

Request URL

Use the row ID or the name of the source system and the source key to specify the record in the request URL.
The Read Record URL can have the following formats:
URL with rowId
Use the following URL format when you specify the row ID:
http://<host>:<port>/<context>/<database ID>/<business entity>/<rowId of the root record>
Make the following HTTP GET request to the URL:
GET http://<host>:<port>/<context>/<database ID>/<business entity>/<rowId of the root record>
URL with source system name and source key
Use the following URL format when you specify the source system name and the source key:
http://<host>:<port>/<context>/<database ID>/<business entity>/<system name>:<source key>
URL with system name and global business identifier (GBID) of an object
Use the following URL format when you specify the source system name and the GBID:
http://<host>:<port>/<context>/<database ID>/<business entity>/<system name>:uid:<gbid>
URL with only the GBID
Use the following URL format when you specify only the GBID:
http://<host>:<port>/<context>/<database ID>/<business entity>/:uid:<gbid>
URL with more than one GBID
Use the following URL format when you specify more than one GBID:
http://<host>:<port>/<context>/<database ID>/<business entity>/:one:<gbid>,another:<gbid>
URL to return the details of the child nodes
Use the following URL format to return the details of the child nodes:
http://<host>:<port>/<context>/<database ID>/<business entity>/<rowId of the record>?depth=n
URL to return the details of a child nodes
Use the following URL format to return the details of child nodes:
http://<host>:<port>/<context>/<database ID>/<business entity>/<rowId of the record>?children=<comma separated list of child node names or paths>
For example,
children= BillAddresses/Address,Email
URL to return the details of a particular node
Use the following URL format to return the details of particular node:
http://<host>:<port>/<context>/<database ID>/<business entity>/<rowId of the record>/<node name>
URL to return the details of the children of a particular node
Use the following URL format to return he details of the children of a particular node:
http://<host>:<port>/<context>/<database ID>/<business entity>/<rowId of the record>/<node name>?children=<child node name>
URL to return the content metadata of a record
Use the following URL format to return the content metadata of a record:
http://<host>:<port>/<context>/<database ID>/<business entity>/<rowId of the root record>?contentMetadata=<content metadata type>
For example, you can retrieve matches for the child records with the following GET request:
GET http://<host>:<port>/<context>/<database ID>/<business entity>/<rowId of the root record>?contentMetadata=MATCH
URL to sort the child elements by fields
Use the following URL format to sort the child elements by fields:
http://<host>:<port>/<context>/<database ID>/<business entity>/<rowId of the root record>/<node name>?order=-<field name>
Use the character the character
-
as suffix to specify descending order.

0 COMMENTS

We’d like to hear from you!