直接加载 Quick Data Loader 数据的 API

URL¶

/aih/qdl/v1/database_id

执行上下文参数¶

参数	描述	选项
process	必填。选择用于加载的流程。	-
scenario	仅对按场景和期间提交的流程为必填，对单次提交流程则不需要。选择用于加载的场景。	-
period	仅对按场景和期间提交的流程为必填，对单次提交流程则不需要。选择用于加载的期间。	-
entity	必填。选择用于加载的实体或节点。	- 要表示实体，使用实体代码（例如 A01） - 要表示节点，使用由 "

目标类型相关参数¶

参数	描述	选项
targetType	必填。目标类型。	- AW：加载到分析工作区 - AMOUNTS：加载到财务工作区（总金额数据和/或公司间金额数据）
loadingPolicy	必填。将数据加载到目标的策略。如有必要，可编辑性和验证检查会同时应用于要删除的数据和要插入的数据。	- ONLY_INSERT：仅插入数据，不删除。 - DELETE_FOR_FILTER_AND_ORIGIN_AND_INSERT：在运行插入之前，针对执行上下文、来源以及 fieldDeletionFilter 参数中指示的要筛选的维度进行删除。 - DELETE_FOR_FILTER_AND_INSERT：在运行插入之前，针对执行上下文以及 fieldDeletionFilter 参数中指示的要筛选的维度进行删除。
fieldDeletionFilter	可选。允许指定与目标相关的字段名称，用于筛选数据的删除。仅删除其值等于要插入的输入数据中所存在值的记录。	根据所选的目标类型，必须指定专用选项；参见 fieldDeletionFilter 属性的特殊功能

fieldDeletionFilter 属性的特殊功能¶

选项	描述	选项
类型为 AW 时
workspace	必填。分析工作区代码	-
dataset	必填。数据集代码	-
typology	可选。类型代码。默认：$ - Reporting layer	-
类型为 AMOUNT 时
grossType	可选。记录必须在总金额与公司间金额之间进行细分的方法。默认：GROSS	- GROSS：没有交易对手方的行作为总金额下载，其他行作为公司间金额下载。 - THIRD_PARTY：忽略交易对手方值的行合计作为总金额下载，而带有交易对手方的行合计作为公司间金额下载。
periodLength	可选。指定为数据加载的金额是按累计方式还是按期间表示。默认：YEAR_TO_DATE	- MONTHLY：每月 - BIMESTRAL：每两个月 - QUARTERLY：每季度 - FOURMONTHLY：每四个月 - SEMIANNUAL：每六个月 - ANNUAL：每年 - YEAR_TO_DATE：累计
carryForwardPolicy	可选。指示在所选 process 不是 Single Submission 且所选 periodLength 不是 YEAR_TO_DATE（累计）的情况下，上一期间数据的重新打开方式。默认 RELATED_TO_IMPORTED_DATA	- RELATED_TO_IMPORTED_DATA：使用导入数据中存在的相同 n-pla 逻辑重新打开上一期间的数据以使其累计，而不考虑来源。 - ACCORDING_TO_DELETION_POLICY：应用 loadingPolicy 参数中指定的删除策略所定义的筛选器，重新打开上一期间的数据。

数据相关参数¶

数据可以以 CSV 格式和 JSON 格式指定。

参数	描述	选项
CSV 格式
headerCsvFormat	必填。与源数据相关的字段名称列表。可能多于或少于目标的字段。	-
dataCsvFormat	必填。记录列表。每条记录是一个由 , 分隔的值列表，按照 headerCsvFormat 参数中定义的标头排序。每条数据记录必须与指定的标头具有相同的基数。	-
JSON 格式
dataJsonFormat	必填。记录列表。每条记录是一个 JSON 格式的对象，其中数据以键值对表示，键是源列的名称，值是字段的值。每条数据记录必须与其他记录具有相同的基数，并且必须包含通常的字段名称。

示例¶

用于按场景/期间提交的流程、针对单个实体、数据为 JSON 格式、加载到分析工作区的请求体¶

复制

{
"process" : "ACTUAL",
"scenario" : "2022ACT",
"period" : "12",
"entity" : "001",
"targetType": "AW",
"workspace" : "001",
"dataset" : "000001",
"typology" : "$",
"loadingPolicy" : "DELETE_FOR_FILTER_AND_ORIGIN_AND_INSERT"
"fieldDeletionFilter" : [ "ACCOUNT", "COST_CENTER"]
"dataJsonFormat" : [
{ "SCENARIO" : "2022ACT", "PERIOD" : "12", "ENTITY" : "001", "ACCOUNT" : "00001", "COST_CENTER" : "00001", "CURRENCY" : "EUR", "AMOUNT" : 100.00, "NOTE" : ""  },
{ "SCENARIO" : "2022ACT", "PERIOD" : "12", "ENTITY" : "001", "ACCOUNT" : "00002", "COST_CENTER" : "00001", "CURRENCY" : "EUR", "AMOUNT" : 200.00, "NOTE" : ""  },
{ "SCENARIO" : "2022ACT", "PERIOD" : "12", "ENTITY" : "001", "ACCOUNT" : "00003", "COST_CENTER" : "00001", "CURRENCY" : "EUR", "AMOUNT" : 300.00, "NOTE" : ""  }
]
}

