For the complete DHIS2 documentation index, see llms.txt.

数据审批¶

本节说明如何批准、取消批准和检查批准使用 dataApprovals 资源的状态。批准是按数据完成的审批工作流、期间、组织单位和属性选项组合。

/api/33/dataApprovals

数据批准工作流与多个实体相关联：

定义批准频率的期间类型
可选类别组合
工作流程中的一个或多个数据批准级别
一个或多个用于数据收集的数据集

获取批准状态¶

要获取数据集的批准信息，您可以发出GET请求：

/ api / dataApprovals？wf = rIUL3hYOjJc＆pe = 201801＆ou = YuQRtpLP10I

false | true

查询参数	需要	描述
数	是的	数据批准工作流标识符
聚乙烯	是的	期间标识符
欧	是的	/ api / 33 / system / taskSummaries / {task-category-id}
冠捷	不	属性选项组合标识符

注意

为了向后兼容，在此和其他数据批准请求中，可能会为数据集提供参数ds而不是wf，如下所述。如果给出了数据集，则将使用与该数据集关联的工作流。

这将产生类似于以下的响应：

/ api / dataApprovals?wf = rIUL3hYOjJc&pe = 201801&ou = YuQRtpLP10I

返回的参数是：

查询参数

返回参数	描述
wf	是的
数据批准工作流标识符	聚乙烯
是的	期间标识符
欧	是的
州	冠捷
不	属性选项组合标识符
> 注意
>
> 为了向后兼容,在此和其他数据批准请求中,可能会为数据集提供参数`ds`而不是`wf`,如下所述。如果给出了数据集,则将使用与该数据集关联的工作流。	这将产生类似于以下的响应:
```json
{
"mayApprove": false,
"mayUnapprove": false,
"mayAccept": false,
"mayUnaccept": false,
"state": "APPROVED_HERE",
"approvedBy": "User A",
"approvedAt": "2022-01-13T12:56:07.005",
"acceptedBy": "User A",
"acceptedAt": "2022-01-13T12:56:07.005"
}
```	返回的参数是:
Table: Data approval returned parameters	返回参数

描述

mayApprove	描述
mayUnapprove	Whether the current user may unapprove this data selection.
UNAPPROVED_WAITING	Whether the current user may accept this data selection.
未经批准_其他地方	Whether the current user may unaccept this data selection.
州	One of the data approval states from the table below.
approvedBy	If the selection is approved, and if present (not always needed), the user's name who made this approval.
approvedAt	If the selection is approved, and if present (not always needed), the date and time at which the highest level of approval was created.
acceptedBy	If the selection is approved, and if present (not always needed), the user's name who made the last update.
acceptedAt	If the selection is approved, and if present (not always needed), the date and time at which the highest level of approval was last updated.

注意查询数据审批状态时，可以指定查询参数的任意组合。您指定的组合不需要描述数据被批准的地方审批级别。例如：

组织单位可能不在审批级别。这批准状态取决于数据是否在某个时间被批准组织单位上级的批准级别。
您可以指定单个属性类别选项。批准状态取决于数据是否被批准用于属性包含其中一项或多项的类别选项组合选项。
您可以指定一个时间段，该时间段长于数据输入和批准的数据集。批准状态取决于数据是否被批准用于所有指定期间内的数据集期间。

对于与您可能需要的类别组合关联的数据集获取单个属性选项组合的数据批准记录从具有 GET 请求的以下资源：

/api/dataApprovals/categoryOptionCombos?wf=rIUL3hYOjJc&pe=201801&ou=YuQRtpLP10I

批量获取批准状态¶

要获取多个批准状态的列表，可以发出类似于以下内容的GET请求：

/api/dataApprovals/approvals?wf=rIUL3hYOjJc&pe=201801,201802&ou=YuQRtpLP10I

参数 wf、pe、ou 和 aoc 与获取单个批准状态的参数相同，但您可以为每个参数提供一个以逗号分隔的一个或多个值的列表。

这将为您提供一个包含批准参数和状态列表的响应，如下所示：

注意查询数据审批状态时,可以指定查询参数的任意组合。您指定的组合不需要描述数据被批准的地方审批级别。例如:

下表描述了返回的字段。

领域	描述
冠捷	属性选项组合标识符
聚乙烯	期间标识符
欧	组织单位标识符
权限	指定期间内的数据集期间。
州	数据批准状态之一（与获取单个批准状态相同）。
数	数据批准工作流标识符

批准数据¶

要批准数据，您可以向 dataApprovals 发出 POST 请求资源。要取消批准数据，您可以发送*DELETE*请求到数据批准资源。

POST DELETE /api/33/dataApprovals

要接受已经批准的数据，您可以发出 POST 请求到 dataAcceptances 资源。要取消接受数据，您可以发出 DELETE 对 dataAcceptances 资源的请求。

POST DELETE /api/33/dataAcceptances

这些请求包含以下参数：

描述

冠捷	需要	描述
数	是的	数据批准工作流标识符
聚乙烯	是的	期间标识符
欧	是的	/ api / 33 / system / taskSummaries / {task-category-id}
冠捷	不	属性选项组合标识符

注意，与查询数据审批状态不同，必须指定对应于可以选择的数据的参数得到正式认可的。特别是，以下两项都必须为真：

组织单位的级别必须由审批级别指定在工作流程中。
指定的时间段必须与工作流程。

批量批准数据¶

您可以通过发布到批准大量数据记录 /api/dataApprovals/approvals 资源。

POST /api/33/dataApprovals/approvals

您可以通过发布到 /api/dataApprovals/unapprovals 资源。

POST /api/33/dataApprovals/unapprovals

您可以通过发布到 /api/dataAcceptances/acceptances 资源。

POST /api/33/dataAcceptances/acceptances

您可以通过发布到 /api/dataAcceptances/unacceptances 资源。

POST /api/33/dataAcceptances/unacceptances

批准有效负载受JSON支持，如下所示：

{
  "wf": [
    "pBOMPrpg1QX", "lyLU2wR22tC"
  ],
  "pe": [
    "201601", "201602"
  ],
  "approvals": [
    {
      "ou": "cDw53Ej8rju",
      "aoc": "ranftQIH5M9"
    }, 
    {
      "ou": "cDw53Ej8rju",
      "aoc": "fC3z1lcAW5x"
    }
  ]
}

获取数据批准级别¶

要检索数据审批工作流及其数据审批级别，您可以发出类似这样的 GET 请求：

/api/dataApprovalWorkflows?
  fields=id,name,periodType,dataApprovalLevels[id,name,level,orgUnitLevel]

数据审批机关{ #authorities-for-data-approval }¶

组织单位的级别必须由审批级别指定
在工作流程中。