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 Request

Sample API Request

Request with the q parameter

The following sample request searches the Person business entity for records with the name STEVE.
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person?q=STEVE

Request with the fq parameter

The following sample request searches the Person business entity for records with the display name STEVE. The displayName field is an indexed field.
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person?fq=displayName=STEVE

Request with the sort option

The following sample request searches the Person business entity for records with the display name STEVE and sorts the results by city in ascending order:
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person?fq=displayName=STEVE&order=BillAddresses.Address.cityName

Request with the fq parameter and the AND logical operator

The following sample request searches the Person business entity for records with the display name STEVE and the tax ID DM106:
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person?fq=displayName=STEVE AND taxId=DM106

Request with a facet

The following sample request searches the Person business entity for records with the display name STEVE and narrows down the results by grouping them into departments:
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person?fq=displayName=STEVE&facets=department

Request with a filter (exact filter)

The following sample request searches the Person business entity for records with the display name STEVE and filters by the specified city and country:
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person?fq=displayName=STEVE&filters=cityName=Canberra AND country=Australia

Request with a filter range

The following sample request searches the Person business entity for records with display name STEVE and filters by the age group 35 to 45:
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person?fq=displayName=STEVE&filters=age=[35,45] AND cityName=Canberra

0 COMMENTS

We’d like to hear from you!