Skip to content

The Swagger UI

The Swagger UI is a tool that provides a user-friendly interface for interacting with the Export API.

The Swagger UI provides documentation for each endpoint, including request and response formats. It also allows you to test the Export API directly, without the need to develop your own application.

You can access the Swagger UI on the octoplant server using the following link:

https://{octoplant server name or IP adress}:64023/swagger-ui

Port 64023 is the default port assigned to the API on the octoplant server.

Working with the Swagger UI

After opening the Swagger UI, you must first authenticate with the server.

  1. In the upper right corner of the the Swagger UI, select the Authorize button.

  2. In the dialog, enter your user credentials for the octoplant server.

    You don't need to enter the client ID and the client secret here, they are already predefined.

  3. Select Login.

You can find all relevant information for the Export API in the Export section of the Swagger UI.

The Export section contains four sections:

  • The POST request with the creation of the JSON file and starting the process
  • The two GET requests for requesting the current state of the export and downloading the finished export
  • And the POST request in between for cancelling the job, e.g. if it is not needed anymore.

In all sections, you can test the request using the Try it out button in the upper right corner of the section.