API Specification (OpenAPI & Swagger UI)

Activation

Both data structures are provided by additional endpoints which are anonymously accessible. This is why OpenAPI spec as well as Swagger UI are disabled by default.

It can be enabled as follows:

Open the file <inubit-installdir>/inubit/server/process_engine/bin/setenv.[sh/bat]
Set the line containing feature.enable.openapi.support=false to feature.enable.openapi.support=true
Restart the Process Engine

Swagger UI

With the Swagger UI you can browse the entire REST API visually in your browser. It provides all information around each endpoint.

URL: http(s)://<hostname>:<port>/ibis/swagger-ui/index.html on your system.

For a default installation: https://localhost:8000/ibis/swagger-ui/index.html

Use the dropdown in the Swagger UI (upper right corner) to switch between different REST API definitions.

OpenAPI Spec v3

The OpenAPI specification is a description of the entire REST API in the standardized OpenAPI format.

URL: http(s)://<hostname>:<port>/ibis/v3/api-docs

For a default installation: https://localhost:8000/ibis/v3/api-docs