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 Response

Sample API Response

The following sample response shows the related records and relationships for the Organization business entity type with the row ID 101:
{ "link": [], "firstRecord": 1, "pageSize": 10, "searchToken": "SVR1.1H7YB", "relatedEntity": [ { "businessEntity": { "SecurePerson": { "link": [ { "href": "http://10.21.43.42:8080/cmx/cs/localhost-orcl-ds_ui1/SecurePerson/1101", "rel": "self" } ], "rowidObject": "1101 ", "creator": "admin", "createDate": "2008-11-11T21:22:20-08:00", "updatedBy": "admin", "lastUpdateDate": "2012-03-29T19:03:19-07:00", "consolidationInd": "1", "lastRowidSystem": "SYS0 ", "dirtyIndicator": "0", "interactionId": "20003000", "hubStateInd": "1", "partyType": "Person", "lastName": "Obama", "firstName": "Barack" } }, "entityLabel": "Obama,Barack", "relationshipLabel": "Organization employes SecurePerson", "relationship": { "rowidObject": "414721 ", "creator": "admin", "createDate": "2016-10-17T01:58:12.436-07:00", "updatedBy": "admin", "lastUpdateDate": "2016-10-19T01:40:28.830-07:00", "consolidationInd": "4", "lastRowidSystem": "SFA ", "interactionId": "1476866426786", "hubStateInd": "1", "rowidRelType": "101 ", "rowidHierarchy": "1 ", "relName": "Documentation", "relDesc": "Writer" }, "entityType": "SecurePerson", "relationshipType": "OrganizationEmployesSecurePerson" }, { "businessEntity": { "SecurePerson": { "link": [ { "href": "http://10.21.43.42:8080/cmx/cs/localhost-orcl-ds_ui1/SecurePerson/114", "rel": "self" } ], "rowidObject": "114 ", "creator": "admin", "createDate": "2008-08-11T23:00:55-07:00", "updatedBy": "Admin", "lastUpdateDate": "2008-08-12T02:59:17-07:00", "consolidationInd": "1", "lastRowidSystem": "Legacy ", "dirtyIndicator": "0", "hubStateInd": "1", "partyType": "Person", "lastName": "HERNANDEZ", "displayName": "ALEJANDRO HERNANDEZ ", "firstName": "ALEJANDRO" } }, "entityLabel": "HERNANDEZ,ALEJANDRO", "relationshipLabel": "Organization employes SecurePerson", "relationship": { "rowidObject": "434721 ", "creator": "admin", "createDate": "2016-10-19T01:49:03.415-07:00", "updatedBy": "admin", "lastUpdateDate": "2016-10-19T01:49:03.415-07:00", "consolidationInd": "4", "lastRowidSystem": "SFA ", "hubStateInd": "1", "rowidRelType": "101 ", "rowidHierarchy": "1 ", "relName": "Documentation", "relDesc": "Writer" }, "entityType": "SecurePerson", "relationshipType": "OrganizationEmployesSecurePerson" }, { "businessEntity": { "Person": { "link": [ { "href": "http://10.21.43.42:8080/cmx/cs/localhost-orcl-ds_ui1/Person/1101", "rel": "self" } ], "rowidObject": "1101 ", "creator": "admin", "createDate": "2008-11-11T21:22:20-08:00", "updatedBy": "admin", "lastUpdateDate": "2012-03-29T19:03:19-07:00", "consolidationInd": "1", "lastRowidSystem": "SYS0 ", "dirtyIndicator": "0", "interactionId": "20003000", "hubStateInd": "1", "partyType": "Person", "lastName": "Obama", "firstName": "Barack" } }, "entityLabel": "Obama,Barack", "relationshipLabel": "Organization employes Person", "relationship": { "rowidObject": "414721 ", "creator": "admin", "createDate": "2016-10-17T01:58:12.436-07:00", "updatedBy": "admin", "lastUpdateDate": "2016-10-19T01:40:28.830-07:00", "consolidationInd": "4", "lastRowidSystem": "SFA ", "interactionId": "1476866426786", "hubStateInd": "1", "rowidRelType": "101 ", "rowidHierarchy": "1 ", "relName": "Documentation", "relDesc": "Writer" }, "entityType": "Person", "relationshipType": "OrganizationEmployesPerson" }, { "businessEntity": { "Person": { "link": [ { "href": "http://10.21.43.42:8080/cmx/cs/localhost-orcl-ds_ui1/Person/114", "rel": "self" } ], "rowidObject": "114 ", "creator": "admin", "createDate": "2008-08-11T23:00:55-07:00", "updatedBy": "Admin", "lastUpdateDate": "2008-08-12T02:59:17-07:00", "consolidationInd": "1", "lastRowidSystem": "Legacy ", "dirtyIndicator": "0", "hubStateInd": "1", "partyType": "Person", "lastName": "HERNANDEZ", "displayName": "ALEJANDRO HERNANDEZ ", "statusCd": "A ", "firstName": "ALEJANDRO" } }, "entityLabel": "HERNANDEZ,ALEJANDRO", "relationshipLabel": "Organization employes Person", "relationship": { "rowidObject": "434721 ", "creator": "admin", "createDate": "2016-10-19T01:49:03.415-07:00", "updatedBy": "admin", "lastUpdateDate": "2016-10-19T01:49:03.415-07:00", "consolidationInd": "4", "lastRowidSystem": "SFA ", "hubStateInd": "1", "rowidRelType": "101 ", "rowidHierarchy": "1 ", "relName": "Documentation", "relDesc": "Writer" }, "entityType": "Person", "relationshipType": "OrganizationEmployesPerson" } ] }

0 COMMENTS

We’d like to hear from you!