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 metadata for a hierarchy:
{ "relationship":[ { "field":[ { "allowedValues":[ "2" ], "name":"rowidRelType", "label":"Rowid Rel Type", "dataType":"String", "length":14, "readOnly":false, "required":false, "system":false, "trust":false, "applyNullValues":false, "displayFormat":"DATETIME_LONG_FORMAT", "filterable":true, "sortable":true, "lookup":{ "link":[ { "href":"http://localhost:8080/cmx/lookup/localhost-orcl-MDM_SAMPLE/id-label/IsOdiParentOf/rowidRelType", "rel":"lookup" }, { "href":"http://localhost:8080/cmx/lookup/localhost-orcl-MDM_SAMPLE/object/IsOdiParentOf/rowidRelType", "rel":"list" } ], "object":"RboRelType", "key":"rowidObject", "value":"displayName" } }, { "allowedValues":[ "1" ], "name":"rowidHierarchy", "label":"Rowid Hierarchy", "dataType":"String", "length":14, "readOnly":false, "required":false, "system":false, "trust":false, "applyNullValues":false, "displayFormat":"DATETIME_LONG_FORMAT", "filterable":true, "sortable":true, "lookup":{ "link":[ { "href":"http://localhost:8080/cmx/lookup/localhost-orcl-MDM_SAMPLE/id-label/IsOdiParentOf/rowidHierarchy", "rel":"lookup" }, { "href":"http://localhost:8080/cmx/lookup/localhost-orcl-MDM_SAMPLE/object/IsOdiParentOf/rowidHierarchy", "rel":"list" } ], "object":"RboHierarchy", "key":"rowidObject", "value":"displayName" } }, { "name":"relName", "label":"Rel Name", "dataType":"String", "length":50, "trust":false, "applyNullValues":false, "displayFormat":"DATETIME_LONG_FORMAT", "filterable":true, "sortable":true }, { "name":"relDesc", "label":"Rel Desc", "dataType":"String", "length":200, "trust":false, "applyNullValues":false, "displayFormat":"DATETIME_LONG_FORMAT", "filterable":true, "sortable":true }, { "name":"consolidationInd", "label":"Consolidation Ind", "dataType":"Integer", "length":38, "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"creator", "label":"Creator", "dataType":"String", "length":50, "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"interactionId", "label":"Interaction Id", "dataType":"Integer", "length":38, "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"updatedBy", "label":"Updated By", "dataType":"String", "length":50, "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"lastUpdateDate", "label":"Last Update Date", "dataType":"Date", "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"lastRowidSystem", "label":"Last Rowid System", "dataType":"String", "length":14, "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"dirtyIndicator", "label":"Dirty Indicator", "dataType":"Integer", "length":38, "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"deletedBy", "label":"Deleted By", "dataType":"String", "length":50, "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"deletedInd", "label":"Deleted Indicator", "dataType":"Integer", "length":38, "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"hubStateInd", "label":"Hub State Ind", "dataType":"Integer", "length":38, "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"deletedDate", "label":"Deleted Date", "dataType":"Date", "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"rowidObject", "label":"Rowid Object", "dataType":"String", "length":14, "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"cmDirtyInd", "label":"Content metadata dirty Ind", "dataType":"Integer", "length":38, "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true }, { "name":"createDate", "label":"Create Date", "dataType":"Date", "readOnly":true, "system":true, "trust":false, "applyNullValues":false, "filterable":true, "sortable":true } ], "contentMetadata":[ { "operations":{ "read":{ "allowed":true }, "create":{ "allowed":true }, "update":{ "allowed":true }, "delete":{ "allowed":true } }, "name":"XREF" } ], "name":"IsOdiParentOf", "label":"is ODI parent of", "color":"#990066", "direction":"ENTITY_1_TO_ENTITY_2", "bidirectional":false, "from":{ "dataType":"BusinessEntity", "required":true, "lookup":{ "object":"Organization" } }, "to":{ "dataType":"BusinessEntity", "required":true, "lookup":{ "object":"Organization" } }, "hierarchy":"ODI" } ], "operations":{ "read":{ "allowed":true }, "update":{ "allowed":true } }, "root":"Organization", "name":"ODI" }

0 COMMENTS

We’d like to hear from you!