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

whiskers` would now show the updated `favFood`:¶

{
    "name": "wisker",
    "favFood": [
        "carrot",
        "rabbit"
    ]
}

Benefits { #benefits }

smaller payloads required for small changes

less error-prone (no copy-pasting large entries to change 1 property)

Roll (Experimental) { #roll-experimental }
The roll request param enables the user to have a 'rolling' number of elements in an array. In our example we have the favFood array. If we wanted to update this array previously, we'd have to supply the whole payload like so:
PUT /api/{store}/pets/whiskers with body

```json { "name": "wisker", "favFood": [ "fish", "rabbit", "carrot" ] }

- Now we can use the `roll` request param (with the `path` functionality) to state that we want the rolling functionality for _n_ number of elements.
In this example we state that we want the array to have a rolling value of 3, passing in an extra element in the call.  
`PUT` `/api/{store}/pets/whiskers?roll=3&path=favFood` with body `"carrot"` would result in the following state.
- ```json
{
    "name": "wisker",
    "favFood": [
        "fish",
        "rabbit",
        "carrot"
    ]
}

Since we passed the rolling value of 3, this indicates that we only want the last 3 elements passed into the array. So if we now make another call and add a new element to the array, we would expect the first element (fish) to be dropped from the array. PUT /api/{store}/pets/whiskers?roll=3&path=favFood with body "bird" would result in the following state:

```json¶

{ "name": "wisker", "favFood": [ "rabbit", "carrot", "bird" ] }

> **Note**
>
> Once a rolling value has been set (e.g. `role=3`), it can only be increased (e.g. `roll=5`) and cannot be decreased (e.g. `roll=2`)

Dot notation does allow for nested calls. Let's say we have this current entry value:

```json
{
  "name": "wisker",
  "favFood": [
    "fish", "rabbit"
  ],
  "type": {
    "breed": ["shorthair"]
  }
}

If we wanted to add another breed using a rolling array we could make the call: PUT /api/{store}/pets/whiskers?roll=3&path=type.breed with body "small" which would result in the following state:

{
  "name": "wisker",
  "favFood": [
    "fish", "rabbit"
  ],
  "type": {
    "breed": ["shorthair, small"]
  }
}

Benefits¶

Only interested in keeping track of n values which may change over time

Organisation unit profile { #org_unit_profile }

The organisation unit profile resource allows you to define and retrieve an information profile for organisation units in DHIS 2.

```¶

/api/organisationUnitProfile

A single organisation unit profile can be created and applies to all organisation units.

The information part of the organisation unit profile includes:

Name, short name, description, parent organisation unit, level, opening date, closed date, URL.

* Contact person, address, email, phone number (if exists).
* Location (longitude/latitude).

Metadata attributes (configurable).

* Organisation unit group sets and groups (configurable).
* Aggregate data for data elements, indicators, reporting rates, program indicators (configurable).
* Create organisation unit profile { #create-organisation-unit-profile } 
* 要定义组织单位配置文件,可以使用`POST`请求:

POST /api/organisationUnitProfile

JSON 格式的有效载荷如下所示,其中`attributes `指元数据属性,`groupSets `指组织单位组集,`dataItems `指数据元素、指标、数据集和计划指标:

```json
{
  "attributes": [
    "xqWyz9jNCA5",
    "n2xYlNbsfko"
  ],
  "groupSets": [
    "Bpx0589u8y0",
    "J5jldMd8OHv"
  ],
  "dataItems": [
    "WUg3MYWQ7pt",
    "vg6pdjObxsm",
    "DTVRnCGamkV",
    "Uvn6LCg7dVU",
    "eTDtyyaSA7f"
  ]
}

The F_ORG_UNIT_PROFILE_ADD authority is required to define the profile.

Get organisation unit profile { #get-organisation-unit-profile }

To retrieve the organisation unit profile definition you can use a `GET` request:¶

GET /api/organisationUnitProfile

The response will be in JSON format.

Get organisation unit profile data { #get-organisation-unit-profile-data }

To retrieve the organisation unit profile data you can use a GET request:

GET /api/organisationUnitProfile/{org-unit-id}/data?period={iso-period}

The organisation unit profile data endpoint will combine the profile definition with the associated information/data values.

org-unit-id路径变量为必填项,指要提供汇总数据的组织单位的 ID。

查询参数 iso-period是可选参数,指的是为数据项提供汇总数据的 ISO 期间 ID。如果没有指定,则将使用 this year 相对期间作为后备。

The response will include the following sections:

info: Fixed information about the organisation unit.

属性:元数据属性及相应的属性值。

组集:组织单位组集,包含该组织单位所属的相应组织单位组。

数据项带有相应汇总数据值的数据项。

Note that access control checks are performed and metadata items which are not accessible to the current user will be omitted.¶

请求示例如下所示:

GET /api/organisationUnitProfile/DiszpKrYNg8/data?period=2021

The profile data response payload in JSON format will look like this, where the id and label fields refer to the metadata item, and the value field refers to the associated value:

{
  "info": {
    "id": "DiszpKrYNg8",
    "code": "OU_559",
    "name": "Ngelehun CHC",
    "shortName": "Ngelehun CHC",
    "parentName": "Badjia",
    "level": 4,
    "levelName": "Facility",
    "openingDate": "1970-01-01T00:00:00.000",
    "longitude": -11.4197,
    "latitude": 8.1039
  },
  "attributes": [
    {
      "id": "n2xYlNbsfko",
      "label": "NGO ID",
      "value": "GHE51"
    },
    {
      "id": "xqWyz9jNCA5",
      "label": "TZ code",
      "value": "NGE54"
    }
  ],
  "groupSets": [
    {
      "id": "Bpx0589u8y0",
      "label": "Facility Ownership",
      "value": "Public facilities"
    },
    {
      "id": "J5jldMd8OHv",
      "label": "Facility Type",
      "value": "CHC"
    }
  ],
  "dataItems": [
    {
      "id": "WUg3MYWQ7pt",
      "label": "Total Population",
      "value": 3503
    },
    {
      "id": "DTVRnCGamkV",
      "label": "Total population < 1 year",
      "value": 140
    },
    {
      "id": "vg6pdjObxsm",
      "label": "Population of women of child bearing age (WRA)",
      "value": 716
    },
    {
      "id": "Uvn6LCg7dVU",
      "label": "ANC 1 Coverage",
      "value": 368.2
    },
    {
      "id": "eTDtyyaSA7f",
      "label": "FIC <1y",
      "value": 291.4
    }
  ]
}

Upload image for organisation unit { #upload-image-for-organisation-unit }

要为组织单位上传图片,可以使用 fileResources 端点。

PUT /api/{store}/pets/whiskers?path=favFood.[0] with body "carrot" updates the first element in the favFood array only. So a GET request to /api/{store}/pets/whiskers would now show the updated favFood:¶