Import an API for a table definition

Prerequisites

For Planet 9 files: you must have previously exported a Planet 9 file of an API for a table definition from the API Designer of your Neptune DXP - Open Edition system for the API Designer to recognize the Planet 9 file during import.

Procedure

  1. In the Cockpit, go to Connectivity and select API Designer.

  2. In the API Designer, select Add.

    Result: The API configuration dialog opens. You start in the General tab.

  3. In Type, select Table Definition.

  4. Select Import and select an option from the drop-down menu:

    1. Select Planet 9 File to import a file from your disk.

      Result: Your local editor opens.

      1. Go to the directory of the file and select the file and Select Open.

    2. Select Table Definition to create an API from a table definition saved in the Table Definition tool in Neptune DXP - Open Edition.

      Result: The Import Table Definition window opens. You see all table definitions that are available to you.

      1. Select the table definition that you want to create an API for.

        Result: API Designer enters a name, operations, and definitions for the API. You can still add, change, and delete settings that were made by the API Designer.

  5. Select Save.

Result

  • You have imported an API for a table definition.

Related topics