Using the APIs, the functions of open bi server can be consumed in own applications or configuration settings can be changed.
The easiest way to use the open bi API is the open bi .NET client API. It supports netstandard2.0 and can also be used in WebAssembly.
All our APIs are available and always kept up-to-date as NuGet packages via https://www.nuget.org/profiles/biexcellence.
The API documentation can be found at the following links:
REST API
The open bi server offers a REST API. All resources are located under the base path /openbi/api, for example /openbi/api/users.
The API is described by an OpenAPI document which is served at /openbi/openapi/openbi.json. It always matches the running server version and can be used with any OpenAPI compatible tool (Swagger UI, Scalar, Postman, ...) or to generate a client for any language.
Authentication uses OAuth2 bearer tokens. A token is requested at /openbi/api/oauth/token, either with the password grant (user name and password) or with the client_credentials grant (API key).
Legacy Endpoints
The endpoint for the API is /OPENBI/XMLPROVIDER/MOBILE.BIEX.
There are also other endpoints like:
- Status: returns the current status of the open bi server
/openbi/xmlprovider/status.biex(only available through the config port) - Batch Job: trigger a single batch job on demand
/OPENBI/JOBS/BATCHJOB.BIEX?id=XXX - Event Batch Job: trigger all batch jobs for the specified name and value
/OPENBI/EVENTHANDLER/BATCHJOB.BIEX?name=XXX&eventvalue=YYY