Configure a table definition

In this topic, you learn how to configure an API to communicate with a table definition.



In this procedure we use sample data from the Star Wars universe. You can exchange our data with your data in the procedure.
  1. In the Cockpit, go to Connectivity and click API Designer.

  2. In the API Designer, click Add.

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

  3. In Type, select Table Definition.

  4. In API format, Swagger 2.0 is preselected. You can select the newer version, Open API 3.0, here.

  5. Enter a Name for your table definition, for example, API Clones.

  6. If you created a package or group for your APIs, applications, oData, and mock data before, you can select those from the Group or Package drop-down menu.

  7. Enter a short and meaningful Description to your API.

  8. In Version, enter a version number, for example, 1.0, to keep track of changes to the API.

  9. In Media Type, define the type of content of your api. This is needed to communicate with your browser. By default, it is application/json.

  10. Activate any of the following options that fit your application:

    Unresolved include directive in modules/cockpit-overview/pages/api-designer-table-definition-configure.adoc - include::partial$api-designer-create.adoc[]

  11. Click Save.


  • Your API is saved with the current settings and is added to the library in the API Designer.

  • The API Designer adds an ID to your API and saves change dates.

Next steps