注释（财务工作区）
使用 RESTful API 暴露财务工作区评论¶
CCH Tagetik 暴露与评论和附件相关的数据。
| 状态 | SWAGGER | |
| ACTIVE | - |
|
| 格式 | 根端点 | |
| REST / OpenAPI | <api root>/dataentry/comments/v1 |
授权¶
要使用这些 API，必须启用上述选项，并在用户角色中启用 0001836-System Reports: Comments 和 0004151 - FW System Reports: Comments and Attachments 功能。
使用¶
与数据服务根相关的 URL 为：
<api-root>/dataentry/comments/v1/database_id
该服务提供一个压缩文件夹，其中包含一个名为 index.xslx 的文件，显示：
- 表单
- 受管维度
- 系统中的所有维度，根据调用者的用户权限进行筛选。
- 如果按节点筛选，则显示其所有子项的评论。如果其中一个子项本身是节点，则显示其子项的评论，依此类推。
- 维度名称基于调用者的应用程序语言。
- 维度元素的描述使用调用者所选的描述语言。
- 启用了 Personal data protection 选项的分析维度元素的描述将以加密形式导出。
- 备注
- 如果同一报表有多个评论，则重复与第一条相同的行，直至 Comment 字段。
- 附件
- 附件包含在 API 返回的压缩文件夹中。
- Attachment 字段将文件名显示为指向相关文件的超链接。
- 如果同一表单有多个评论，它们将输入到后续行中，直至 Comment 字段的单元格为空。
- 如果多个附件具有相同的文件名，操作系统默认会对它们进行区分。
- 用户
- 最后修改评论或附件的用户。
- 日期
- 最后修改的日期。
属于 Reporting Layer，与流程相关。
除了流程之外，您还可以在调用正文中指定与这些元素各自相关的筛选器，如下所示：
- 流程
"process":
- 基于与特定流程相关数据的筛选器
- 受管维度
"
"values":[
"includeNullValues":
}
- 基于特定维度值的筛选器。可用于筛选的维度包括：
- 场景
- 期间
- 实体
- 科目
- 变动与明细类型
- 类别
- 自定义维度 1 至 5
- 单位
- CTP 实体
- CTP 自定义维度 2
- Cod_Prospetto
-
Null（可选）
-
"includeNullValues":
-
包含该维度的空字段（默认 false）
直接调用服务的示例¶
API 的筛选器插入在请求正文中，因此 URL 中唯一的区别是引用的数据库
- URL 示例：http://qa7:8280/tagetikcpm/api/dataentry/comments/v1/TGK_QC_TRUNK_INCUBATEAM
所有评论¶
- 参数：无
- 正文：
- {
- }
- 数据以未筛选方式读取。
属于 ACT 流程的评论¶
- 参数：Process
- 正文：
- {
"process":"ACT"
}
属于场景 "2017ACT_V1" 的评论¶
- 参数：Scenario
- 正文：
- {
"scenario":{
"values":["2017ACT_V1"]
}
}
属于场景 "2017ACT_V1"、"2018ACT_V1" 和科目 "65030" 的评论¶
- 参数：Scenario、Account
- 正文：
- {
"scenario":{
"values":["2017ACT_V1","2018ACT_V1"]
},
"account":{
"values":["65030"]
}
}