Skip to content

Commit

Permalink
chore: autopublish 2024-05-24T21:26:01Z
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed May 24, 2024
1 parent 12c3491 commit 442a467
Show file tree
Hide file tree
Showing 989 changed files with 193,601 additions and 6,878 deletions.
2 changes: 1 addition & 1 deletion projects/dhis2-single-page-docs/am_ET/.cache_timestamp
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024-05-23T21:22:52Z
2024-05-24T21:24:55Z
2 changes: 1 addition & 1 deletion projects/dhis2-single-page-docs/ar/.cache_timestamp
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024-05-23T21:22:52Z
2024-05-24T21:24:55Z
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
revision_date: '2024-05-21'
tags:
- DHIS core version 2.38
- Develop
- DHIS core version 2.38
template: single.html
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
revision_date: '2024-05-21'
revision_date: '2024-05-23'
tags:
- Develop
- DHIS core version 2.39
Expand Down Expand Up @@ -5112,7 +5112,7 @@ supplied.

### Import parameters { #webapi_data_values_import_parameters }

The import process can be customized using a set of import parameters:
The import process can be customized using a set of import parameters.

Table: Import parameters

Expand Down Expand Up @@ -5253,8 +5253,6 @@ information.
The following section describes the CSV format used in DHIS2. The first
row is assumed to be a header row and will be ignored during import.



Table: CSV format of DHIS2

||||
Expand Down Expand Up @@ -5313,8 +5311,7 @@ GET /api/dataValueSets

Data values can be retrieved in *XML*, *JSON*, *CSV*, and *ADX* format. Since we want to read data we will use the *GET* HTTP verb. We will also specify that we are
interested in the XML resource representation by including an `Accept` HTTP header with our request. The following query parameters are
accepted:

available.

Table: Data value set query parameters

Expand Down Expand Up @@ -5342,11 +5339,13 @@ Table: Data value set query parameters
| categoryIdScheme | Property of the category object to use in the response (ADX only). |
| categoryOptionIdScheme | Property of the category option object to use in the response (ADX only). |
| idScheme | Property of any of the above objects if they are not specified, to use in the response. If not specified, the default idScheme for ADX is code, and for all other formats is uid. |
| inputOrgUnitIdScheme | Identification property used for the provided `orgUnit` parameter values; `id` or `code` |
| inputDataSetIdScheme | Identification property used for the provided `dataSet` parameter values; `id` or `code` |
| inputDataElementGroupIdScheme | Identification property used for the provided `dataElementGroup` parameter values; `id` or `code` |
| inputDataElementIdScheme | Identification property used for the provided `dataElement` parameter values; `id` or `code` |
| inputIdScheme | Identification property used for any of the provided `dataSet`, `dataElementGroup`, `orgUnit`, `orgUnitGroup`, `attributeOptionCombo` parameter values unless any of the three schemes above explicitly overrides this input default; `id` or `code` |
| inputOrgUnitIdScheme | Identifier property used for the provided `orgUnit` parameter values; `id` or `code` |
| inputDataSetIdScheme | Identifier property used for the provided `dataSet` parameter values; `id` or `code` |
| inputDataElementGroupIdScheme | Identifier property used for the provided `dataElementGroup` parameter values; `id` or `code` |
| inputDataElementIdScheme | Identifier property used for the provided `dataElement` parameter values; `id` or `code` |
| inputIdScheme | General identifier property used for all object types, specific identifier schemes will override the general scheme; `id` or `code` |
| compression | Whether to compress the response payload; `none`, `gzip` or `zip` |
| attachment | File name to use for the response, a non-blank value indicates rendering the response as an attachment. |

The following parameters from the list above are required:
- either dataSet or dataElementGroup (for ADX this must be dataSet)
Expand Down Expand Up @@ -5409,7 +5408,7 @@ You can request the data in JSON format like this:

/api/dataValueSets.json?dataSet=pBOMPrpg1QX&period=201401&orgUnit=DiszpKrYNg8

The response will look something like this:
The response will look like this:

