Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This contract is currently in the Proof-of-concept stage and is still subject to changepart of version 25.1

Introduction

Our product can integrate with a variety of business intelligence (commonly called BI) tools. By configuring new Module Plugins with the category “Business Intelligence”, MediaHaven will produce a list of reports by combining all reports across all plugins of this category.

...

Depending on the application and the authorizations of the user, the following parameters can be provided with this GET request.

Parameter

Usage

Example

collection

When the installation contains multiple applications, then the collection parameter specifies which application it concerns such that a different list of reports can be returned.

Seriesregister, e-Depot

  • filter.organisation_long_name

  • filter.organisation_short_name

  • filter.organisation_id

When the user has no access across all organisations, then these parameters restrict the results that should be displayed in the report to this organisation. Specifically, if the user has the function ADMIN_VIEW_ALL_ORGANISATIONSthen they can see installation-wide reports.

The organisation of the user

  • layout.border

  • layout.title

Changing the layout of the embedding setting them to true or false will display or hide the corresponding item in the embedded. By default all of them are false

Expected headers

Code Block
x-api-key: <reporting engine api key>

...