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 children relationships for a business entity record:
{ "link":[], "firstRecord":1, "pageSize":10, "searchToken":"SVR1.1G7VF", "relatedEntity":[ { "businessEntity":{ "Organization":{ "link":[ { "href":"http://localhost:8080/cmx/request/hm_icons/hierarchymanager/Hospital/Hospital.png?ors=localhost-orcl-MDM_SAMPLE", "rel":"icon" }, { "href":"http://localhost:8080/cmx/cs/localhost-orcl-MDM_SAMPLE/Organization/593", "rel":"self" } ], "rowidObject":"593 ", "label":"Turner Broadcasting System Inc", "partyType":"Organization", "displayName":"Turner Broadcasting System Inc", "dunsNumber":"003319068" } }, "entityLabel":"Turner Broadcasting System Inc", "relationshipLabel":"is ODI parent of", "relationship":{ "rowidObject":"887 ", "label":"is ODI parent of", "rowidRelType":"2 ", "rowidHierarchy":"1 ", "relName":"Parent", "relDesc":"Parent", "from":{ "rowidObject":"55 " }, "to":{ "rowidObject":"593 " } }, "entityType":"Organization", "relationshipType":"IsOdiParentOf" }, { "businessEntity":{ "Organization":{ "link":[ { "href":"http://localhost:8080/cmx/request/hm_icons/hierarchymanager/Hospital/Hospital.png?ors=localhost-orcl-MDM_SAMPLE", "rel":"icon" }, { "href":"http://localhost:8080/cmx/cs/localhost-orcl-MDM_SAMPLE/Organization/414", "rel":"self" } ], "rowidObject":"414 ", "label":"Historic TW Inc", "partyType":"Organization", "displayName":"Historic TW Inc", "dunsNumber":"007305290" } }, "entityLabel":"Historic TW Inc", "relationshipLabel":"is ODI parent of", "relationship":{ "rowidObject":"888 ", "label":"is ODI parent of", "rowidRelType":"2 ", "rowidHierarchy":"1 ", "relName":"HQ", "relDesc":"HQ", "from":{ "rowidObject":"55 " }, "to":{ "rowidObject":"414 " } }, "entityType":"Organization", "relationshipType":"IsOdiParentOf" }, { "businessEntity":{ "Organization":{ "link":[ { "href":"http://localhost:8080/cmx/cs/localhost-orcl-MDM_SAMPLE/Organization/35", "rel":"self" }, { "href":"http://localhost:8080/cmx/request/hm_icons/hierarchymanager/Hospital/Hospital.png?ors=localhost-orcl-MDM_SAMPLE", "rel":"icon" } ], "rowidObject":"35 ", "label":"People Magazine", "partyType":"Organization", "displayName":"People Magazine", "dunsNumber":"011584096" } }, "entityLabel":"People Magazine", "relationshipLabel":"is ODI parent of", "relationship":{ "rowidObject":"889 ", "label":"is ODI parent of", "rowidRelType":"2 ", "rowidHierarchy":"1 ", "relName":"Parent", "relDesc":"Parent", "from":{ "rowidObject":"55 " }, "to":{ "rowidObject":"35 " } }, "entityType":"Organization", "relationshipType":"IsOdiParentOf" }, { "businessEntity":{ "Organization":{ "link":[ { "href":"http://localhost:8080/cmx/cs/localhost-orcl-MDM_SAMPLE/Organization/391", "rel":"self" }, { "href":"http://localhost:8080/cmx/request/hm_icons/hierarchymanager/Hospital/Hospital.png?ors=localhost-orcl-MDM_SAMPLE", "rel":"icon" } ], "rowidObject":"391 ", "label":"Historic TW Inc", "partyType":"Organization", "displayName":"Historic TW Inc", "dunsNumber":"011816704" } }, "entityLabel":"Historic TW Inc", "relationshipLabel":"is ODI parent of", "relationship":{ "rowidObject":"890 ", "label":"is ODI parent of", "rowidRelType":"2 ", "rowidHierarchy":"1 ", "relName":"HQ", "relDesc":"HQ", "from":{ "rowidObject":"55 " }, "to":{ "rowidObject":"391 " } }, "entityType":"Organization", "relationshipType":"IsOdiParentOf" }, { "businessEntity":{ "Organization":{ "link":[ { "href":"http://localhost:8080/cmx/cs/localhost-orcl-MDM_SAMPLE/Organization/448", "rel":"self" }, { "href":"http://localhost:8080/cmx/request/hm_icons/hierarchymanager/Hospital/Hospital.png?ors=localhost-orcl-MDM_SAMPLE", "rel":"icon" } ], "rowidObject":"448 ", "label":"Historic TW Inc", "partyType":"Organization", "displayName":"Historic TW Inc", "dunsNumber":"069110711" } }, "entityLabel":"Historic TW Inc", "relationshipLabel":"is ODI parent of", "relationship":{ "rowidObject":"891 ", "label":"is ODI parent of", "rowidRelType":"2 ", "rowidHierarchy":"1 ", "relName":"HQ", "relDesc":"HQ", "from":{ "rowidObject":"55 " }, "to":{ "rowidObject":"448 " } }, "entityType":"Organization", "relationshipType":"IsOdiParentOf" }, { "businessEntity":{ "Organization":{ "link":[ { "href":"http://localhost:8080/cmx/request/hm_icons/hierarchymanager/Hospital/Hospital.png?ors=localhost-orcl-MDM_SAMPLE", "rel":"icon" }, { "href":"http://localhost:8080/cmx/cs/localhost-orcl-MDM_SAMPLE/Organization/545", "rel":"self" } ], "rowidObject":"545 ", "label":"Historic TW Inc", "partyType":"Organization", "displayName":"Historic TW Inc", "dunsNumber":"072077139" } }, "entityLabel":"Historic TW Inc", "relationshipLabel":"is ODI parent of", "relationship":{ "rowidObject":"892 ", "label":"is ODI parent of", "rowidRelType":"2 ", "rowidHierarchy":"1 ", "relName":"HQ", "relDesc":"HQ", "from":{ "rowidObject":"55 " }, "to":{ "rowidObject":"545 " } }, "entityType":"Organization", "relationshipType":"IsOdiParentOf" }, { "businessEntity":{ "Organization":{ "link":[ { "href":"http://localhost:8080/cmx/cs/localhost-orcl-MDM_SAMPLE/Organization/349", "rel":"self" }, { "href":"http://localhost:8080/cmx/request/hm_icons/hierarchymanager/Hospital/Hospital.png?ors=localhost-orcl-MDM_SAMPLE", "rel":"icon" } ], "rowidObject":"349 ", "label":"Historic TW Inc", "partyType":"Organization", "displayName":"Historic TW Inc", "dunsNumber":"074056123" } }, "entityLabel":"Historic TW Inc", "relationshipLabel":"is ODI parent of", "relationship":{ "rowidObject":"893 ", "label":"is ODI parent of", "rowidRelType":"2 ", "rowidHierarchy":"1 ", "relName":"HQ", "relDesc":"HQ", "from":{ "rowidObject":"55 " }, "to":{ "rowidObject":"349 " } }, "entityType":"Organization", "relationshipType":"IsOdiParentOf" }, { "businessEntity":{ "Organization":{ "link":[ { "href":"http://localhost:8080/cmx/request/hm_icons/hierarchymanager/Hospital/Hospital.png?ors=localhost-orcl-MDM_SAMPLE", "rel":"icon" }, { "href":"http://localhost:8080/cmx/cs/localhost-orcl-MDM_SAMPLE/Organization/298", "rel":"self" } ], "rowidObject":"298 ", "label":"WF Cinema Holdings LP", "partyType":"Organization", "displayName":"WF Cinema Holdings LP", "dunsNumber":"075408711" } }, "entityLabel":"WF Cinema Holdings LP", "relationshipLabel":"is ODI parent of", "relationship":{ "rowidObject":"894 ", "label":"is ODI parent of", "rowidRelType":"2 ", "rowidHierarchy":"1 ", "relName":"Parent", "relDesc":"Parent", "from":{ "rowidObject":"55 " }, "to":{ "rowidObject":"298 " } }, "entityType":"Organization", "relationshipType":"IsOdiParentOf" }, { "businessEntity":{ "Organization":{ "link":[ { "href":"http://localhost:8080/cmx/request/hm_icons/hierarchymanager/Hospital/Hospital.png?ors=localhost-orcl-MDM_SAMPLE", "rel":"icon" }, { "href":"http://localhost:8080/cmx/cs/localhost-orcl-MDM_SAMPLE/Organization/596", "rel":"self" } ], "rowidObject":"596 ", "label":"Historic TW Inc", "partyType":"Organization", "displayName":"Historic TW Inc", "dunsNumber":"076749246" } }, "entityLabel":"Historic TW Inc", "relationshipLabel":"is ODI parent of", "relationship":{ "rowidObject":"895 ", "label":"is ODI parent of", "rowidRelType":"2 ", "rowidHierarchy":"1 ", "relName":"HQ", "relDesc":"HQ", "from":{ "rowidObject":"55 " }, "to":{ "rowidObject":"596 " } }, "entityType":"Organization", "relationshipType":"IsOdiParentOf" }, { "businessEntity":{ "Organization":{ "link":[ { "href":"http://localhost:8080/cmx/request/hm_icons/hierarchymanager/Hospital/Hospital.png?ors=localhost-orcl-MDM_SAMPLE", "rel":"icon" }, { "href":"http://localhost:8080/cmx/cs/localhost-orcl-MDM_SAMPLE/Organization/699", "rel":"self" } ], "rowidObject":"699 ", "label":"Historic TW Inc", "partyType":"Organization", "displayName":"Historic TW Inc", "dunsNumber":"083115568" } }, "entityLabel":"Historic TW Inc", "relationshipLabel":"is ODI parent of", "relationship":{ "rowidObject":"896 ", "label":"is ODI parent of", "rowidRelType":"2 ", "rowidHierarchy":"1 ", "relName":"HQ", "relDesc":"HQ", "from":{ "rowidObject":"55 " }, "to":{ "rowidObject":"699 " } }, "entityType":"Organization", "relationshipType":"IsOdiParentOf" } ] }

0 COMMENTS

We’d like to hear from you!