Reporting View Metadata

To display reports in the user interface, it is necessary to fetch the metadata for the reporting view.

To do this, invoke a GET operation call to the /{reportingViewCode}/ metadata endpoint in the Reporting View integration point.

This integration point fetches the Reporting View based on the path parameter. For this view, all the view columns are fetched, and a JSON containing the following information is created.

• Column name

• Column data type

  • String

  • Date

  • Number

  • Boolean

  • Amount

  • Array

• Indicator if the column is searchable.

• Additional properties of the column.

  • These properties are only filled if the data type is either Array or Amount.

  • For the Amount data type, the properties indicate that this field contains both a currency and a value.

  • For the Array data type, the properties describe the various fields contained within the Array. An Array always represents a JSON value and thus contains multiple fields.

  • The content of the properties field is automatically filled in when the data type is an Array.