Audit Log API
These are the endpoints of the audit log service.
Method | Endpoint |
---|---|
|
|
Description To create a new audit log entry, send a JSON message with the following structure:
Hint: 'externalReference' is optional and must be a JSON object when used. |
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Authentication API
These are the authentication endpoints.
Method | Endpoint |
---|---|
|
|
Description Check if the user session is valid. This function check the presence of an ssoToken. If a token was found, it is checked on the identity provider. If no token is found or the check was negative 401 "UNAUTHORIZED" will be send back. If the token was confirmed by the provider 200 OK will be send. |
|
Returns The user session as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Destroys the current user session. |
|
Returns HTTP Status Code
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Destroy all user sessions. |
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Destroys a specific user session. |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Form based login. Forwarding credentials to identity provider. If login was ok, the ssoToken will be placed as cookie in response and the information from provider will be forwarded as JSON. |
|
Consumes
|
|
Returns The user session as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Form based update of an existing session with the given tenant name. |
|
Consumes
|
|
Form Parameter
|
|
Returns The user session as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Set the provided language in the user session. When Keycloak is used as IdP, the language gets set in the Keycloak user profile (locale). |
|
Path Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Forwards the provided body to the user self service of the currently used identity provider. |
|
Consumes
|
|
Returns The response of the user self service HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Form based update of the users password. In case the IdP does not support updating user passwords, the user self service is used. Form params to provide:
|
|
Consumes
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Impersonate a user. Works only when Keycloak is used as identity provider. |
|
Path Parameter
|
|
Returns The user session as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get user info by access token. Can only be used with an OpenID Connect provider. CURL example with 'bearer' as access token type
|
|
Consumes
|
|
Path Parameter
|
|
Form Parameter
|
|
Returns The requested user info as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
BOM API
These are the BOM endpoints.
BOM stands for Bill-of-Materials and is an aggregation of all software dependencies the BPC modules/bundles have.
To get listed the modules/bundles must place their BOM to the file /META-INF/bom.json
.
Method | Endpoint |
---|---|
|
|
Description Forces a re-load of the BOMs. |
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the BOMs of all BPC bundles. |
|
Returns The requested BOMs. Example response:
HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get just the symbolic names of BPC bundles with BOMs. |
|
Returns The requested list. Example response:
HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get the BOM of a specific BPC bundle by its symbolic name. |
|
Path Parameter
|
|
Returns The content of the HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Download the BOM of a specific BPC bundle by its symbolic name. |
|
Path Parameter
|
|
Returns The content of the HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
Backups API
These are the backup endpoints.
Method | Endpoint |
---|---|
|
|
Description Get a list of all backups/snapshots as JSON. |
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Creates a backup/snapshot of the BPC configuration index |
|
Returns The backup/snapshot info as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Creates a backup/snapshot of the indices related to a backup job. |
|
Path Parameter
|
|
Returns The backup/snapshot info as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the data of a specific backup/snapshot. |
|
Path Parameter
|
|
Returns The requested backup/snapshot data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Delete a specific backup/snapshot. |
|
Path Parameter
|
|
Returns The info of the deleted backup/snapshot as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Restores and activates a specific backup/snapshot. |
|
Path Parameter
|
|
Returns Some infos about the restored and activated backup/snapshot as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Restores but does not activate a specific backup/snapshot. |
|
Path Parameter
|
|
Query Parameter
|
|
Returns Some infos about the restored backup/snapshot as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Download the content of a backup/snapshot. |
|
Path Parameter
|
|
Returns The requested data as JSON. Uses the HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Export the content of a |
|
Path Parameter
|
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Configuration API
These are the configuration endpoints.
Method | Endpoint |
---|---|
|
|
Description Get a complete version of the BPC configuration. It will contain all modules, instances and their settings, but restricted to the rights the user has. Every module provides the default configuration of itself and for instances. Additionally, some metadata like the model version and infos about the used
|
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get a compact version of the BPC configuration. It will contain all modules, instances and their settings, but restricted to the rights the user has.
And it will return only the settings were the Additionally, the metadata about the model version is provided.
|
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get the base BPC configuration to initialize the frontend. |
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Generates unique IDs using "SHA-256". The result is a 256bit long UUID as HEX String. |
|
Query Parameter
|
|
Returns The requested UUIDs as JSON array. HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Generates a unique API key using "SHA-256" (256bit long UUID as HEX String) and the ID of the API key. example response
|
|
Returns The requested data as JSON object. HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get a new instance ID for the provided module and module type. |
|
Path Parameter
|
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get the configuration of a specific module. The result contains the settings of the module, but restricted to the rights the user has. Additionally, the default configuration of itself and for instances is provided. Contains a compact list of instances with the ID, type and name when it is an instantiable module.
|
|
Path Parameter
|
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get the configuration of a specific module instance. In case the configuration of an instance is requested, just the settings the user has access rights for are returned.
In case the configuration of a module is requested, it returns the same as the endpoint without the |
|
Path Parameter
|
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Set the module configuration provided in the body. |
|
Consumes
|
|
Path Parameter
|
|
Query Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Set the module instance configuration provided in the body. |
|
Consumes
|
|
Path Parameter
|
|
Query Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Delete a single setting from a module instance. If this instance has a default value for this setting, the default will be restored. |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Delete a list of settings (provided in the body) from a module instance. |
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Delete a specific module instance. |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Performs a connection test on a specific module instance. Additional data to perform can be provided in the POST body as JSON object. |
|
Consumes
|
|
Path Parameter
|
|
Returns The error result as JSON, nothing when successful HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get the JSON schema to validate a JSON based module setting. |
|
Path Parameter
|
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get the JSON schema to validate a JSON based module instance setting. |
|
Path Parameter
|
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
Configuration File API
These are the endpoints to set properties in the BPC related Karaf properties file: etc/de.virtimo.bpc.core.cfg
Method | Endpoint |
---|---|
|
|
Description Sets a property in the local BPC related Karaf properties file: Required Role and Right:
|
|
Path Parameter
|
|
Query Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Sets a property in the remote BPC related Karaf properties file: |
|
Path Parameter
|
|
Query Parameter
|
|
Returns The response of the remote BPC. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Data Lock API
These are the data lock endpoints which are tight tied to OpenSearch (responses). Please try to use the storage endpoints instead.
Method | Endpoint |
---|---|
|
|
Description Get data lock items from the OpenSearch index |
|
Query Parameter
|
|
Returns The requested items as JSON (1:1 OpenSearch response) HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get a specific data lock item from the OpenSearch index |
|
Path Parameter
|
|
Returns The requested item as JSON (1:1 OpenSearch response) HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Sets the provided data for a specific item. The body data is written to the OpenSearch index |
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Updates an item with the provided data in the body. The item gets updated in the OpenSearch index |
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Deletes a specific item from the OpenSearch index |
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
Deployment API
These are the deployment endpoints.
Method | Endpoint |
---|---|
|
|
Description Get a list of all deployment systems (= backend connections of type 'deployment_system'). |
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the diff of a source deployment system or snapshot and a target deployment system. |
|
Query Parameter
|
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the diff of deployment source and target settings provided in the body content. Body:
|
|
Returns The diff as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Deploys the body content to the target system. |
|
Consumes
|
|
Query Parameter
|
|
Returns The deployment processing instructions as JSON file to download when the HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Processes the deployment instructions provided by the body content. |
|
Consumes
|
|
Query Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description To download specific bundles (JAR/WAR files) by their IDs as mime multipart data. Body:
|
|
Consumes
|
|
Returns The bundles as mime multipart data HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description To download a specific bundle (JAR/WAR files) by its ID. |
|
Path Parameter
|
|
Returns The bundle as data stream HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Imports the bundles provided by multipart form data. curl example
|
|
Consumes
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Special endpoint to import a single bundle from ExtJS by using multipart form data. |
|
Consumes
|
|
Returns ExtJS conform status info with the filename HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Deployment diffs can only be done when both systems use the same model version. This endpoint converts the model configurations provided in the content body to the model version of this installation. |
|
Consumes
|
|
Returns The migrated module configurations as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Copy an index from one deployment system to another. |
|
Path Parameter
|
|
Query Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get a list of OpenSearch indices. |
|
Returns the index infos HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get some infos of an index to deploy. |
|
Path Parameter
|
|
Returns the index info with its settings and mapping HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Downloads the first block of data from the given index. |
|
Path Parameter
|
|
Query Parameter
|
|
Returns the requested data HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Downloads the subsequent block of data from the given index. |
|
Path Parameter
|
|
Returns the requested data HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description To release a no longer used scroll identifier. This helps OpenSearch to release resources much faster. |
|
Path Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Prepares an index for upload. Creates it with the given settings and mapping. Body:
|
|
Consumes
|
|
Path Parameter
|
|
Query Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Feed an index with the uploaded data. Body:
|
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Event API
These are the endpoints of the BPC events.
Method | Endpoint |
---|---|
|
|
Description To send a new event, send a JSON message with the following structure:
Fields
|
|
Consumes
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Flow API
These are the endpoints to communicate with Flow.
Method | Endpoint | |
---|---|---|
|
||
Description Perform an HTTP GET on the given flow instance. |
||
Path Parameter
|
||
Query Parameter
|
||
Returns The response of the called Flow system |
||
Required Access Rights A logged in user or API Key is required. |
||
|
||
Description Perform an HTTP POST on the given flow instance. |
||
Path Parameter
|
||
Query Parameter
|
||
Returns The response of the called Flow system |
||
Required Access Rights A logged in user or API Key is required. |
||
|
||
Description Perform an HTTP PUT on the given flow instance. |
||
Path Parameter
|
||
Query Parameter
|
||
Returns The response of the called Flow system |
||
Required Access Rights A logged in user or API Key is required. |
||
|
||
Description Perform an HTTP DELETE on the given flow instance. |
||
Path Parameter
|
||
Query Parameter
|
||
Returns The response of the called Flow system |
||
Required Access Rights A logged in user or API Key is required. |
Frontend Logging API
These are the frontend logging endpoints.
Method | Endpoint |
---|---|
|
|
Description Saves the logs provided in the body to the OpenSearch index |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights A logged in user or API Key is required. |
Http Proxy API
These are the endpoints for proxy http requests to other systems.
Method | Endpoint | |
---|---|---|
|
||
Description Perform an HTTP GET on the 'httpproxy' backend connection. |
||
Path Parameter
|
||
Query Parameter
|
||
Returns The response of the called backend connection HTTP Status Code
|
||
Required Access Rights A logged in user or API Key is required. |
||
|
||
Description Perform an HTTP POST on the 'httpproxy' backend connection. |
||
Path Parameter
|
||
Query Parameter
|
||
Returns The response of the called backend connection HTTP Status Code
|
||
Required Access Rights A logged in user or API Key is required. |
||
|
||
Description Perform an HTTP PUT on the 'httpproxy' backend connection. |
||
Path Parameter
|
||
Query Parameter
|
||
Returns The response of the called backend connection HTTP Status Code
|
||
Required Access Rights A logged in user or API Key is required. |
||
|
||
Description Perform an HTTP DELETE on the 'httpproxy' backend connection. |
||
Path Parameter
|
||
Query Parameter
|
||
Returns The response of the called backend connection HTTP Status Code
|
||
Required Access Rights A logged in user or API Key is required. |
Identity Management API
These are the identity management endpoints. Please note, that not all functions are supported by all identity providers. In case a function is not supported, a UnsupportedOperationException gets thrown. All calls - except the GET methods - are logged in the audit log.
Method | Endpoint |
---|---|
|
|
Description Get a list of all users as JSON. |
|
Returns The requested data as JSON. Example response
HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Add a user by providing the data as JSON in the body. Example body
|
|
Consumes
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Update a user by providing the data as JSON in the body. Example body
|
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Update the password of a user. Example form
|
|
Path Parameter
|
|
Form Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Delete a user. |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get all organisations as JSON array. |
|
Returns The requested data. Example response
HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get all roles as JSON array. |
|
Returns The requested data. Example response
HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get all rights as JSON array. |
|
Returns The requested data. Example response
HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get the organisations of a user as JSON array. |
|
Path Parameter
|
|
Returns The requested data. Example response
HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Add an organisation to a user by providing the data as JSON in the body. Example body
|
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Delete the organisation of a user. |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the roles of a user as JSON array. |
|
Path Parameter
|
|
Returns The requested data. Example response
HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Add a role to a user by providing the data as JSON in the body. Example body
|
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Delete the role of a user. |
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the rights of a user as JSON array. |
|
Path Parameter
|
|
Returns The requested data. Example response
HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Add a right to a user by providing the data as JSON in the body. Example body
|
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Delete the right of a user. |
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the data of a user. |
|
Path Parameter
|
|
Returns The requested data. Example response
HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Internationalization API
These are the internationalization endpoints.
Method | Endpoint |
---|---|
|
|
Description Get the languages used by the translations. |
|
Query Parameter
|
|
Returns The languages as JSON. Example response when only_keys=false
Example response when only_keys=true
HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Get all supported languages. |
|
Query Parameter
|
|
Returns The languages as JSON. Example response when only_keys=false
Example response when only_keys=true
HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Forces a re-load of the translations. |
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get all translations for a specific language. This is a collection of the translations found in all
modules/bundles and the ones from our custom translations setting |
|
Path Parameter
|
|
Query Parameter
|
|
Returns JSON object with the translations. The keys are sorted in ascending order. HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Checks if the provided language is known to the backend. Returns the default/fallback language if not. |
|
Path Parameter
|
|
Returns The given language when valid, otherwise the default language. Example response
HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
Log Service API
These are the endpoints of the log service.
Method | Endpoint |
---|---|
|
|
Description Get a compact overview of the available log service instances. Only the following data is returned for each instance:
|
|
Returns The log service instances as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the current configuration of the log service instance. |
|
Path Parameter
|
|
Returns The requested config as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Gets the data of log service instance. |
|
Path Parameter
|
|
Query Parameter
|
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the data of a log service entry with its child entries. |
|
Path Parameter
|
|
Query Parameter
|
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the data of a log service child entry. |
|
Path Parameter
|
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Writes the data provided in the body to OpenSearch and/or the database. |
|
Consumes
|
|
Path Parameter
|
|
Query Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Deletes log service entries and their child entries from OpenSearch and the database. Attention: When you use 'childQuery' and/or 'childFilter' only those children get deleted, not the parent itself. |
|
Path Parameter
|
|
Query Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Deletes log service child entries from OpenSearch and the database. |
|
Path Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Deletes log service entries and their child entries from OpenSearch by query. Deletion from database is not supported. |
|
Consumes
|
|
Path Parameter
|
|
Query Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Deletes only log service child entries from OpenSearch by query. Deletion from database is not supported. |
|
Consumes
|
|
Path Parameter
|
|
Query Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Deletes/drops the parent and child indices of a log service instance. |
|
Path Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Loggers API
These are the endpoints to get all loggers with their log level and to set the log level.
Loggers are defined in the file: [karaf]/etc/org.ops4j.pax.logging.cfg
Method | Endpoint |
---|---|
|
|
Description Get all configured loggers with their currently set log level. |
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get a list of valid log levels. |
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Set the log level a specific logger. |
|
Form Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Lookup Joins API
These are the lookup joins endpoints.
Method | Endpoint |
---|---|
|
|
Description Refresh the lookup joins data of all replication jobs and log services related indices. |
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Refresh the lookup joins data of a replication job related index. |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Refresh the lookup joins data of a log service related index. |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Clears the internally used lookup joins caches. |
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Notification API
These are the notification endpoints.
Method | Endpoint |
---|---|
|
|
Description To add a notification, send a JSON message with the following structure: Minimal example
More complex example
Fields
|
|
Consumes
|
|
Returns The added notification as JSON. Contains additionally the 'date' and 'version' fields which get automatically set/updated. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description To update a notification, send a JSON message with the following structure: Minimal example
More complex example
Fields
|
|
Consumes
|
|
Path Parameter
|
|
Returns The updated notification as JSON. Contains additionally the 'date' and 'version' fields which get automatically set/updated. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Delete a specific notification. |
|
Path Parameter
|
|
Returns The deleted notification as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the data of a notification. |
|
Path Parameter
|
|
Returns The data of the requested notification as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get the notification of the requesting user. |
|
Query Parameter
|
|
Returns The requested notifications of the user as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
OpenSearch API
These are the OpenSearch endpoints.
Method | Endpoint |
---|---|
|
|
Description Get a list of all OpenSearch indices. |
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get a compact list of OpenSearch indices. Can be used for example in a combo box. |
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get the settings and mappings of an OpenSearch index. |
|
Path Parameter
|
|
Returns The requested data as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Delete an OpenSearch index. |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get the information what a reindex action would do with the index settings and mappings. |
|
Path Parameter
|
|
Query Parameter
|
|
Returns The old and new index settings and mappings as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Perform a reindex action. |
|
Path Parameter
|
|
Query Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Performance Measurement API
These are the performance measurement endpoints.
Method | Endpoint |
---|---|
|
|
Description Saves the measurements provided in the body to the OpenSearch index |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights A logged in user or API Key is required. |
Replication API
These are the replication endpoints.
Method | Endpoint |
---|---|
|
|
Description Get the last update timestamp of a replication job. |
|
Path Parameter
|
|
Returns The requested last update timestamp. HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Restarts a replication job. |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Forced start of a replication job. |
|
Path Parameter
|
|
Returns HTTP Status Code
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Server API
These are the BPC server endpoints. Please be sure that every BPC server in the cluster uses a unique UUID.
This is done by the setting de.virtimo.bpc.core.karaf.uuid
which can found in the config file [karaf]/etc/de.virtimo.bpc.core.cfg
.
Method | Endpoint |
---|---|
|
|
Description Get the UUIDs of the BPC servers in the cluster. |
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description Get detailed info of a BPC server in the cluster. |
|
Path Parameter
|
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
Status API
These are the status endpoints.
Method | Endpoint |
---|---|
|
|
Description Get the status of the local BPC server. |
|
Returns Depending on the user session more or less data is returned as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Get the status of a remote BPC server. |
|
Path Parameter
|
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Get the following health infos in one call:
|
|
Returns HTTP Status Code
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Get the status of all loaded BPC modules/bundles. |
|
Returns HTTP Status Code
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Get the maintenance mode status. |
|
Returns HTTP Status Code
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Get the OpenSearch status. |
|
Returns HTTP Status Code
|
|
Required Access Rights Can be used without a user session. |
|
|
|
Description Get a list of all sessions. |
|
Returns The requested data as JSON. HTTP Status Code
Content-Type
|
|
Required Access Rights The logged in user or API Key must have either the following role or right.
|
|
|
|
Description To check if this is the BPC master server. |
|
Returns HTTP Status Code
|
|
Required Access Rights Can be used without a user session. |
Storage API
These are the storage endpoints.
Method | Endpoint |
---|---|
|
|
Description Get store items from the OpenSearch index |
|
Path Parameter
|
|
Query Parameter
|
|
Returns The requested store items as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Get a specific store item from the OpenSearch index |
|
Path Parameter
|
|
Returns The requested store item as JSON HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Creates a new store item.
Writes the provided store item data to the OpenSearch index all fields example
Fields
|
|
Consumes
|
|
Path Parameter
|
|
Returns The ID of the created store item HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Creates or updates a store item.
Writes the provided store item data in the body to the OpenSearch index all fields example
Fields
|
|
Consumes
|
|
Path Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |
|
|
|
Description Deletes a specific store item from the OpenSearch index |
|
Path Parameter
|
|
Returns HTTP Status Code
Content-Type
|
|
Required Access Rights A logged in user or API Key is required. |