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

保养¶

资源和分析表{ #webapi_generating_resource_analytics_tables }¶

DHIS2 具有一组生成的数据库表，用作各种系统功能的基础。这些表可以执行立即或计划通过定期执行用户界面。它们也可以通过 Web API 生成为本节说明。此任务通常是针对系统的一项任务管理员而不使用客户端。

资源表由 DHIS2 应用程序内部使用各种分析功能。这些表对用户也很有价值编写高级 SQL 报告。它们可以通过 POST 或 PUT 生成请求到以下 URL：

/ api / 33 / resourceTables

分析表针对数据聚合进行了优化并使用目前在 DHIS2 中用于数据透视表模块。分析表可以使用 POST 或 PUT 请求生成：

/ api / 33 / resourceTables / analytics

表：分析表可选查询参数

查询参数	选项	描述
跳过资源表	假的\|真的	跳过资源表的生成
跳过聚合	假的\|真的	跳过聚合数据和完整性数据的生成
跳过事件	假的\|真的	跳过事件数据的生成
跳过注册	假的\|真的	跳过注册数据的生成
跳过组织单位所有权	假的\|真的	跳过组织单位所有权数据的生成
去年	整数	要包含的最近几年数据的数量

注

lastYears=0 表示最新分析或连续分析，定义见连续分析表中定义。

“数据质量”和“数据监控”可通过监控运行任务，由以下端点触发：

/ api / 33 / resourceTables / monitoring

此任务将分析您的验证规则，查找任何违规并将它们保存为验证结果。

这些请求将立即返回并启动服务器端过程。

保养¶

要执行维护，您可以与 maintenance 资源进行交互。您应该使用 POST 或 PUT 作为请求方法。可以使用以下方法。

清除分析表将删除所有分析表。

开机自检/ api / maintenance / analyticsTablesClear

分析表分析将收集有关数据库中分析表内容的统计信息。

开机自检/ api / maintenance / analyticsTablesAnalyze

清除过期邀请将删除所有用户帐户邀请已过期。

开机自检/ api / maintenance / expiredInvitationsClear

期间修剪将删除未链接到任何数据的期间值。

开机自检/ api / maintenance / periodPruning

零数据值删除将删除链接到数据的零数据值零数据被定义为不重要的元素：

开机自检/ api / maintenance / zeroDataValueRemoval

软删除的数据值删除将永久删除软删除的数据值。

开机自检/ api / maintenance / softDeletedDataValueRemoval

软删除的程序阶段实例删除将永久删除软删除的事件。

开机自检/ api / maintenance / softDeletedProgramStageInstanceRemoval

软删除程序实例的删除将永久删除软删除的注册。

开机自检/ api / maintenance / softDeletedProgramInstanceRemoval

软删除的跟踪实体实例的删除将永久删除软删除的跟踪实体实例。

开机自检/ api / maintenance / softDeletedTrackedEntityInstanceRemoval

删除SQL视图将删除数据库中的所有SQL视图。请注意，它不会删除DHIS2 SQL视图实体。

开机自检/ api / maintenance / sqlViewsDrop

创建SQL视图将重新创建数据库中的所有SQL视图。

开机自检/ api / maintenance / sqlViewsCreate

类别选项组合更新将删除过时并为所有类别组合生成缺少的类别选项组合。

开机自检/ api / maintenance / categoryOptionComboUpdate

也可以使用以下端点为单个类别组合更新类别选项组合。

开机自检/ api / maintenance / categoryOptionComboUpdate / categoryCombo / <category-combo-uid>

缓存清除将清除应用程序Hibernate缓存和分析分区缓存。

开机自检/ api / maintenance / cacheClear

组织单位路径更新将重新生成组织单位路径属性。这可能是有用的，例如如果您使用SQL导入组织单位。

开机自检/ api / maintenance / ouPathsUpdate

数据修剪将删除完整的数据集注册，数据批准，数据价值审核和数据价值，在这种情况下是组织单位。

开机自检/ api / maintenance / dataPruning / organisationUnits / <org-unit-id>

数据元素的数据修剪，这将删除数据值审核和数据值。

POST PUT /api/maintenance/dataPruning/dataElements/<data-element-uid>

元数据验证将应用所有元数据验证规则，并返回操作结果。

开机自检/ api / metadataValidation

应用程序重新加载将通过从文件系统读取来刷新已安装应用程序的DHIS2托管缓存。

开机自检/ api / appReload

通过对api / maintenance资源的POST请求以批处理方式支持维护操作，在api / maintenance资源中，该操作作为查询参数提供：

开机自检/ api / maintenance？analyticsTablesClear = true＆expiredInvitationsClear = true
  ＆periodPruning = true＆zeroDataValueRemoval = true＆sqlViewsDrop = true＆sqlViewsCreate = true
  ＆categoryOptionComboUpdate = true＆cacheClear = true＆ouPathsUpdate = true

系统信息¶

系统资源为您提供方便的信息和职能。系统资源可以在 /api/system 中找到。

产生识别码¶

要生成有效的随机 DHIS2 标识符，您可以执行 GET 请求此资源：

/ api / 33 / system / id？limit = 3

limit 查询参数是可选的，表示有多少您希望与响应一起返回的标识符。默认为返回一个标识符。响应将包含一个带有数组命名代码，类似于：

{
  "codes": [
    "Y0moqFplrX4",
    "WI0VHXuWQuV",
    "BRJNBBpu4ki"
  ]
}

DHIS2 UID格式具有以下要求：

长11个字符。
仅字母数字字符，即。字母或数字字符 (A-Za-z0-9)。
以字母字符（A-Za-z）开头。

查看系统信息¶

要获取有关当前系统的信息，您可以执行 GET 请求这个网址：

/ api / 33 / system / info

支持 JSON 和 JSONP 响应格式。系统信息响应目前包括以下属性。

{
  "contextPath": "http://yourdomain.com",
  "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 Chrome/29.0.1547.62",
  "calendar": "iso8601",
  "dateFormat": "yyyy-mm-dd",
  "serverDate": "2021-01-05T09:16:03.548",
  "serverTimeZoneId": "Etc/UTC",
  "serverTimeZoneDisplayName": "Coordinated Universal Time",
  "version": "2.13-SNAPSHOT",
  "revision": "11852",
  "buildTime": "2013-09-01T21:36:21.000+0000",
  "serverDate": "2013-09-02T12:35:54.311+0000",
  "environmentVariable": "DHIS2_HOME",
  "javaVersion": "1.7.0_06",
  "javaVendor": "Oracle Corporation",
  "javaIoTmpDir": "/tmp",
  "javaOpts": "-Xms600m -Xmx1500m -XX:PermSize=400m -XX:MaxPermSize=500m",
  "osName": "Linux",
  "osArchitecture": "amd64",
  "osVersion": "3.2.0-52-generic",
  "externalDirectory": "/home/dhis/config/dhis2",
  "databaseInfo": {
    "type": "PostgreSQL",
    "name": "dhis2",
    "user": "dhis",
    "spatialSupport": false
  },
  "memoryInfo": "Mem Total in JVM: 848 Free in JVM: 581 Max Limit: 1333",
  "cpuCores": 8
}

注意

如果请求此资源的用户不具有完全权限，则仅包括不被视为敏感的属性。

仅获取有关系统上下文的信息，即contextPath 和 userAgent，您可以向以下 URL 发出 GET 请求。 JSON 和支持 JSONP 响应格式：

/ api / 33 / system / context

检查用户名和密码组合是否正确¶

检查某些用户凭据（用户名和密码组合）是正确的，您可以使用以下资源向以下资源发出 GET 请求 基本认证：

/ api / 33 / system / ping

您可以通过检查 HTTP 来检测身份验证的结果响应头的状态码。可能状态的含义代码如下。请注意，这适用于 Web API 请求一般的。

表格HTTP 状态代码

HTTP 状态代码	描述	成果
200	好的	验证成功
302	已找到	请求时未提供凭证 - 未进行身份验证
401	未经授权	用户名和密码组合不正确 - 验证失败

查看异步任务状态¶

Tasks which often take a long time to complete can be performed asynchronously. After initiating an async task you can poll the status through the system/tasks resource by supplying the task category and the task identifier of interest.

轮询任务状态时，您需要进行身份验证启动任务的用户。以下任务类别是支持的：

表：任务类别

识别码	描述
检查某些用户凭据(用户名和密码组合)
是正确的,您可以使用以下资源向以下资源发出 GET 请求
基本认证:	生成分析表。
RESOURCE_TABLE	生成资源表。
监测	处理数据监视/监测验证规则。
Outcome	导入数据值。
EVENT_IMPORT	事件导入。
No credentials were supplied with the request - no authentication took place	输入注册人数。
TEI_IMPORT	导入跟踪的实体实例。
Tasks which often take a long time to complete can be performed
asynchronously. After initiating an async task you can poll the status
through the `system/tasks` resource by supplying the task category and
the task identifier of interest.	导入元数据。
DATA_INTEGRITY	处理数据完整性检查。

每个异步任务都会自动分配一个标识符，该标识符可以用于监视任务的状态。这个任务标识符是当您通过各种方式启动异步任务时由 API 返回启用异步的端点。

监控任务¶

您可以通过对系统任务的 GET 请求轮询任务状态像这样的资源：

/ api / 33 / system / tasks / {task-category-id} / {task-id}

一个示例请求可能看起来像这样：

/ api / 33 / system / tasks / DATAVALUE_IMPORT / j8Ki6TgreFw

响应将提供有关状态的信息，例如通知级别、类别、时间和状态。 *已完成的*属性指示该过程是否被认为是完整的。

[{
  "uid": "hpiaeMy7wFX",
  "level": "INFO",
  "category": "DATAVALUE_IMPORT",
  "time": "2015-09-02T07:43:14.595+0000",
  "message": "Import done",
  "completed": true
}]

监视类别的所有任务¶

您可以通过 GET 请求轮询特定类别的所有任务系统任务资源：

/ api / 33 / system / tasks / {task-category-id}

轮询数据值导入任务状态的示例请求看起来像这样：

/ api / 33 / system / tasks / DATAVALUE_IMPORT

监控所有任务¶

您可以使用以下命令请求系统中所有当前正在运行的任务的列表对系统任务资源的 GET 请求：

/ api / 33 / system / tasks

响应将类似于以下内容：

[{
  "EVENT_IMPORT": {},
  "DATA_STATISTICS": {},
  "RESOURCE_TABLE": {},
  "FILE_RESOURCE_CLEANUP": {},
  "METADATA_IMPORT": {},
  "CREDENTIALS_EXPIRY_ALERT": {},
  "SMS_SEND": {},
  "MOCK": {},
  "ANALYTICSTABLE_UPDATE": {},
  "COMPLETE_DATA_SET_REGISTRATION_IMPORT": {},
  "DATAVALUE_IMPORT": {},
  "DATA_SET_NOTIFICATION": {},
  "DATA_INTEGRITY": {
    "OB1qGRlCzap": [{
      "uid": "LdHQK0PXZyF",
      "level": "INFO",
      "category": "DATA_INTEGRITY",
      "time": "2018-03-26T15:02:32.171",
      "message": "Data integrity checks completed in 38.31 seconds.",
      "completed": true
    }]
  },
  "PUSH_ANALYSIS": {},
  "MONITORING": {},
  "VALIDATION_RESULTS_NOTIFICATION": {},
  "REMOVE_EXPIRED_RESERVED_VALUES": {},
  "DATA_SYNC": {},
  "SEND_SCHEDULED_MESSAGE": {},
  "DATAVALUE_IMPORT_INTERNAL": {},
  "PROGRAM_NOTIFICATIONS": {},
  "META_DATA_SYNC": {},
  "ANALYTICS_TABLE": {},
  "PREDICTOR": {}
}]

查看异步任务摘要¶

任务摘要资源允许您检索任务摘要异步任务调用。您需要指定类别和可选的任务标识符。任务标识符可以是从发起请求的 API 请求的响应中检索异步任务。

要检索特定任务的摘要，您可以发出以下请求：

/ api / 33 / system / taskSummaries / {task-category-id} / {task-id}

一个示例请求可能看起来像这样：

/ api / 33 / system / taskSummaries / DATAVALUE_IMPORT / k72jHfF13J1

响应将类似于以下内容：

响应将提供有关状态的信息,例如通知级别、类别、时间和状态。 *已完成的*属性指示该过程是否被认为是完整的。

您还可以检索多个任务的导入摘要具有类似请求的特定类别这：

/ api / 33 / system / taskSummaries / {task-category-id}

获取外观信息¶

您可以使用 GET 以 JSON 格式检索可用的标志图标要求：

/ api / 33 / system / flags

您可以使用 GET 以 JSON 格式检索可用的 UI 样式要求：

/ api / 33 / system / styles

集群信息{ #cluster-info }¶

/ api / 33 / system / tasks

GET /api/36/cluster/leader

[{
  "EVENT_IMPORT": {},
  "DATA_STATISTICS": {},
  "RESOURCE_TABLE": {},
  "FILE_RESOURCE_CLEANUP": {},
  "METADATA_IMPORT": {},
  "CREDENTIALS_EXPIRY_ALERT": {},
  "SMS_SEND": {},
  "MOCK": {},
  "ANALYTICSTABLE_UPDATE": {},
  "COMPLETE_DATA_SET_REGISTRATION_IMPORT": {},
  "DATAVALUE_IMPORT": {},
  "DATA_SET_NOTIFICATION": {},
  "DATA_INTEGRITY": {
    "OB1qGRlCzap": [{
      "uid": "LdHQK0PXZyF",
      "level": "INFO",
      "category": "DATA_INTEGRITY",
      "time": "2018-03-26T15:02:32.171",
      "message": "Data integrity checks completed in 38.31 seconds.",
      "completed": true
    }]
  },
  "PUSH_ANALYSIS": {},
  "MONITORING": {},
  "VALIDATION_RESULTS_NOTIFICATION": {},
  "REMOVE_EXPIRED_RESERVED_VALUES": {},
  "DATA_SYNC": {},
  "SEND_SCHEDULED_MESSAGE": {},
  "DATAVALUE_IMPORT_INTERNAL": {},
  "PROGRAM_NOTIFICATIONS": {},
  "META_DATA_SYNC": {},
  "ANALYTICS_TABLE": {},
  "PREDICTOR": {}
}]

{
  "leaderNodeId": "play-dhis2-org-dev",
  "leaderNodeUuid": "d386e46b-26d4-4937-915c-025eb99c8cad",
  "currentNodeId": "play-dhis2-org-dev",
  "currentNodeUuid": "d386e46b-26d4-4937-915c-025eb99c8cad",
  "leader": true
}

最小-最大数据元素¶

min-max 数据元素资源允许您设置最小值和最大值数据元素的值范围。它是独一无二的组织单位、数据元素和类别选项组合。

/ api / minMaxDataElements

一个示例请求可能看起来像这样:

项目	描述	数据类型
```json
{
"source": "rspjJHg4WY1",
"targets": [
"HT0w9YLMLyn",
"rEpnzuNpRKM"
],
"primaryTarget": "HT0w9YLMLyn",
"deleteSource": true
}
```	/ api / 33 / system / taskSummaries / {task-category-id}	串
最小最大数据元素	/ api / 33 / system / flags	串
预测变量	Cluster info	串
整数	A sample JSON response looks like this:	整数
最大	min-max 数据元素资源允许您设置最小值和最大值
数据元素的值范围。它是独一无二的
组织单位、数据元素和类别选项组合。	整数
POST /api/minMaxDataElements/upsert	项目	Boolean

您可以从以下位置检索所有最小-最大数据元素的列表资源：

source

您可以像这样过滤响应：

串

min-max 数据元素的过滤器参数支持两种运算符： eq 和 in。您还可以使用 fields 查询参数。

Data element identifier

串¶

要添加新的最小-最大数据元素，请使用POST请求执行以下操作：

Data element category option combo identifier

JSON内容格式如下所示：

{
  "min": 1,
  "generated": false,
  "max": 100,
  "dataElement": {
    "id": "UOlfIjgN8X6"
   },
  "source": {
    "id": "DiszpKrYNg8"
  },
  "optionCombo": {
    "id": "psbwp3CQEhs"
  }
}

如果数据元素、组织单位和类别的组合选项组合存在，最小值-最大值将被更新。

整数¶

要删除最小-最大数据元素，请使用DELETE方法发送请求：

删除/api/minMaxDataElements.json

JSON内容的格式与上述类似：

{
  "min": 1,
  "generated": false,
  "max": 100,
  "dataElement": {
    "id": "UOlfIjgN8X6"
   },
  "source": {
    "id": "DiszpKrYNg8"
  },
  "optionCombo": {
    "id": "psbwp3CQEhs"
  }
}

Indicates whether this object is generated by the system (and not set manually).¶

Boolean

您可以从以下位置检索所有最小-最大数据元素的列表资源:

GET /api/minMaxDataElements.json

您可以像这样过滤响应:

GET /api/minMaxDataElements.json?filter=dataElement.id:eq:UOlfIjgN8X6

GET /api/minMaxDataElements.json?filter=dataElement.id:in:[UOlfIjgN8X6,xc8gmAKfO95]

min-max 数据元素的过滤器参数支持两种运算符: eq 和 in。您还可以使用 fields 查询参数。

GET /api/minMaxDataElements.json?fields=:all,dataElement[id,name]

Add/update single min-max data element { #webapi_add_update_min_max_data_element }

要添加新的最小-最大数据元素,请使用POST请求执行以下操作:	描述
最小最大数据元素	```json
{
"min": 1,
"generated": false,
"max": 100,
"dataElement": {
"id": "UOlfIjgN8X6"
},
"source": {
"id": "DiszpKrYNg8"
},
"optionCombo": {
"id": "psbwp3CQEhs"
}
}
```
orgUnit	Delete single min-max data element { #webapi_delete_min_max_data_element }
预测变量	删除/api/minMaxDataElements.json
JSON内容的格式与上述类似:	```json
{
"min": 1,
"generated": false,
"max": 100,
"dataElement": {
"id": "UOlfIjgN8X6"
},
"source": {
"id": "DiszpKrYNg8"
},
"optionCombo": {
"id": "psbwp3CQEhs"
}
}
```
Add/update multiple min-max data elements { #webapi_add_update_multiple_min_max_data_elements }	To add or update multiple min-max data elements, you can use a POST request to the following resource:
POST /api/minMaxDataElements/upsert	The JSON content format for multiple min-max data elements looks like this:

[
{
  "dataSet": "BfMAe6Itzgt",
  "values": [
    {
      "dataElement": "s46m5MS0hxu",
      "orgUnit": "Qc9lf4VM9bD",
      "optionCombo": "Prlt0C1RF0s",
      "minValue": 27,
      "maxValue": 564
    },
    {
      "dataElement": "s46m5MS0hxu",
      "orgUnit": "Qc9lf4VM9bD",
      "optionCombo": "V6L425pT3A0",
      "minValue": 0,
      "maxValue": 100
    }
]

Note that the dataSet property is required in the request body when using JSON. Each min-max value should contain UID references to dataElement, orgUnit, optionCombo. The minValue and maxValue properties represent the minimum and maximum values for the data element, respectively and will be parsed as integers.

You can also specify the `generated` property if you want to indicate whether the min-max data element is generated by the system or set manually. If not specified, it defaults to `true`.¶

Gzipped JSON payloads are also supported for this endpoint, which can be useful for large datasets. The server will automatically decompress the gzipped content. If you send a gzipped payload, make sure to set the Content-Encoding header to gzip and include the Content-Type header with the value application/json. The payload itself should be part of the request body.

CSV payloads are also supported for this endpoint. The CSV file should be delimited with commas. You should set the Content-Type header to text/csv and the Accept header to application/json. You will also need to specify the dataSet query parameter in the request URL. The CSV payload should contain the following columns:

Column Name

锁定异常¶

锁定异常资源允许您打开其他锁定的数据用于特定数据集、时期和组织的数据输入集单元。您可以从以下资源中读取锁定异常：

/ api / lockExceptions

要创建新的锁定异常，您可以使用 POST 请求并指定数据集、期间和组织单位：

POST / api / lockExceptions？ds = BfMAe6Itzgt＆pe = 201709＆ou = DiszpKrYNg8

要删除锁定异常，您可以使用类似的请求语法删除请求：

删除/ api / lockExceptions？ds = BfMAe6Itzgt＆pe = 201709＆ou = DiszpKrYNg8

minValue¶

The minimum value for the data element

maxValue

The maximum value for the data element

generated

(optional) Indicates whether the min-max data element is generated by the system or set manually. Defaults to true if not specified.

An example CSV payload might look like this:

dataElement,orgUnit,optionCombo,minValue,maxValue,generated
s46m5MS0hxu,Qc9lf4VM9bD,Prlt0C1RF0s,27,564,false
s46m5MS0hxu,Qc9lf4VM9bD,V6L425pT3A0,0,100,true

Delete multiple min-max data elements { #webapi_delete_multiple_min_max_data_elements }

To delete multiple min-max data elements, you can use a DELETE request to the following resource:

DELETE /api/minMaxDataElements/delete

The JSON content for the request body should be in the same format as for adding or updating multiple min-max data elements, but you only need to specify the dataElement, orgUnit, and optionCombo properties for each min-max data element you want to delete. The minValue, maxValue, and generated properties are not required for deletion. Gzipped JSON payloads and CSV payloads are also supported for this endpoint, similar to the add/update multiple min-max data elements endpoint. Be sure to set the appropriate headers (Content-Encoding as gzip and Content-Type as application/csv or application/json) when sending the request. If using CSV, you will also need to specify the dataSet query parameter in the request URL.

锁定异常¶

锁定异常资源允许您打开其他锁定的数据用于特定数据集、时期和组织的数据输入集单元。您可以从以下资源中读取锁定异常:

/ api / lockExceptions

# HELP data_summary_object_counts 元数据对象计数
# TYPE data_summary_object_counts gauge
data_summary_object_counts{type="indicator"}77
data_summary_object_counts{type="trackedEntity"} 7312573125
data_summary_object_counts{type="visualization"}292
data_summary_object_counts{type="period"} 384384
data_summary_object_counts{type="programStageInstance"} 373597373597

POST / api / lockExceptions?ds = BfMAe6Itzgt&pe = 201709&ou = DiszpKrYNg8

要删除锁定异常,您可以使用类似的请求语法删除请求:

# HELP data_summary_build_info 建立信息
# TYPE data_summary_build_info gauge
data_summary_build_info{version="2.42-SNAPSHOT", commit="932e552"}1737621197

Data summary { #webapi_data_statistics}

The data summary resource provides some metrics about the database and level of system usage. The metrics include: Data statistics can be accessed with a GET request to :

保养¶

资源和分析表{ #webapi_generating_resource_analytics_tables }¶

保养¶

系统信息¶

产生识别码¶

查看系统信息¶

检查用户名和密码组合是否正确¶

查看异步任务状态¶

监控任务¶

监视类别的所有任务¶

监控所有任务¶

查看异步任务摘要¶

获取外观信息¶

集群信息{ #cluster-info }¶

最小-最大数据元素¶

串¶

整数¶

Indicates whether this object is generated by the system (and not set manually).¶

You can also specify the generated property if you want to indicate whether the min-max data element is generated by the system or set manually. If not specified, it defaults to true.¶

锁定异常¶

minValue¶

锁定异常¶

You can also specify the `generated` property if you want to indicate whether the min-max data element is generated by the system or set manually. If not specified, it defaults to `true`.¶