Web-API Gateway Endpoints

Owned by Technische Redaktion
Last updated: Dec 01, 2022

The higher-level API of the Web-API Gateway on top of the core, as it is useful for client application developers.

The endpoints can be used to build custom clients. We do our best to keep the Web-API Gateway as stable as possible, however, we reserve the right to introduce changes with each major release.


>> API-WEB Service

All endpoints are available via the Swagger-UI https://<host>/api-web/swagger-ui.html.

admin-controller Endpoints

Endpoints of the Web-API gateway for the management of tenant-specific configuration data, accessible with the role specified for /api-web/api/admin/** endpoints in the authentication-prod.yml configuration file.

bpm-controller Endpoints

Endpoints of the Web-API gateway for business process management, accessible for any authenticated user.

dms-controller Endpoints

Endpoints of the Web-API gateway for document management system, accessible for any authenticated user.

resource-controller Endpoints

Endpoints of the Web-API gateway for retrieval of resource files, accessible for any authenticated user.

system-controller Endpoints

Endpoints of the Web-API gateway for the management of global configuration data, accessible with the role specified for /api-web/api/system/** endpoints in the authentication-prod.yml configuration file.

user-controller Endpoints

Endpoints of the Web-API gateway for user settings management, accessible for any authenticated user.