Add a REST entity to a model operation

  • Freigeben Version: Australia
  • Aktualisiert 12. März 2026
  • 2 Minuten Lesedauer

    • Specify the REST entity that a Zero Copy Connector for ERP model uses for a read, update, or create operation.

    Vorbereitungen

    Role required: sn_erp_integration.erp_admin

    You must have already added the read, write, or create operation before you can add an entity to it. For more information, see Add an operation to a model in Zero Copy Connector for ERP.

    For an overview of the REST API connector, see Rest API for Zero Copy Connector for ERP.

    For information about the REST API connector tables added for Zero Copy Connector for ERP, see REST API connector for Zero Copy Connector for ERP tables.

    Hinweis:
    Many REST APIs return deeply nested JSON objects. The connector supports up to three levels of nesting in response mapping. You can define nested levels for both input parameters and output fields in the Model Manager UI.

    Prozedur

    1. Navigate to All > Zero Copy Connector for ERP > Zero Copy Connector for ERP Home.
    2. Open the ERP model page by selecting the models icon in the side panel.
    3. Select the model that you want to add an operation entity to.
    4. Select the Manage model button.
    5. Select an operation.
    6. Wahlweise: For help finding relevant entities using the Ask AI button, see Use generative AI to help add an entity to a model.
    7. Select Select entity on the Manage entities tab.
    8. In Select type, select REST.

      The drop-down list in the Select type field only displays the types supported by the ERP system's software version specified on the model record. For example, if SAP SuccessFactors Cloud is set in the ERP software field for the model, the only entity type available is OData.

    9. In Select service, specify the REST service to use.

      Demo recording on January 28, 2026.

      Demo recording on January 28, 2026.

    10. If you don't see the service you need, add the service by selecting + Add service manually.
    11. If you're using a Swagger/OpenAPI URL, follow these substeps (if you're uploading a file, go to the next step.
      1. Select Swagger/OpenAPI URL.

        Demo recording on January 28, 2026.

      2. Paste in the Swagger/OpenAPI URL and click outside of the field.
      3. Check that a Service base URL is filled in automatically and a Service name is created automatically.
        Hinweis:
        If a Service name is not created, you have two options:
        • Provide a different Metadata URL.
        • In the All menu, enter sn_erp_integration_odata_service_catalog.list and delete the previous entry of service from the table.
      4. Select Add service.
    12. If you're uploading a file, follow these substeps.
      1. Select Upload Swagger/OpenAPI file.
      2. Select Attach file.
      3. Select a JSON or YAML file and then select Open.

        Demo recording on January 28, 2026.

      4. Enter a Service name.

        Demo recording on January 28, 2026.

        You can download, edit, or delete the JSON or YAML file by selecting an icon.

      5. Select Add service.

        Demo recording on January 28, 2026.

    13. Wait for the REST Endpoints field to load and then in Select the endpoints, specify an endpoint discovered from the URL or uploaded file.
    14. When you're finished, select Add entity.

      The entity card shows the date and time information was last retrieved.

    Nächste Maßnahme

    • Map top-level and nested JSON fields (up to three levels deep) to model fields.
    • Configure pagination parameters to control how data is retrieved in batches.
    • Define input parameters and output fields.