数据集注释提取数据处理 API

功能¶

提取分析工作区数据集中存在的注释和附件。为此，必须在请求体中指定要从中提取注释的数据（流程、工作区、维度等）。

发出请求后，系统将创建一个压缩（.zip）文件夹，其中包含一个 XLSX 文件，内含提取的数据和任何附件。

用户要求¶

要使用这些 API，必须为用户分配一个启用了以下功能的角色：

0001836 - 系统报表：注释
0004152 - AIH 系统报表：注释和附件

XLSX 文件内容详情¶

XLSX 文件将包含以下元素。

元素	备注
表单	-
自定义字段	- 如果字段已编码，描述将被解码。 - 启用了个人数据保护选项的字段的分析工作区数据值将以加密形式导出。
维度	- 分配给此表单的所有维度均基于调用者的用户权限进行过滤。 - 如果某个维度被同一维度的节点过滤，则将显示其所有子节点的所有注释。如果存在更多子节点，则将显示所有层级的所有注释。 - 维度名称基于调用用户应用程序的语言。 - 维度元素的描述采用调用用户配置文件的描述语言，如果该描述不存在，则采用回退语言。 - 启用了个人数据保护选项的分析维度元素的描述以加密形式导出。
值	- 字段的数值（如果存在）。精确到小数点后第二位 - 仅适用于多维表单
注释类型	指定注释的来源，或注释的插入方式（"导航" 或 "数据录入"）
注释	如果同一表单上有多个注释，则复制所有必要的行，仅注释字段不同。
附件	- 附件字段以超链接形式报告文件名，该超链接可打开相应文件。 - 附件包含在 API 返回的压缩文件夹中。 - 如果同一表单上有多个注释，则这些注释插入到后续行中，复制所有内容但在注释字段之前留空。 - 如果有多个附件具有相同的文件名，则默认由操作系统加以区分。
用户	最后编辑注释或附件的用户。
日期	最后更改的日期。

URL¶

/aih/comments/v1/database_id

参数¶

以下参数可以输入到请求体中：

参数	描述	类型	必填	JSON 格式示例
process	要从中提取注释的流程。	String	可选	"process":
aw	要从中提取注释的分析工作区。	String	必填	"aw":
datasets	要从中提取注释的数据集。	String	必填	"dataset":
fields	要从中提取注释的维度基于特定维度的值进行过滤。Name 字段必须包含字段 ID，而 Values 数组必须包含要搜索的描述（使用正确的语言）。可以使用以下字段进行过滤： - 场景 - 期间 - 实体 - 科目 - 变动/明细类型 - 类别 - 自定义维度 1 至 5 - 币种 - CTP 实体 - CTP 自定义维度 2 - Cod_Prospetto - 自定义字段（文本、数字和日期）如果数据集按业务周期或业务周期和实体进行分区，且不包含场景、期间和/或实体字段，则仍可基于其分区所依据的场景、期间和/或实体对表单进行过滤。	String	必填	复制 `"fields":[ { "name":<string>, "values":[<string>,<string>...] }, ...`

"fields":[
{
"name":"COD_SCENARIO"/"COD_PERIODO"/"COD_ENTITY",
"values":[<string>,<string>...]
},
{
"name":"COD_SCENARIO"/"COD_PERIODO"/"COD_ENTITY",
"values":[<string>,<string>...]
}
]

| includeNullValues | 在文档中包含空维度字段。默认：false。 | Boolean | 可选 | "includeNullValues": |¶

{
    "aw":"00000001",
    "dataset":"0000002"
}

示例¶

用于基于其分区所依据的场景、期间和/或实体进行过滤的 API¶

复制

{
    "aw":"00000001",
    "dataset":"0000002",
    "process":"ACT"
}

用于从分析工作区 "00000001" 中的数据集 "0000002" 提取注释的 API¶

参数：分析工作区和数据集
请求体：

复制

{
    "aw":"00000001",
    "dataset":"0000002",
    "process":"ACT",
    "fields":[
        {
            "name":"scenario",
            "values":["2020_ACT"],
            "includeNullsValues":true
        }
]
}

用于从分析工作区 "00000001" 中属于 "ACT" 流程的数据集 "0000002" 提取注释的 API¶

参数：分析工作区、数据集和流程
请求体：

复制

{
    "aw":"00000001",
    "dataset":"0000002",
    "process":"ACT",
    "fields":[
        {
            "name":"scenario",
            "values":["2020_ACT","2018_ACT"]
        }
            ]
}

用于从 AW "00000001" 中属于流程 "ACT" 的数据集 "0000002" 提取注释的 API，场景为 "2020_ACT"，包含空元素。¶

参数：分析工作区、数据集、流程和场景
请求体：

复制

{
    "aw":"00000001",
    "dataset":"0000002",
    "process":"ACT",
    "fields":[
        {
            "name":"scenario",
            "values":["2020_ACT","2018_ACT"]
        },
        {
            "name":"scenario",
            "values":["01"],
            "includeNullValues":true
        }
            ]
}