财务工作区更新处理 API
URL¶
http://server:port/tagetikcpm/api/aih/updateaw/v1/
用于更新财务工作区的 API¶
基于在分析工作区上定义、并由属于财务工作区上 database_id 所标识数据库的 workspace_code / dataset_code 对标识的数据集，运行财务工作区的更新。
用于加载的设置将按照使用 dsm_code 功能在数据集上定义的方式进行。
方法¶
POST
URL¶
<api-root>/aih/updatefw/v1/database_id/workspace_code``/``dataset_code
属性¶
以下与执行上下文相关的属性可以 JSON 格式包含在请求正文中：
| 属性 | 描述 | 选项 |
|---|---|---|
| process | 必填。为加载所选的流程。 | - |
| scenario | 仅对按场景和期间提交的流程需要，对单次提交流程不需要。为加载所选的场景。 | - |
| period | 仅对按场景和期间提交的流程需要，对单次提交流程不需要。为加载所选的场景。 | - |
| entity | 必填。为加载所选的实体或节点。 | - 要表示实体，使用实体代码（例如 A01） - 要表示节点，使用由 "GER |
示例¶
{ "process":"CAV1", "scenario":"2020sp", "period":"07", "entity":"A01"} - 使用流程 CAV1 和场景/期间等于 2020sp/07 为实体 A01 加载
{ "process":"CAV1", "scenario":"2020sp", "period":"07", "entity":"GER|01"} - 使用流程 CAV1 和场景/期间等于 2020sp/07 为节点 01 加载
返回的数据¶
在响应中，将以 JSON 格式返回以下 ID：
dataprocessingId = 数据处理 ID。
例如：{ "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB" }
用于检查财务工作区更新状态的 API¶
返回更新数据处理状态。
方法¶
GET
URL¶
返回的数据¶
在响应中，将以 JSON 格式返回数据处理状态：
status：RUNNING/FAILED/COMPLETED
| 状态 | 描述 |
|---|---|
| RUNNING | 运行中 |
| FAILED | 失败 |
| COMPLETED | 成功完成 |
例如：{"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED"}
用于停止财务工作区更新的 API¶
停止更新。
方法¶
DELETE
URL¶
返回的数据¶
在响应中，将以 JSON 格式返回以下 ID：
message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| 消息 | 描述 |
|---|---|
| Stop on dataprocessingOid | 数据处理已停止 |
| Notify on dataprocessingOid | 已请求停止数据处理，但仍在进行中 |
例如：{"message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"}