Core Services APIs

The audit log collects information on user activities within the application. These endpoints allow to post custom audit logs and to get a link to the monitor corresponding to the audit log.

The Authentication API handles the processes of verifying a user’s identity and managing their session within the system.

The Bill-of-Materials (BOM) is an aggregation of all software dependencies the BPC modules/bundles have. These endpoints allow to list, retrieve, download and force-reload all available BOMs.

These endpoints allow to create, delete, restore and retrieve BPC backups.

These endpoints provide collaboration functionality. Currently, only the listing of all active users is available.

These endpoints allow to retrieve, delete and post configurations for BPC modules and module instances.

These endpoints allow to set properties in the BPC related Karaf properties file: etc/de.virtimo.bpc.core.cfg

The data lock endpoints are tightly tied to OpenSearch (responses). Please try to use the storage endpoints instead.

The deployment functionality allows to transfer configurations of one BPC instance to another.

BPC has an event system to inform clients of certain events to trigger corresponding actions. This API allows to post events that can be received by targeted BPC users.

File storage endpoints provide functionality to store files and binary data through configured file storage backend connections.

Flow is a special case of HTTP proxy functionality used for the connection with the process engines IGUASU and INUBIT. This API provides endpoints to make GET, POST, PUT and DELETE requests using these specialized proxies.

The aim of the Frontend Log Service is to make client-side logging (e.g. JavaScript console outputs) accessible within the backend. This API provides an endpoint to post these logs.

These are the endpoints for the global search frontend.

The BPC allows to setup HTTP proxy connections to make calls through the applications, e.g. to reach external resources which need authentication or can only be reached via a proxy. These endpoints allow to make calls using the defined HTTP proxies. The API supports the following HTTP methods: GET, POST, PUT, DELETE, PATCH and OPTIONS.

These endpoints allow to interact with the configured identity provider.

These endpoints allow to retrieve available languages and translations.

The log service allows to store data in OpenSearch indices and databases. After configuring log service instances, these endpoints can be used to create, update and delete log entries.

These endpoints allow to retrieve all loggers with their log level and to set the log level.

Lookup joins are used in the replication process to replicate data from Databases, where the replicated data lies in multiple tables.

The BPC has a notification functionality to inform users. This API contains endpoints to use this notification system, e.g. to send, update, delete and retrieve notifications.

These endpoints allow to list, delete and reindex OpenSearch indices as well as to receive index mappings.

The BPC performs performance monitoring to record runtimes in the BPC frontend. Measurements can be transmitted using this endpoint.

These endpoints allow to control the replication from a Database to OpenSearch.

The Security Check API provides information about internal security checks.

These endpoints allow to list all BPC instances in a cluster and to retrieve information about a specific instance.

The Status API allows to retrieve certain status information (e.g. availability, healthiness) of the BPC.

Modules can use the Storage API to store custom data in specific storage indices. This API provides additional filtering and read and write restrictions with respect to users, roles and organizations.