```json
{
Expand Down Expand Up @@ -5453,8 +5452,7 @@ deletions. You can include deleted values in the response like this:

You can also request data in CSV format like this:

/api/dataValueSets.csv?dataSet=pBOMPrpg1QX&period=201401
&orgUnit=DiszpKrYNg8
/api/dataValueSets.csv?dataSet=pBOMPrpg1QX&period=201401&orgUnit=DiszpKrYNg8

The response will look like this:

Expand All @@ -5466,6 +5464,14 @@ eY5ehpbEsB7,201401,DiszpKrYNg8,bRowv6yZOF2,bRowv6yZOF2,16,system,2015-04-05T19:5
FTRrcoaog83,201401,DiszpKrYNg8,bRowv6yZOF2,bRowv6yZOF2,12,system,2014-03-02T21:45:05.519,comment4,false
```

Request data values in CSV format compressed with `gzip`:

```
/api/dataValueSets.csv?dataSet=pBOMPrpg1QX&period=202401&orgUnit=DiszpKrYNg8&compression=gzip
```

The response will be in compressed CSV format. The content can be uncompressed with the `gunzip` tool.

The following constraints apply to the data value sets resource:

- At least one data set must be specified.
Expand Down Expand Up @@ -5900,7 +5906,6 @@ Bulk update equally confirms with a `200 OK` on success or returns a
`409 Conflict` in case of input errors.



# Data validation { #data-validation }

## Validation { #webapi_validation }
Expand Down Expand Up @@ -13390,6 +13395,7 @@ All entry points are secured by authorization. The `F_PERFORM_ANALYTICS_EXPLAIN`
/api/analytics/enrollment/query/{program}/explain



# Maintenance { #maintenance }

## Resource and analytics tables { #webapi_generating_resource_analytics_tables }
Expand Down Expand Up @@ -16050,6 +16056,7 @@ You can fetch the CSS content with a GET-request:
To remove the JavaScript content you can use a DELETE request.



# Tracker { #tracker }

> **Note**
Expand Down Expand Up @@ -18684,6 +18691,7 @@ Table: Query program messages API
| processedDate | /api/33/messages?processedDate=2016-02-01 |



# New Tracker { #new-tracker }

Version 2.36 of DHIS2 introduced a set of new tracker endpoints dedicated to importing and querying tracker objects (Including tracked entities, enrollments, events, and relationships).
Expand Down Expand Up @@ -20829,6 +20837,7 @@ These access levels are only triggered when users try to interact with program d
4. Closed: This is the most restricted access level. Data recorded under programs configured with access level CLOSED will not be accessible if the Owner Organisation Unit does not fall within the user's capture scope. It is also not possible to break the glass or gain temporary ownership in this configuration. Note that it is still possible to transfer the ownership to another organisation unit. Only a user who has access to the data can transfer the ownership of a TrackedEntity-Program combination to another Organisation Unit. If ownership is transferred, the Owner Organisation Unit is updated.



# Email { #email }

## Email { #webapi_email }
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
revision_date: '2024-05-21'
revision_date: '2024-05-23'
tags:
- Develop
- DHIS core version 2.40
Expand Down Expand Up @@ -5154,7 +5154,7 @@ supplied.

### Import parameters { #webapi_data_values_import_parameters }

The import process can be customized using a set of import parameters:
The import process can be customized using a set of import parameters.

Table: Import parameters

Expand Down Expand Up @@ -5296,8 +5296,6 @@ information.
The following section describes the CSV format used in DHIS2. The first
row is assumed to be a header row and will be ignored during import.



Table: CSV format of DHIS2

||||
Expand Down Expand Up @@ -5356,8 +5354,7 @@ GET /api/dataValueSets

Data values can be retrieved in *XML*, *JSON*, *CSV*, and *ADX* format. Since we want to read data we will use the *GET* HTTP verb. We will also specify that we are
interested in the XML resource representation by including an `Accept` HTTP header with our request. The following query parameters are
accepted:

available.

Table: Data value set query parameters

