Reference API

Introduction

CCH Tagetik exposes RESTful API interfaces that allow external systems to extract data and launch data processing in CCH Tagetik. The following APIs are available:

• Analytical Workspace data extraction APIs: extract data from Analytical Workspace tables.
• Analytical Workspace data model element extraction APIs: extract elements of the data model from Analytical Workspace module tables.
• API on import/export data processing (AW, DTP) , update, clone in the Analytical workspaces: start/stop data processing in the Analytical workspace module.
• API on export data processing of a dataset to a file,
• APIs for loading data onto Analytical Workspaces: run/stop data processing for the updating of Analytical Workspace datasets (Quick Data Loader/Datasource Mapping)
• Financial Workspace update APIs: run/stop data processing for the updating of Financial Workspaces based on Analytical Workspace data. (Quick Data Loader/Datasource Mapping)
• API for directly loading data onto Analytical or Financial Workspaces using Quick Data Loader
• API to launch a Data Transformation Package (DTP).
• API for extracting runtime parameters present in a Data Transformation Package (DTP): returns the list of required runtime parameters present in the configuration of the given DTP.
• Tagetik Comment Exposure API: exposes form comments, both system and AIH, as an .xlsx file contained in a .zip, together with any attachments.
• API to retrieve formatted text: retrieves formatted text referenced within a partition field of a dataset

Access

The public RESTful APIs are disabled by default. To enable them, from the interface (Homepage Repository) > General Settings tile > Security, select "Enable public REST APIs". The various sets of APIs cannot be enabled individually.

APIs can be used with both http and https protocols. By default, RESTful APIs require "Basic Authentication".

If access to CCH Tagetik is gained via a reverse proxy, for OData APIs to function correctly the base URL must be set to one of the following configurations:

Element	Description
Reverse proxy	Depending on the configuration in use, set the specific base URL.

IMPORTANT: In order to use the RESTful API of the Analytical workspace with regard to data and the data model, the function 0004077 - Analytical workspace: OData services must be enabled in the user role.