API for extracting Analytical Workspace data model elements

Function

Extracts information related to Analytical Workspace elements.

URL

/aih/metadata/v1

IMPORTANT: the metadata parameter CCH Tagetik ($) can be added to the URL to obtain more detailed results.

The data service streams the values to deal with the large volume of data that could be returned.

If the application is configured to manage the GDPR/DAC6 regulations, the Analytical Workspace data values and descriptions for fields on which the Personal Data Protection option is active will be exported in encrypted form.

API for extracting datasets

Recovers a list of all datasets (physical and virtual datasets and datasources) of the selected Analytical Workspace.

URL

<api-root>/aih/metadata/v1/database_id/workspace_code/Datasets

API for extracting the fields of a physical or virtual dataset or datasource

Recovers a list of the fields of the selected physical or virtual dataset or datasource.

URL

<api-root>/aih/metadata/v1/database_id/workspace_code/dataset_code/Fields

API for checking parameters by Function

Recovers a list of mandatory parameters of the Functions for extracting data from a dataset.

URL

<api-root>/aih/metadata/v1/database_id/workspace_code/dataset_code/Parameters