Public API

With the public API, you create REST calls to GBTEC Process Design, GBTEC Enterprise Architecture, and GBTEC Work Orchestrator. This lets you, for example, create cases or manage diagram data from an external application.

Where do I find the endpoints of the public API?

You can find all available endpoints in the interactive Swagger UI. There, you can also find the exact request and response formats.

Use the following link to the Swagger UI. In the upper right corner, under Select a definition, select the definition for your product.

Tip

If the link to the Swagger UI does not work, enter the following URL manually instead: https://{{host}}/public/swagger-ui/index.html. Replace {{host}} with your host.

How do I authenticate?

For every REST call to a public API endpoint, you provide a valid API key in the request header to authenticate.

How you get your API key depends on the product. As a ProcessApp Administrator, you create your API key for GBTEC Work Orchestrator yourself. To do this, select the Administration entry in the left menu bar and select the API Key tile. You can find out more in the How can I manage my API key? chapter.

For GBTEC Process Design and GBTEC Enterprise Architecture, there is no fixed user role for this. Every user receives the required API key from their GBTEC contact.

In addition to the API key, you need your tenant ID for every endpoint. You provide this as the tenantId parameter. Your request is automatically connected to your tenant via the tenant ID. You can find your tenant ID, for example, in the URL of your browser.

For concrete examples of individual endpoints, see the product-specific chapters, for example How can I create a new case via the REST API? for GBTEC Work Orchestrator or Dashboards API for GBTEC Process Design.

Tip

If you use GBTEC Work Orchestrator, you have an alternative to the public API. As a user with the ProcessApp Creator role, you can also accept, create, edit, or delete catalog items using its tools. You can find out more in the MCP Servers chapter.