Expand Down Expand Up @@ -5385,11 +5382,13 @@ Table: Data value set query parameters
| categoryIdScheme | Property of the category object to use in the response (ADX only). |
| categoryOptionIdScheme | Property of the category option object to use in the response (ADX only). |
| idScheme | Property of any of the above objects if they are not specified, to use in the response. If not specified, the default idScheme for ADX is code, and for all other formats is uid. |
| inputOrgUnitIdScheme | Identification property used for the provided `orgUnit` parameter values; `id` or `code` |
| inputDataSetIdScheme | Identification property used for the provided `dataSet` parameter values; `id` or `code` |
| inputDataElementGroupIdScheme | Identification property used for the provided `dataElementGroup` parameter values; `id` or `code` |
| inputDataElementIdScheme | Identification property used for the provided `dataElement` parameter values; `id` or `code` |
| inputIdScheme | Identification property used for any of the provided `dataSet`, `dataElementGroup`, `orgUnit`, `orgUnitGroup`, `attributeOptionCombo` parameter values unless any of the three schemes above explicitly overrides this input default; `id` or `code` |
| inputOrgUnitIdScheme | Identifier property used for the provided `orgUnit` parameter values; `id` or `code` |
| inputDataSetIdScheme | Identifier property used for the provided `dataSet` parameter values; `id` or `code` |
| inputDataElementGroupIdScheme | Identifier property used for the provided `dataElementGroup` parameter values; `id` or `code` |
| inputDataElementIdScheme | Identifier property used for the provided `dataElement` parameter values; `id` or `code` |
| inputIdScheme | General identifier property used for all object types, specific identifier schemes will override the general scheme; `id` or `code` |
| compression | Whether to compress the response payload; `none`, `gzip` or `zip` |
| attachment | File name to use for the response, a non-blank value indicates rendering the response as an attachment. |

The following parameters from the list above are required:
- either dataSet or dataElementGroup (for ADX this must be dataSet)
Expand Down Expand Up @@ -5452,7 +5451,7 @@ You can request the data in JSON format like this:

/api/dataValueSets.json?dataSet=pBOMPrpg1QX&period=201401&orgUnit=DiszpKrYNg8

The response will look something like this:
The response will look like this:

```json
{
Expand Down Expand Up @@ -5496,8 +5495,7 @@ deletions. You can include deleted values in the response like this:

You can also request data in CSV format like this:

/api/dataValueSets.csv?dataSet=pBOMPrpg1QX&period=201401
&orgUnit=DiszpKrYNg8
/api/dataValueSets.csv?dataSet=pBOMPrpg1QX&period=201401&orgUnit=DiszpKrYNg8

The response will look like this:

Expand All @@ -5509,6 +5507,14 @@ eY5ehpbEsB7,201401,DiszpKrYNg8,bRowv6yZOF2,bRowv6yZOF2,16,system,2015-04-05T19:5
FTRrcoaog83,201401,DiszpKrYNg8,bRowv6yZOF2,bRowv6yZOF2,12,system,2014-03-02T21:45:05.519,comment4,false
```

Request data values in CSV format compressed with `gzip`:

```
/api/dataValueSets.csv?dataSet=pBOMPrpg1QX&period=202401&orgUnit=DiszpKrYNg8&compression=gzip
```

The response will be in compressed CSV format. The content can be uncompressed with the `gunzip` tool.

The following constraints apply to the data value sets resource:

- At least one data set must be specified.
Expand Down Expand Up @@ -5943,7 +5949,6 @@ Bulk update equally confirms with a `200 OK` on success or returns a
`409 Conflict` in case of input errors.



# Data validation { #data-validation }

