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

数据审批¶

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

/api/33/dataApprovals

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

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

获取批准状态¶

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

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

表：数据审批查询参数

查询参数	需要	描述
工作组	是的	数据批准工作流标识符
聚乙烯	是的	期间标识符
欧	是的	组织单位标识符
冠捷	不	属性选项组合标识符

注意

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

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

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

返回的参数是：

表：数据审批返回参数

返回参数	描述
可能批准	当前用户是否可以批准此数据选择。
可能不批准	当前用户是否可以不批准此数据选择。
可以接受	当前用户是否可以接受该数据选择。
可能不接受	当前用户是否可以不接受该数据选择。
州	其中一项数据批准情况如下表所示。
由...批准	如果选择被批准，并且如果存在（并不总是需要），则为进行此批准的用户的名称。
批准时间	如果选择获得批准，并且如果存在（并不总是需要），则创建最高级别批准的日期和时间。
被接受	如果选择被批准，并且如果存在（并不总是需要），则为上次更新的用户名。
接受于	如果选择获得批准，并且如果存在（并不总是需要），则上次更新最高级别批准的日期和时间。

表：数据批准状态

状态	描述
不可批准	数据批准不适用于此选择。（数据既未获得批准，也未获得批准。）
未批准_等待	此选择的数据可以得到批准，但在准备批准之前正在等待一些较低级别的批准。
未批准_其他地方	数据未批准，正在其他地方等待批准（此处未批准。）
未批准_准备就绪	数据尚未批准，并准备好批准此选择。
已批准_此处	数据已获得批准，并且已在此处获得批准（因此可能在此未获得批准。）
approvedAt	数据已获得批准，但未在此处获得批准（因此无法在此处取消批准。）这涵盖以下情况： * 数据已在更高级别获得批准。 * 数据已批准用于更广泛的类别选项。 * 数据已批准用于所选期间的所有子期间。在前两种情况下，有一个涵盖选择的数据批准对象。第三种情况则没有。
已接受_此处	数据已在此处获得批准和接受（因此可能在此未获得批准。）
已接受_其他地方	数据已被批准和接受，但在其他地方。

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

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

对于与您可能需要的类别组合关联的数据集获取单个属性选项组合的数据批准记录从具有 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/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 }¶

F_DATA_APPROVAL_WORKFLOW ：允许用户添加/更新数据审批工作流程
F_DATA_APPROVAL_LEVEL ：允许用户添加/更新数据批准级别