引用 API

简介

CCH Tagetik 公开 RESTful API 接口，允许外部系统提取数据并在 CCH Tagetik 中启动数据处理。以下 API 可用：

• 分析工作区数据提取 API：从分析工作区表中提取数据。
• 分析工作区数据模型元素提取 API：从分析工作区模块表中提取数据模型元素。
• 关于分析工作区中导入/导出数据处理（AW、DTP）、更新、克隆的 API：在分析工作区模块中启动/停止数据处理。
• 关于将数据集导出数据处理为文件的 API，
• 用于将数据加载到分析工作区的 API：运行/停止用于更新分析工作区数据集的数据处理（Quick Data Loader/Datasource Mapping）
• 财务工作区更新 API：运行/停止用于基于分析工作区数据更新财务工作区的数据处理。（Quick Data Loader/Datasource Mapping）
• 用于使用 Quick Data Loader 直接将数据加载到分析工作区或财务工作区的 API
• 用于启动数据转换包（Data Transformation Package，DTP）的 API。
• 用于提取数据转换包（DTP）中存在的运行时参数的 API：返回给定 DTP 配置中存在的所需运行时参数列表。
• Tagetik 注释公开 API：将表单注释（包括系统和 AIH）作为包含在 .zip 中的 .xlsx 文件公开，连同任何附件。
• 用于检索格式化文本的 API：检索数据集分区字段中引用的格式化文本

访问

公共 RESTful API 默认处于禁用状态。要启用它们，请从界面（Homepage Repository）> General Settings 磁贴 > Security，选择 "Enable public REST APIs"。各类 API 无法单独启用。

API 可同时使用 http 和 https 协议。默认情况下，RESTful API 需要 "Basic Authentication"。

如果通过反向代理访问 CCH Tagetik，为使 OData API 正常工作，必须将基础 URL 设置为以下配置之一：

元素	描述
反向代理	根据所使用的配置，设置特定的基础 URL。

重要：为了在数据和数据模型方面使用分析工作区的 RESTful API，必须在用户角色中启用功能 0004077 - Analytical workspace: OData services。