用于单次提交流程、针对实体节点、数据为 CSV 格式、加载到分析工作区的请求体¶

复制

{
"process" : "BUDGET",
"entity" : "01|01",
"targetType": "AW",
"workspace" : "001",
"dataset" : "000001",
"typology" : "CALC",
"loadingPolicy" : "DELETE_FOR_FILTER_AND_INSERT"
"fieldDeletionFilter" : [ "ACCOUNT", "COST_CENTER"]
"headerCsvFormat" : [ "SCENARIO", "PERIOD","ENTITY","ACCOUNT","COST_CENTER","CURRENCY","AMOUNT","NOTE"]
"dataCsvFormat" : [
[ "2022ACT", "12", "001", "00001", "00001", "EUR", 100.00, ""  ],
[ "2022ACT", "12", "001", "00002", "00001", "EUR", 200.00, ""  ],
[ "2022ACT", "12", "001", "00003", "00001", "EUR", 300.00, ""  ]
]
}

用于按场景/期间提交的流程、针对单个实体、数据为 JSON 格式、加载到财务工作区的请求体¶

复制

{
"process" : "ACTUAL",
"scenario" : "2022ACT",
"period" : "12",
"entity" : "001",
"targetType": "AMOUNT",
"grossType" : "GROSS",
"periodLength" : "MONTHLY",
"carryForwardPolicy" : "RELATED_TO_IMPORTED_DATA",
"loadingPolicy" : "DELETE_FOR_FILTER_AND_ORIGIN_AND_INSERT"
"fieldDeletionFilter" : [ "COD_CONTO", "COD_DEST1"]
"dataJsonFormat" : [
{ "COD_SCENARIO" : "2022ACT", "COD_PERIODO" : "12", "COD_AZIENDA" : "001", "COD_CONTO" : "00001", "COD_DEST1" : "00001", "COD_CATEGORIA" : "$AMOUNT", "COD_VALUTA_ORIGINARIA" : "EUR", "IMPORTO_VALUTA_ORIGINARIA" : 100.00, "NOTE" : ""  },
{ "COD_SCENARIO" : "2022ACT", "COD_PERIODO" : "12", "COD_AZIENDA" : "001", "COD_CONTO" : "00002", "COD_DEST1" : "00001", "COD_CATEGORIA" : "$AMOUNT", "COD_VALUTA_ORIGINARIA" : "EUR", "IMPORTO_VALUTA_ORIGINARIA" : 200.00, "NOTE" : ""  },
{ "COD_SCENARIO" : "2022ACT", "COD_PERIODO" : "12", "COD_AZIENDA" : "001", "COD_CONTO" : "00003", "COD_DEST1" : "00001", "COD_CATEGORIA" : "$AMOUNT", "COD_VALUTA_ORIGINARIA" : "EUR", "IMPORTO_VALUTA_ORIGINARIA" : 300.00, "NOTE" : ""  }
]
}

用于单次提交流程、针对实体节点、数据为 CSV 格式、加载到财务工作区的请求体¶

复制

"process" : "BUDGET",
"entity" : "01|01",
"targetType": "AMOUNT",
"grossType" : "GROSS",
"periodLength" : "MONTHLY",
"carryForwardPolicy" : "RELATED_TO_IMPORTED_DATA",
"loadingPolicy" : "DELETE_FOR_FILTER_AND_INSERT"
"fieldDeletionFilter" : [ "ACCOUNT", "COST_CENTER"]
"headerCsvFormat" : [ "COD_SCENARIO", "COD_PERIODO","COD_AZIENDA","COD_CONTO","COD_DEST1","COD_CATEGORIA","COD_VALUTA_ORIGINARIA","IMPORTO_VALUTA_ORIGINARIA","NOTE"]
"dataCsvFormat" : [
[ "2022ACT", "12", "001", "00001", "00001", "$AMOUNT", "EUR", 100.00, ""  ],
[ "2022ACT", "12", "001", "00002", "00001", "$AMOUNT", "EUR", 200.00, ""  ],
[ "2022ACT", "12", "001", "00003", "00001", "$AMOUNT", "EUR", 300.00, ""  ]
]
}

在响应中，将以 JSON 格式返回以下内容：

dataprocessingId：数据处理 ID。

例如：{ "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB" }

要检查数据处理的状态，可以使用 GET 请求调用以下 URL：

/aih/qdl/v1/dataprocessingId

在响应中，将以 JSON 格式返回以下内容：

status：RUNNING/FAILED/COMPLETED - 取决于数据处理是正在进行、失败还是已成功完成。

例如：{"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED"}

要停止数据处理，可以使用 DELETE 请求调用以下 URL：

/aih/qdl/v1/dataprocessingId

在响应中，将以 JSON 格式返回以下内容：

message："Stop on dataprocessingOid dataprocessingId"/"Notify on dataprocessingOid dataprocessingId" - 取决于数据处理是否已结束。

例如：{"message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"}