API

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:

• Getting Started
• API-Reference
• Tutorials

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