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

Using REST APIs to Add Records Overview

Using REST APIs to Add Records Overview

After you create a business entity model and configure the business entity structure, you can use the REST APIs to add the records.
The following sections use the example of the Person business entity to illustrate how you can add records by using REST APIs. The Person business entity contains data for the employees in your company.
Use the following APIs to add the details of your employees:
  1. Get information about the schema. Use the Get Metadata REST API to get information about the data structure of a business entity, including the structure, the list of fields, the field types, and the details of the lookup fields. Or, you can access the XML Schema Definition (XSD) files which describe what elements and attributes you can use. The XSD files are in the
    http:://<host>:<port>/cmx/csfiles
    location.
  2. Create a record. Use the Create Record REST API to create the record.
  3. Read the data from the record that you have added. Use the Read Record REST API to retrieve the data from the record.

0 COMMENTS

We’d like to hear from you!