审核¶
Not all jon configurations can be added to a queue.¶
System jobs and jobs that are already part of a queue cannot be used in another queue. To list job configurations that can be part of any queue use:
GET /api/scheduler/queueable
To list job configurations that can be part of a particular queue use:¶
GET /api/scheduler/queueable?name={queue}
This will also exclude all jobs that are already part the named queue.
同步化 { #webapi_synchronization }
| 默认值 | Validation rule | Parameter name |
|---|---|---|
| Table: Query parameters | 元数据拉取 { #webapi_sync_metadata_pull } | 要从远程 JSON 文档中启动元数据拉取,您可以创建一个 |
| 使用 url 作为请求负载的 POST 请求到以下资源: | ||
| Any delete operation will require the authority Perform maintenance tasks. | > Note | |
| > | ||
> The supplied URL will be checked against the config property metadata.sync.remote_servers_allowed in the dhis.conf file. | ||
| > If the base URL is not one of the configured servers allowed then the operation will not be allowed. See failure example below. | ||
> Some examples where the config set is metadata.sync.remote_servers_allowed=https://server1.org/,https://server2.org/ | ||
> - supply https://server1.org/path/to/resource -> this will be accepted | ||
> - supply https://server2.org/resource/path -> this will be accepted | ||
> - supply https://oldserver.org/resource/path -> this will be rejected | ||
| > | ||
| Sample failure response | ```json | |
| { | ||
| "httpStatus": "Conflict", | ||
| "httpStatusCode": 409, | ||
| "status": "ERROR", | ||
| "message": "Provided URL is not in the remote servers allowed list", | ||
| "errorCode": "E1004" | ||
| } | ||
| ``` | ||
| E7228 | To retrieve information about a form (which corresponds to a data set | |
and its sections) you can interact with the form resource. The form | ||
| response is accessible as XML and JSON and will provide information | ||
| about each section (group) in the form as well as each field in the | ||
| sections, including labels and identifiers. By supplying period and | ||
| organisation unit identifiers the form response will be populated with | ||
| data values. | / api / 33 /同步/可用性 | |
| Filter on whether the current user can manage the returned users through the managed user group relationships. | ```json | |
| ["www.google.com", "www.dhis2.org", "www.who.int"] | ||
| ``` | DHIS2 will audit updates and deletions of aggregate data values, tracked entity data values, tracked entity attribute values and data approval records. This section explains how to retrieve audit records for the mentioned entities. Note that several of the query parameters can be repeated any number of times. | |
| 数 | The endpoint for aggregate data value audits is located at: | ``` |
| /api/audits/dataValue | ||
| ``` | ||
| Table: Aggregate data value query parameters | 假 | 选项 |
| true | ds | Tracked Entity UIDS |
| 定义要返回的页码。 | Parameter | Data approval workflow ID |
| 定义每页返回的元素数量。 | Parameter | Organisation unit ID |
欧
Organisation unit ID
One or more org unit identifiers
auditType
UPDATE | DELETE¶
Filter by one or more audit types
skipPaging
false | true
| 默认值 | Validation rule | Parameter name |
|---|---|---|
Absolute end date. Applicable only when type is ABSOLUTE | Enable or disable paging | page |
| > Note | ||
| > | ||
> The repetition attribute (in rows, columns or filters) indicates the events indexes to be retrieved. Taking the example above (in the previous json payload), it can be read as follows: | ||
| > | ||
| 1 = First event | ||
| 2 = Second event | ||
| 3 = Third event | ||
| ... | ||
| -2 = Third latest event | ||
| -1 = Second latest event | ||
| 0 = Latest event (default) | Sharing of data store keys follows the same principle as for other metadata sharing (see | |
| Sharing). | pageSize | |
| 数 | Page size (default 50) | ``` |
| /api/audits/dataValue | ||
| ``` | ||
| dueDate | The endpoint for data approval audits is located at: | /api/33/audits/trackedEntity.json?trackedEntities=wNiQ2coVZ39 |
| lastUpdatedDate | Once auditing is enabled for tracked entities (by setting allowAuditLog of tracked entity types to true), all read and search operations are logged. The endpoint for accessing audit logs is located at: | ``` |
| /api/audits/trackedEntityInstance | ||
| ``` | ||
| Table: Aggregate data value query parameters | 假 | 选项 |
| true | ds | Tracked Entity UIDS |
| 定义要返回的页码。 | Parameter | One or more user identifiers |
| 定义每页返回的元素数量。 | Parameter | Filter by one or more audit types |
开始日期
Start date
Start date for audits in yyyy-mm-dd format
结束日期
End date¶
End date for audits in yyyy-mm-dd format
skipPaging
false | true
| 默认值 | Validation rule | Parameter name |
|---|---|---|
Absolute end date. Applicable only when type is ABSOLUTE | Enable or disable paging | page |
| > Note | ||
| > | ||
> The repetition attribute (in rows, columns or filters) indicates the events indexes to be retrieved. Taking the example above (in the previous json payload), it can be read as follows: | ||
| > | ||
| 1 = First event | ||
| 2 = Second event | ||
| 3 = Third event | ||
| ... | ||
| -2 = Third latest event | ||
| -1 = Second latest event | ||
| 0 = Latest event (default) | Sharing of data store keys follows the same principle as for other metadata sharing (see | |
| Sharing). | pageSize | |
| 数 | Page size (default 50) | ``` |
| /api/audits/dataValue | ||
| ``` | ||
| dueDate | The endpoint for data approval audits is located at: | /api/33/audits/trackedEntity.json?trackedEntities=wNiQ2coVZ39 |
| lastUpdatedDate | Once auditing is enabled for tracked entities (by setting allowAuditLog of tracked entity types to true), all read and search operations are logged. The endpoint for accessing audit logs is located at: | ``` |
| /api/audits/trackedEntityInstance | ||
| ``` | ||
| Table: Aggregate data value query parameters | 假 | 选项 |
| true | ds | Tracked Entity UIDS |
| 定义要返回的页码。 | Parameter | One or more user identifiers |
| 定义每页返回的元素数量。 | Parameter | Filter by one or more audit types |
开始日期
Start date
Start date for audits in yyyy-mm-dd format
结束日期
数据审批审核¶
End date for audits in yyyy-mm-dd format
skipPaging
false | true
| 默认值 | Validation rule | Parameter name |
|---|---|---|
| 真正 | Whether to enable or disable paging | page |
| 数 | Page number (default 1) | pageSize |
| Filter on whether the current user can manage the returned users through the managed user group relationships. | ```json | |
| ["www.google.com", "www.dhis2.org", "www.who.int"] | ||
| ``` | Example: Get audits of audit type READ with startDate 2018-03-01 and endDate 2018-04-24 with a page size of 5: | |
| 可选类别组合 | Example: Get audits for tracked entity wNiQ2coVZ39: | /api/33/audits/trackedEntityInstance.json?trackedEntities=wNiQ2coVZ39 |
| dueDate | The endpoint for data approval audits is located at: | ``` |
| /api/audits/dataApproval | ||
| ``` | ||
| lastUpdatedDate | Once auditing is enabled for tracked entities (by setting allowAuditLog of tracked entity types to true), all read and search operations are logged. The endpoint for accessing audit logs is located at: | 选项 |
| Table: Aggregate data value query parameters | 假 | 选项 |
| 定义要返回的页码。 | Parameter | Data approval workflow ID |
| 定义每页返回的元素数量。 | Parameter | Organisation unit ID |
One or more organisation unit identifiers
冠捷
Attribute option combo ID
One or more attribute option combination identifiers