Skip to content

Aggregate data values

DataValue + DataValueSet — the envelope /api/dataValueSets GET returns and the round-trippable shape analytics can serialise.

aggregate

Typed models for DHIS2 aggregate data values (shim over generated/v42/oas).

Covers the /api/dataValueSets GET response (a DataValueSet envelope containing a list of DataValues). The corresponding POST/import path returns a WebMessageResponse (see dhis2w_client/envelopes.py).

Distinct from the generated DataElement / DataSet / CategoryOptionCombo metadata models (those come out of /api/schemas codegen) — these describe the runtime values captured against that metadata. OpenAPI ships both shapes under components/schemas/{DataValue,DataValueSet}.

Classes

DataValue

Bases: BaseModel

OpenAPI schema DataValue.

Source code in packages/dhis2w-client/src/dhis2w_client/generated/v42/oas/data_value.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
class DataValue(_BaseModel):
    """OpenAPI schema `DataValue`."""

    model_config = _ConfigDict(extra="allow", populate_by_name=True, defer_build=True)

    attributeOptionCombo: str | None = None
    categoryOptionCombo: str | None = None
    comment: str | None = None
    created: str | None = None
    dataElement: str | None = None
    deleted: bool | None = None
    followup: bool | None = None
    lastUpdated: str | None = None
    orgUnit: str | None = None
    period: str | None = None
    storedBy: str | None = None
    value: str | None = None

DataValueSet

Bases: BaseModel

OpenAPI schema DataValueSet.

Source code in packages/dhis2w-client/src/dhis2w_client/generated/v42/oas/data_value_set.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class DataValueSet(_BaseModel):
    """OpenAPI schema `DataValueSet`."""

    model_config = _ConfigDict(extra="allow", populate_by_name=True, defer_build=True)

    attributeCategoryOptions: list[str] | None = None
    attributeOptionCombo: str | None = None
    categoryOptionComboIdScheme: str | None = None
    completeDate: str | None = None
    dataElementIdScheme: str | None = None
    dataSet: str | None = None
    dataSetIdScheme: str | None = None
    dataValues: list[DataValue] | None = None
    dryRun: bool | None = None
    idScheme: str | None = None
    orgUnit: str | None = None
    orgUnitIdScheme: str | None = None
    period: str | None = None
    strategy: str | None = None