## Validation { #webapi_validation }
Expand Down Expand Up @@ -16364,7 +16369,7 @@ To remove the JavaScript content you can use a DELETE request.
>(deprecated)](https://docs.dhis2.org/en/develop/using-the-api/dhis-core-version-master/tracker-deprecated.html)
>describes the deprecated endpoints
>
> * `GET/POST/PUT/DELETE /api/trackedEntityInstance`
> * `GET/POST/PUT/DELETE /api/trackedEntityInstances`
> * `GET/POST/PUT/DELETE /api/enrollments`
> * `GET/POST/PUT/DELETE /api/events`
> * `GET/POST/PUT/DELETE /api/relationships`
Expand Down Expand Up @@ -16483,7 +16488,7 @@ In the API, the significant difference is that all events are either connected t
| attributeOptionCombo | Attribute option combo for the event. Default if not supplied or configured. | No | No | String:Uid | ABCDEF12345
| attributeCategoryOptions | Attribute category option for the event. Default if not supplied or configured. | No | No | String:Uid | ABCDEF12345
| assignedUser | A reference to a user who has been assigned to the event. | No | No | User | {<br>"uid": "ABCDEF12345",<br>"username": "username",<br>"firstName": "John",<br>"surname": "Doe"<br>} |
| dataValues | A list of data values connected to the event. | No | No | List of TrackedEntityAttributeValue | See Attribute |
| dataValues | A list of data values connected to the event. | No | No | List of DataElementValue | See Data Values |
| relationships | A list of relationships connected to the event. | No | No | List of Relationship | See Relationship |
| notes | Notes connected to the event. It can only be created. | No | Yes | List of Note | See Note |

Expand Down Expand Up @@ -18527,6 +18532,7 @@ These access levels are only triggered when users try to interact with program d
4. Closed: This is the most restricted access level. Data recorded under programs configured with access level CLOSED will not be accessible if the Owner Organisation Unit does not fall within the user's capture scope. It is also not possible to break the glass or gain temporary ownership in this configuration. Note that it is still possible to transfer the ownership to another organisation unit. Only a user who has access to the data can transfer the ownership of a TrackedEntity-Program combination to another Organisation Unit. If ownership is transferred, the Owner Organisation Unit is updated.



# Tracker (deprecated APIs) { #tracker-deprecated-apis }

> **Note**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
revision_date: '2024-05-21'
revision_date: '2024-05-23'
tags:
- DHIS core version master
- Develop
- DHIS core version master
template: single.html
---

Expand Down Expand Up @@ -5694,7 +5694,7 @@ supplied.

### Import parameters { #webapi_data_values_import_parameters }

The import process can be customized using a set of import parameters:
The import process can be customized using a set of import parameters.

Table: Import parameters

Expand Down Expand Up @@ -5836,8 +5836,6 @@ information.
The following section describes the CSV format used in DHIS2. The first
row is assumed to be a header row and will be ignored during import.



Table: CSV format of DHIS2

||||
Expand Down Expand Up @@ -5896,8 +5894,7 @@ GET /api/dataValueSets

Data values can be retrieved in *XML*, *JSON*, *CSV*, and *ADX* format. Since we want to read data we will use the *GET* HTTP verb. We will also specify that we are
interested in the XML resource representation by including an `Accept` HTTP header with our request. The following query parameters are
accepted:

available.

Table: Data value set query parameters

Expand Down Expand Up @@ -5925,11 +5922,13 @@ Table: Data value set query parameters
| categoryIdScheme | Property of the category object to use in the response (ADX only). |
| categoryOptionIdScheme | Property of the category option object to use in the response (ADX only). |
| idScheme | Property of any of the above objects if they are not specified, to use in the response. If not specified, the default idScheme for ADX is code, and for all other formats is uid. |
| inputOrgUnitIdScheme | Identification property used for the provided `orgUnit` parameter values; `id` or `code` |
| inputDataSetIdScheme | Identification property used for the provided `dataSet` parameter values; `id` or `code` |
| inputDataElementGroupIdScheme | Identification property used for the provided `dataElementGroup` parameter values; `id` or `code` |
| inputDataElementIdScheme | Identification property used for the provided `dataElement` parameter values; `id` or `code` |
| inputIdScheme | Identification property used for any of the provided `dataSet`, `dataElementGroup`, `orgUnit`, `orgUnitGroup`, `attributeOptionCombo` parameter values unless any of the three schemes above explicitly overrides this input default; `id` or `code` |
| inputOrgUnitIdScheme | Identifier property used for the provided `orgUnit` parameter values; `id` or `code` |
| inputDataSetIdScheme | Identifier property used for the provided `dataSet` parameter values; `id` or `code` |
| inputDataElementGroupIdScheme | Identifier property used for the provided `dataElementGroup` parameter values; `id` or `code` |
| inputDataElementIdScheme | Identifier property used for the provided `dataElement` parameter values; `id` or `code` |
| inputIdScheme | General identifier property used for all object types, specific identifier schemes will override the general scheme; `id` or `code` |
| compression | Whether to compress the response payload; `none`, `gzip` or `zip` |
| attachment | File name to use for the response, a non-blank value indicates rendering the response as an attachment. |

The following parameters from the list above are required:
- either dataSet or dataElementGroup (for ADX this must be dataSet)
Expand Down Expand Up @@ -5992,7 +5991,7 @@ You can request the data in JSON format like this:

/api/dataValueSets.json?dataSet=pBOMPrpg1QX&period=201401&orgUnit=DiszpKrYNg8

The response will look something like this:
The response will look like this:

```json
{
Expand Down Expand Up @@ -6036,8 +6035,7 @@ deletions. You can include deleted values in the response like this:

You can also request data in CSV format like this:

/api/dataValueSets.csv?dataSet=pBOMPrpg1QX&period=201401
&orgUnit=DiszpKrYNg8
/api/dataValueSets.csv?dataSet=pBOMPrpg1QX&period=201401&orgUnit=DiszpKrYNg8

The response will look like this:

Expand All @@ -6049,6 +6047,14 @@ eY5ehpbEsB7,201401,DiszpKrYNg8,bRowv6yZOF2,bRowv6yZOF2,16,system,2015-04-05T19:5
FTRrcoaog83,201401,DiszpKrYNg8,bRowv6yZOF2,bRowv6yZOF2,12,system,2014-03-02T21:45:05.519,comment4,false
```

Request data values in CSV format compressed with `gzip`:

```
/api/dataValueSets.csv?dataSet=pBOMPrpg1QX&period=202401&orgUnit=DiszpKrYNg8&compression=gzip
```

The response will be in compressed CSV format. The content can be uncompressed with the `gunzip` tool.

The following constraints apply to the data value sets resource:

- At least one data set must be specified.
Expand Down Expand Up @@ -6483,7 +6489,6 @@ Bulk update equally confirms with a `200 OK` on success or returns a
`409 Conflict` in case of input errors.



# Data validation { #data-validation }

## Validation { #webapi_validation }
Expand Down Expand Up @@ -21438,7 +21443,7 @@ Table: Organisation unit selection modes
| DESCENDANTS | All children, i.e. at only levels below, e.g. including children of children, of the organisation units defined in the request. |
| ACCESSIBLE | All descendants of the data view organisation units associated with the current user. Will fall back to data capture organisation units associated with the current user if the former is not defined. |
| CAPTURE | The data capture organisation units associated with the current user and all children, i.e. all organisation units in the sub-hierarchy. |
| ALL | All organisation units in the system. Requires authority. |
| ALL | All organisation units in the system. Requires `ALL` authority. |

Note that you can specify "attribute" with filters or directly using the "filter" params for constraining the
instances to return.
Expand Down Expand Up @@ -21848,7 +21853,7 @@ Table: Organisation unit selection modes
| CHILDREN | Immediate children, i.e. only the first level below, of the organisation units defined in the request. |
| DESCENDANTS | All children, i.e. at only levels below, e.g. including children of children, of the organisation units defined in the request. |
| ACCESSIBLE | All descendants of the data view organisation units associated with the current user. Will fall back to data capture organisation units associated with the current user if the former is not defined. |
| ALL | All organisation units in the system. Requires authority. |
| ALL | All organisation units in the system. Requires `ALL` authority. |

The query is case insensitive. The following rules apply to the query
parameters.
Expand Down
2 changes: 1 addition & 1 deletion projects/dhis2-single-page-docs/cs/.cache_timestamp
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024-05-23T21:23:01Z
2024-05-24T21:25:02Z
Loading

0 comments on commit 442a467

Please sign in to comment.