Table of Contents

Search

  1. Preface
  2. Introduction to Business Entity Services
  3. Enterprise Java Bean Business Entity Service Calls
  4. Representational State Transfer Business Entity Service Calls
  5. Simple Object Access Protocol Business Entity Service Calls
  6. Services for Cross-reference Records and BVT Calculations
  7. Supporting Corporate Linkage Service
  8. External Calls to Cleanse, Analyze, and Transform Data
  9. Appendix A: Using REST APIs to Add Records
  10. Appendix B: Using REST APIs to Upload Files
  11. Appendix C: Using REST APIs to Manage Reports

Get Metadata

Get Metadata

The Get Metadata REST API returns the data structure of a business entity or a business entity relationship.
The API uses the GET method to return the following metadata of a business entity:
  • Structure of the business entity
  • List of fields
  • Field types such as the data type and size
  • Security settings for operations, such as create, update, and merge
  • Localized labels for nodes or fields
  • Name of the code and display fields for lookup fields
  • Default values for fields and lookup fields
    Multiple default values are not supported with dependent lookup fields.
The API returns the following details of a business entity relationship:
  • Name of the relationship and its label.
  • From and To business entities.
  • Direction of the relationship.

0 COMMENTS

We’d like to hear from you!