元数据¶

?idScheme=CODE&orgUnitIdScheme=UID

？idScheme = CODE＆orgUnitIdScheme = UID

？orgUnitIdScheme =属性：j38fk2dKFsG＆dataElementIdScheme = CODE

/api/dataElements?query=贫血

/ api / dataElements？query =贫血

/api/indicatorGroups.json?paging=false

/api/indicators.json?order=shortName:desc

/api/indicators.json?order=created:desc,name:asc

/ api / identifiableObjects / <id>

{
  "id": "FTRrcoaog83",
  "displayName": "Accute French",
  "translations": [
    {
      "property": "SHORT_NAME",
      "locale": "fr",
      "value": "Accute French"
    },
    {
      "property": "NAME",
      "locale": "fr",
      "value": "Accute French"
    }
  ]
}

{
  "id": "FTRrcoaog83",
  "displayName": "Accute Flaccid Paralysis (Deaths < 5 yrs)",
  "translations": [
    {
      "property": "FORM_NAME",
      "locale": "en_FK",
      "value": "aa"
    },
    {
      "property": "SHORT_NAME",
      "locale": "en_GB",
      "value": "Accute Flaccid Paral"
    },
    {
      "property": "SHORT_NAME",
      "locale": "fr",
      "value": "Accute French"
    },
    {
      "property": "NAME",
      "locale": "fr",
      "value": "Accute French"
    },
    {
      "property": "NAME",
      "locale": "en_FK",
      "value": "aa"
    },
    {
      "property": "DESCRIPTION",
      "locale": "en_FK",
      "value": "aa"
    }
  ]
}

{
  "property": "NAME",
  "locale": "fr",
  "value": "Paralysie Flasque Aiguë (Décès <5 ans)"
}

{
  "translations": [
    {
      "property": "NAME",
      "locale": "fr",
      "value": "Paralysie Flasque Aiguë (Décès <5 ans)"
    }
  ]
}

/ api / 33 / dataElements

/ api / dataElements？filter = id：eq：ID1＆filter = id：eq：ID2

/api/dataElements.json?filter=aggregationOperator:eq:sum&filter=type:eq:int

/api/dataElements.json?filter=dataElementGroups.id:eq:qfxEYY9xAl6

/api/dataElements.json?filter=attributeValues.attribute.id:eq:n2xYlNbsfko&filter=attributeValues.value:eq:AFP

/api/dataElements?filter=optionSet:!null

/api/dataElements.json?filter=id:in:[fbfJHSPpUQD,cYeuwXTCPkU]

/api/dataElements.json?filter=id:in:[id1,id2]&filter=code:eq:code1&rootJunction=OR

/api/dataElements.json?filter=identifiable:token:ANC访问

/api/dataElements.json?filter=identifiable:token:ANC visit＆filter = displayName：ilike：tt1

/api/dataElements.json?filter=identifiable:token:ANC访问
  ＆filter = displayName：ilike：tt1＆rootJunction = OR

/api/trackedEntityAttributtes.json?indexableOnly=true

/api/trackedEntityAttributtes.json?filter=name:like:ANC&indexableOnly=true

/ api / indicators？fields = id，名称

/ api / dataElements？fields = id，name，dataSets [id，name]

/ api / dataSets？fields =：all，！organizationUnits

/ api / dataSets / BfMAe6Itzgt？fields = id，name，organisationUnits [：all，！id]

/api/dataElements/ID?fields=id~rename(i),name~rename(n)

/api/dataElementGroups.json?fields=id,displayName,dataElements~isNotEmpty~rename(haveDataElements）

/api/dataElements?fields=dataSets~size

/api/dataElements?fields=dataSets~isEmpty

/api/dataElements?fields=dataSets~isNotEmpty

/api/dataElements/ID?fields=id~rename(i),name~rename(n)

/api/dataElements/ID?fields=id~rename(i),name~rename(n)

/api/categoryOptions.json?fields=id,organisationUnits~pluck

/api/categoryOptions.json?fields=id,organisationUnits~pluck[name]。

/api/dataElementGroups.json?fields=id,name,dataElements~keyBy[id,name,valueType]。

/api/dataElementGroups.json?fields=id,name,dataElements~keyBy(valueType)[id,name,valueType]。

/ api / <entityName>

/ api / dataElements

http：// <server> /api/schemas/constant.json

{
  "name": "PI",
  "value": "3.14159265359"
}

<constant name="PI" xmlns="http://dhis2.org/schema/dxf/2.0">
  <value>3.14159265359</value>
</constant>

curl -d @constant.json "http://server/api/constants" -X POST
  -H "Content-Type: application/json" -u user:password

curl -d @constant.json "https://play.dhis2.org/api/constants" -X POST
  -H "Content-Type: application/json" -u admin:district

{
  "status": "SUCCESS",
  "importCount": {
    "imported": 1,
    "updated": 0,
    "ignored": 0,
    "deleted": 0
  },
  "type": "Constant"
}

curl -X PUT -d @pi.json -H "Content-Type: application/json"
  -u user:password "http://server/api/constants/ID"

curl -X DELETE -u user:password "http://server/api/constants/ID"

/ api / {collection-object} / {collection-object-id} / {collection-name} / {object-id}

删除/ api / dataElementGroups / IDA / dataElements / IDB

POST / api / categories / IDA / categoryOptions / IDB

{
  "identifiableObjects": [{
      "id": "IDA"
    }, {
      "id": "IDB"
    }, {
      "id": "IDC"
    }
  ]
}

POST / api / categories / IDA / categoryOptions

删除/ api / categories / IDA / categoryOptions

删除/ api / categories / IDA / categoryOptions

POST / api / categories / IDA / categoryOptions

{
  "additions": [{
      "id": "IDA"
    }, {
      "id": "IDB"
    }, {
      "id": "IDC"
    }
  ],
  "deletions": [{
      "id": "IDD"
    }, {
      "id": "IDE"
    }, {
      "id": "IDF"
    }
  ]
}

POST / api / schemas / constant

curl -X POST -d "{\"name\": \"some name\"}" -H "Content-Type: application/json"
  -u admin:district "https://play.dhis2.org/dev/api/schemas/dataElement"

[
   {
      "message" : "Required property missing.",
      "property" : "type"
   },
   {
      "property" : "aggregationOperator",
      "message" : "Required property missing."
   },
   {
      "property" : "domainType",
      "message" : "Required property missing."
   },
   {
      "property" : "shortName",
      "message" : "Required property missing."
   }
]

从 orgUnit 组中删除特定 orgUnit{ #remove-a-specific-orgunit-from-an-orgunit-group } 

##### ```json
[
  {"op": "add", "path": "/dataElements/-", "value": {"id": "data-element-id"}}
]

PATCH /api/dataElementGroups/{id}

更改数据元素的域和值类型{ #change-domain-and-value-type-of-a-data-element } 

##### ```json
[
    {"op": "add", "path": "/domainType", "value": "TRACKER"},
    {"op": "add", "path": "/valueType", "value": "INTEGER"}
]

PATCH /api/organisationUnitGroups/{id}

受阻 将 dataElementGroup 添加到 dataElement{ #blocked-add-dataelementgroup-to-dataelement } 

#### ```json
[
    {"op": "add", "path": "/dataElementGroups/-", "value": {"id": "data-element-group-id"}}
]

PATCH /api/dataElements/{id}?importReportMode=ERRORS_NOT_OWNER

按 id 删除收藏项{ #remove-collection-item-by-id } 

#### ```json
[
    {"op": "remove-by-id", "path": "/organisationUnits", "id": "u6CvKyF0Db5"}
]

补丁 /api/dataSets/{id}?importReportMode=ERRORS_NOT_OWNER

[
    {"op": "remove-by-id", "path": "/organisationUnits", "id": "u6CvKyF0Db5"}
]

如果`path`属性无效或不存在，则修补服务将返回如下错误。

```json
[
    {"op": "remove-by-id", "path": "/test", "id": "u6CvKyF0Db5"}
]

{
    "httpStatus": "Bad Request",
    "httpStatusCode": 400,
    "status": "ERROR",
    "message": "Invalid path /test"
}

/api/organisationUnits.csv?fields=id,displayName,organisationUnitGroups,geometry

/ api /元数据

/ api /元数据

/ api / metadata？defaultOrder = lastUpdated：desc

/ api / metadata？indicators = true＆indicatorGroups = true

/ api / metadata？dataElements：fields = id，name＆dataElements：order = displayName：desc

/api/metadata?filter=name:startsWith:ANC&dataElements=true&indicators=true

/ api /元数据

{
  "dataElements": [
    {
      "name": "EPI - IPV 3 doses given",
      "shortName": "EPI - IPV 3 doses given",
      "aggregationType": "SUM",
      "domainType": "AGGREGATE",
      "valueType": "INTEGER_ZERO_OR_POSITIVE"
    },
    {
      "name": "EPI - IPV 4 doses given",
      "shortName": "EPI - IPV 4 doses given",
      "aggregationType": "SUM",
      "domainType": "AGGREGATE",
      "valueType": "INTEGER_ZERO_OR_POSITIVE"
    }
  ],
  "indicators": [
    {
      "name": "EPI - ADS stock used",
      "shortName": "ADS stock used",
      "numerator": "#{LTb8XeeqeqI}+#{Fs28ZQJET6V}-#{A3mHIZd2tPg}",
      "numeratorDescription": "ADS 0.05 ml used",
      "denominator": "1",
      "denominatorDescription": "1",
      "annualized": false,
      "indicatorType": {
        "id": "kHy61PbChXr"
      }
    }
  ]
}

{
  "importParams": {
    "userOverrideMode": "NONE",
    "importMode": "COMMIT",
    "identifier": "UID",
    "preheatMode": "REFERENCE",
    "importStrategy": "CREATE_AND_UPDATE",
    "atomicMode": "ALL",
    "mergeMode": "REPLACE",
    "flushMode": "AUTO",
    "skipSharing": false,
    "skipTranslation": false,
    "skipValidation": false,
    "metadataSyncImport": false,
    "firstRowIsHeader": true,
    "username": "UNICEF_admin"
  },
  "status": "OK",
  "typeReports": [
    {
      "klass": "org.hisp.dhis.dataelement.DataElement",
      "stats": {
        "created": 2,
        "updated": 0,
        "deleted": 0,
        "ignored": 0,
        "total": 2
      }
    },
    {
      "klass": "org.hisp.dhis.indicator.Indicator",
      "stats": {
        "created": 1,
        "updated": 0,
        "deleted": 0,
        "ignored": 0,
        "total": 1
      }
    }
  ],
  "stats": {
    "created": 3,
    "updated": 0,
    "deleted": 0,
    "ignored": 0,
    "total": 3
  }
}

{ 
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": "O6uvpzGd5pu",
      "geometry": { ... }
    },
    ...
  ]
}

{ 
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": { "code": "OU1_CODE" },
      "geometry": { ... }
    },
    ...
  ]
}

/api/system/taskSummaries/GEOJSON_IMPORT/{job-id}

DELETE /api/organisationUnits/geometry?attributeId={attr-id}

{
  "type": "Polygon",
  "coordinates": [...]
}

DELETE /api/organisationUnits/{id}/geometry?attributeId={attr-id}

GET /api/schemas.json

GET /api/schemas/dataElement.json

{
  key: "mosquito_outline",
  description: "Mosquito outline",
  keywords: [
    "malaria",
    "mosquito",
    "dengue"
  ],
  "created": "2024-02-12T09:50:11.794",
  "lastUpdated": "2024-02-12T09:50:11.794",
  href: "<dhis server>/api/icons/mosquito_outline/icon.svg"
}

{
  key: "mosquito_outline",
  description: "Mosquito outline",
  keywords: [
    "malaria",
    "mosquito",
    "dengue"
  ],
  href: "<dhis server>/api/icons/mosquito_outline/icon.svg"
}

GET /api/icons?keywords=shape,small

GET /api/icons/keywords

{
  "renderingType": {
    "type": "MATRIX"
  }
}

{
  "renderingType": {
    "type": "SLIDER",
    "min": 0,
    "max": 1000,
    "step": 50,
    "decimalPoints": 0
  }
}

{
  "style": {
    "color": "#ffffff",
    "icon": "my-beautiful-icon"
  }
}

/ api /指标

#{P3jJH5Tu5VC.co:FbLZS3ueWbQ}+ #{deGroup:GBHN1a1Jddh.coGroup:OK2Nr4wdfrZ.j8vBiBqGf6O}

#{P3jJH5Tu5VC.coGroup:OK2Nr4wdfrZ&j3C417uW6J7&ddAo6zmIHOk}

(D {eBAyeGv0exc.vV9UWAZohSf} * A {IpHINAT79UW.cejWyOfXge6})/ D {eBAyeGv0exc.GieVkTxp4HH}

（D {eBAyeGv0exc.vV9UWAZohSf} * A {IpHINAT79UW.cejWyOfXge6}）/ D {eBAyeGv0exc.GieVkTxp4HH}

I {EMOt6Fwhs1n} * 1000 /＃{WUg3MYWQ7pt}

R {BfMAe6Itzgt.REPORTING_RATE} *＃{P3jJH5Tu5VC.S34ULMcHMca}

R {BfMAe6Itzgt.ACTUAL_REPORTS} / R {BfMAe6Itzgt.EXPECTED_REPORTS}

N {Rigf2d2Zbjp} *＃{P3jJH5Tu5VC.S34ULMcHMca}

（2 *＃{P3jJH5Tu5VC.S34ULMcHMca}）/（＃{FQ2o8UBlcrS.S34ULMcHMca}-200）* 25

/ api / programIndicators

/ api / expressions / description？expression = <expression-string>

{
  "httpStatus": "OK",
  "httpStatusCode": 200,
  "status": "OK",
  "message": "Valid",
  "description": "Acute Flaccid Paralysis"
}

/ api / 33 / organisationUnits

/ api / 33 / organisationUnits / {id}

/api/33/categoryOptions/orgUnits?categoryOptions={categoryOptionIdA} 、{categoryOptionIdB}

{
  "<categoryOptionIdA>": [
    "<orgUnitUid>",
    "<orgUnitUid>"
  ],
  "<categoryOptionIdB>": [
    "<orgUnitUid>",
    "<orgUnitUid>"
  ],
  "<categoryOptionIdC>": []
}

{
  "<programIdA>": [
    "<orgUnitUid>",
    "<orgUnitUid>"
  ],
  "<programIdB>": [
    "<orgUnitUid>",
    "<orgUnitUid>"
  ],
  "<programIdC>": []
}

/ api / 33 / dataSets

GET /api/33/dataSets/<uid>/version

POST / api / 33 / dataSets / <uid> / version

GET /api/33/dataSetNotficationTemplates

GET /api/33/dataSetNotficationTemplates/<uid>

{
  "name": "dataSetNotificationTemplate1",
  "dataSetNotificationTrigger": "DATA_SET_COMPLETION",
  "relativeScheduledDays": 0,
  "notificationRecipient": "ORGANISATION_UNIT_CONTACT",
  "dataSets": [{
    "id": "eZDhcZi6FLP"
  }],
  "deliveryChannels": ["SMS","EMAIL"],
  "subjectTemplate": "V{data_set_name}",
  "messageTemplate": "V{data_set_name}V{registration_period}",
  "sendStrategy": "SINGLE_NOTIFICATION"
}

GET /api/33/filledOrganisationUnitLevels

{
  "organisationUnitLevels": [{
    "name": "National",
    "level": 1,
    "offlineLevels": 3
  }, {
    "name": "District",
    "level": 2
  }, {
    "name": "Chiefdom",
    "level": 3
  }, {
    "name": "Facility",
    "level": 4
  }]
}

/ api / predictors

POST / api / predictors

"categoryMappingIds": [],

计划规则 { #webapi_program_rules } 

本节是关于发送和读取项目规则,并解释
项目规则数据模型。项目规则赋予功能
在 DHIS2 项目中配置动态行为。

| displayColumnOrder | dataFilters | 表:项目规则操作 |
|---|---|---|
| `{ "periodFrom": -15, "periodTo": 15}` | 下表给出了项目规则的详细概述
模型。 | 表:项目规则操作 |
| displayColumnOrder | 描述 | 表:项目规则操作 |
| dataFilters | 执行项目规则的项目。 | 表:项目规则操作 |
| See an example payload below. | 项目规则显示给 dhis2 配置器的名称。项目最终用户看不到。 | 强制性 |
| 描述 | 项目规则的描述,配置器可用于描述规则。项目的最终用户看不到。| 表:项目规则操作 |
| 项目阶段 | 如果为项目规则设置了项目阶段(programStage),则该规则只能在指定的项目阶段内进行评估。 | 强制性 |

#### 健康)状况

为使项目规则触发其子操作,需要求值为 true 的表达式。表达式使用运算符、函数调用、硬编码值、常量和项目规则变量编写。`d2:hasValue('hemoglobin') && #{hemoglobin} <= 7 `.

强制性

| displayColumnOrder | dataFilters | 表:项目规则操作 |
|---|---|---|
| 计划规则操作模型详细信息 { #program-rule-action-model-details }  | 下表给出了对 programRuleAction 的详细概述
模型。 | 表:项目规则操作 |
| 名称 | 要执行的操作类型。 <br> * `DISPLAYTEXT` - 在给定小部件中显示文本。 <br> * `DISPLAYKEYVALUEPAIR` - 在给定的小部件中显示键和值对（如项目指示器）。 <br> * `HIDEFIELD` - 隐藏指定的 dataElement 或 trackedEntityAttribute。 <br> - *content* - 如果定义，*content* 中的文本将在先前在字段中输入值（现在约为）的情况下向最终用户显示被隐藏（因此被清空）。如果未定义*content*，则在此实例中将向用户显示标准消息。 <br> - *dataElement* - 如果已定义，则当规则有效时，HIDEFIELD 操作将隐藏此 dataElement。 <br> - *trackedEntityDataValue* - 如果定义，则当规则有效时，HIDEFIELD 操作将隐藏此 trackedEntityDataValue。 <br> * `HIDESECTION` - 隐藏指定部分。 <br> - *programStageSection* - 必须定义。这是在父规则有效的情况下将隐藏的programStageSection。 <br> * `ASSIGN` - 为 dataElement 分配一个值（帮助用户计算某些内容或在某处填写明显的值）<br> - *content* - 如果定义，*data* 中的值将分配给该变量。如果定义了内容 ID，并因此分配了一个变量以在其他规则中使用，则还必须分配 *programRule.priority* 以确保具有 ASSIGN 操作的规则在依次评估分配的变量的规则之前运行。 <br> - *data* - 必须定义，数据形成一个表达式，该表达式被计算并分配给变量(#{myVariable} )、数据元素或两者。 <br> - *dataElement* - 如果定义，*data* 中的值将分配给此数据元素。 <br> 必须定义 content 或 dataElement 才能使 ASSIGN 操作生效。 <br> * `SHOWWARNING` - 向用户显示警告，不阻止用户完成活动或注册。 <br> - *content* - 如果定义，内容是显示在错误消息末尾的静态部分。 <br> - *data* - 如果定义，数据会形成一个表达式，该表达式将被计算并添加到警告消息的末尾。 <br> - *dataElement* - 如果已定义，警告消息将显示在此数据元素旁边。 <br> - *trackedEntityAttribute* - 如果定义，警告消息将显示在此跟踪实体属性旁边。 <br> 必须指定 dataElement 或 trackedEntityAttribute。 <br> * `SHOWERROR` - 向用户显示错误，阻止用户完成活动或注册。 <br> - *content* - 如果定义，内容是显示在错误消息开头的静态部分。 <br> - *data* - 如果定义，数据会形成一个表达式，该表达式将被计算并添加到错误消息的末尾。 <br> - *dataElement* - 如果定义，错误消息将链接到此数据元素。 <br> - *trackedEntityAttribute* - 如果定义，错误消息将链接到此跟踪的实体属性。 <br> 必须指定 dataElement 或 trackedEntityAttribute。 <br> * `WARNINGONCOMPLETE` - 在“完成表单”对话框中向用户显示警告，但允许用户完成事件。 <br> - *content* - 如果定义，内容是显示在错误消息末尾的静态部分。 <br> - *data* - 如果定义，数据会形成一个表达式，该表达式将被计算并添加到警告消息的末尾。 <br> - *dataElement* - 如果已定义，则警告消息以数据元素的名称/formName 为前缀。 <br> * `ERRORONCOMPLETE` - 当用户尝试完成事件时，在模式窗口中向用户显示错误。用户被阻止完成该事件。 <br> - *content* - 如果定义，内容是显示在错误消息开头的静态部分。 <br> - *data* - 如果定义，数据会形成一个表达式，该表达式将被计算并添加到错误消息的末尾。 <br> - *dataElement* - 如果定义，错误消息将链接到此数据元素。 <br> * `CREATEEVENT` - 在同一注册中创建事件。 <br> - *内容* <br> - *data* - 如果已定义，则包含用于分配创建的事件的数据值。格式为 <uid\> : <data value\> 。如果指定了多个值，则这些值用逗号分隔。 <br> AcMrnleqHqc:100,AqK1IHqCkEE:'PolyHydramnios' - *programStage* - 必须定义，并指定规则应在其中创建事件的项目阶段。 <br> * `SETMANDATORYFIELD` - 将字段设置为必填。 <br> - *dataElement* - 如果定义，此数据元素将在数据输入表单中设置为强制。 <br> - *trackedEntityAttribute* - 如果定义，此跟踪实体属性将在注册表单或个人资料中设置为强制属性。 <br> * `SENDMESSAGE` - 在活动/注册完成或数据值更新时发送消息。 <br> - *messageTemplate* - 如果定义，此模板将以 SMS 或 EMAIL 形式传送，具体取决于消息模板中的 DeliveryChannel 值。 <br> * `SCHEDULEMESSAGE` - 在事件/注册完成或数据值更新时安排消息。 <br> - *messageTemplate* - 如果定义，此模板将以 SMS 或 EMAIL 形式传送，具体取决于消息模板中的 DeliveryChannel 值。 <br> - *发送消息的日期* - 将用于评估预定日期的表达式。该表达式的结果应该是日期，任何其他结果都将被丢弃，并且不会安排通知。 | 表:项目规则操作 |
| 项目规则 | 该操作的父项目规则。 | 强制性 |
| 项目规则--动作类型 | The type of action that is to be performed.<br>  * `DISPLAYTEXT` - Displays a text in a given widget.<br> * `DISPLAYKEYVALUEPAIR` - Displays a key and value pair(like a program indicator) in a given widget.<br> * `HIDEFIELD` - Hide a specified dataElement or trackedEntityAttribute.<br>    -         *content* - if defined, the text in *content* will be displayed to the end user in the instance where a value is previously entered into a field that is now about to be hidden (and therefore blanked). If *content* is not defined, a standard message will be shown to the user in this instance.<br>   -         *dataElement* - if defined, the HIDEFIELD action will hide this dataElement when the rule is effective.<br>   -         *trackedEntityDataValue* - if defined, the HIDEFIELD action will hide this trackedEntityDataValue when the rule is effective.<br>  * `HIDESECTION` - Hide a specified section.<br>    -         *programStageSection* - must be defined. This is the programStageSection that will be hidden in case the parent rule is effective.<br>  * `ASSIGN` - Assign a value to either a dataElement or trackedEntityAttribute or a ProgramRuleVariable. Intended to help the user calculate something or fill in an obvious value somewhere.<br>    -         *content* - if defined, the value in *data* is assigned to this variable. If content id defined, and thus a variable is assigned for use in other rules, it is important to also assign a *programRule.priority* to make sure the rule with an ASSIGN action runs before the rule that will in turn evaluate the assigned variable.<br>   -         *data* - must be defined, data forms an expression that is evaluated and assigned to either a variable(#{myVariable}), a dataElement, or both.<br>   -         *dataElement* - if defined, the value in *data* is assigned to this data element.<br>  Either the content or dataElement must be defined for the ASSIGN action to be effective.<br> * `SHOWWARNING` - Show a warning to the user, not blocking the user from completing the event or registration.<br>    -         *content* - if defined, content is a static part that is displayed at the end of the error message.<br>   -         *data* - if defined, data forms an expression that is evaluated and added to the end of the warning message.<br>   -         *dataElement* - if defined, the warning message is displayed next to this data element.<br>   -         *trackedEntityAttribute* - if defined, the warning message is displayed next to this tracked entity attribute.<br>  Either dataElement or trackedEntityAttribute must be specified.<br> * `SHOWERROR` - Show an error to the user, blocking the user from completing the event or registration.<br>    -         *content* - if defined, content is a static part that is displayed in the start of the error message.<br>   -         *data* - if defined, data forms an expression that is evaluated and added to the end of the error message.<br>   -         *dataElement* - if defined, the error message is linked to this data element.<br>   -         *trackedEntityAttribute* - if defined, the error message is linked to this tracked entity attribute.<br>  Either dataElement or trackedEntityAttribute must be specified.<br> * `WARNINGONCOMPLETE` - Show a warning to the user on the "Complete form" dialog, but allowing the user to complete the event.<br>    -         *content* - if defined, content is a static part that is displayed at the end of the error message.<br>   -         *data* - if defined, data forms an expression that is evaluated and added to the end of the warning message.<br>   -         *dataElement* - if defined, the warning message prefixed with the name/formName of the data element.<br>  * `ERRORONCOMPLETE` - Show an error to the user on in a modal window when the user tries to complete the event. The user is prevented from completing the event.<br>    -         *content* - if defined, content is a static part that is displayed in the start of the error message.<br>   -         *data* - if defined, data forms an expression that is evaluated and added to the end of the error message.<br>   -         *dataElement* - if defined, the error message is linked to this data element.<br>  * `CREATEEVENT` - Create an event within the same enrollment.<br>    -         *content*<br>   -         *data* - if defined, contains data values to assign the created event. The format is <uid\>:<data value\>. Where several values is specified, these are separated with comma.<br> AcMrnleqHqc:100,AqK1IHqCkEE:'Polyhydramnios'<br>   -         *programStage* - must be defined, and designates the program stage that the rule shall create an event of.<br>  * `SETMANDATORYFIELD` - Set a field to be mandatory.<br>    -         *dataElement* - if defined, this data element will be set to be mandatory in the data entry form.<br>   -         *trackedEntityAttribute* - if defined, this tracked entity attribute will be set to mandatory in the registration form or profile.<br>  * `SENDMESSAGE` - To send message at completion of event/enrollment or at data value update.<br>    -         *messageTemplate* - if defined, this template will be delivered either as SMS or EMAIL depending upon DeliveryChannel value in message template.<br>  * `SCHEDULEMESSAGE` - To schedule message at completion of event/enrollment or at data value update.<br>    -         *messageTemplate* - if defined, this template will be delivered either as SMS or EMAIL depending upon DeliveryChannel value in message template.<br>   -         *Date to send message* - Expression which is going to be used for evaluation of scheduled date. This expression should result in Date, any other resultant will be discarded and notification will not get scheduled. <br>  * `HIDEPROGRAMSTAGE` - Prevent adding new events to stage. <br>  * `HIDEOPTION` - Hide option (from an optionSet). <br>  * `HIDEOPTIONGROUP` - Hide option group (hide the options that belong to that option group). <br>  * `SHOWOPTIONGROUP` - Show option group (show the options that belong to that option group). | 强制性 |
| 地点 | 用于动作类型 DISPLAYKEYVALUEPAIR 和 DISPLAYTEXT,以指定在哪个部件中显示文本或按键对。必须用于 DISPLAYKEYVALUEPAIR 和 DISPLAYTEXT。 | 强制性 |
| 最小最大数据元素 | 用于不同操作中的用户信息。有关在每种操作类型中如何使用的详细说明,请参阅操作类型概述。SHOWWARNING、SHOWERROR、WARNINGONCOMPLETE、ERRORONCOMPLETE、DISPLAYTEXT 和 DISPLAYKEYVALUEPAIR 必须使用。HIDEFIELD 和 ASSIGN 可选。 | 强制性 |
| 数据 | 用于不同操作中的表达式。有关各操作类型中如何使用该表达式的详细说明,请参阅操作类型概述。ASSIGN 必须使用。SHOWWARNING、SHOWERROR、WARNINGONCOMPLETE、ERRORONCOMPLETE、DISPLAYTEXT、CREATEEVENT 和 DISPLAYKEYVALUEPAIR 可选。 | 强制性 |
| 数据元素 | 用于将规则操作链接到数据元素。有关在每种操作类型中如何使用的详细说明,请参阅操作类型概述。SHOWWARNING、SHOWERROR、WARNINGONCOMPLETE、ERRORONCOMPLETE、ASSIGN 和 HIDEFIELD 的可选项。 | 强制性 |
| 跟踪属性 | 用于将规则操作链接到跟踪实体属性(trackedEntityAttributes)。有关在每种操作类型中如何使用的详细说明,请参阅操作类型概述。SHOWWARNING、SHOWERROR 和 HIDEFIELD 的可选项。 | 强制性 |
| See an example payload below. | 用于将规则操作链接到选项。有关在每种操作类型中如何使用的详细说明,请参阅操作类型概述。HIDEOPTION 的可选项 | 强制性 |
| 选项组 | 用于将规则操作链接到选项组。有关在每种操作类型中如何使用的详细说明,请参阅操作类型概述。SHOWOPTIONGROUP 和 HIDEOPTIONGROUP 必须使用。 | 强制性 |

##### 项目阶段
仅用于 CREATEEVENT 规则操作。必须用于 CREATEEEVENT。

参见说明

| displayColumnOrder | 仅用于 HIDESECTION 规则操作。必须用于 HIDESECTION |
|---|---|
|参见说明| 项目规则行动验证{ #programruleaction-validation }  |
|2.37 中为 ProgramRuleAction 模型添加了一些验证。主要目的是防止用户创建错误的项目规则,以保持数据库的一致性。这些验证取决于项目规则动作类型。每种操作类型都有各自的验证。 | 项目规则行动验证{ #programruleaction-validation }  |
|名称| 验证检查 ID 是否存在 |
|短信| 通知模板 ID |
|日程消息| 选项 id |
|隐藏| ProgramStage 段落 ID |
|隐藏计划阶段| 数据元素或跟踪实体属性 id |
|希德菲尔德| 数据元素或跟踪实体属性 id |
|隐藏选项| 选项 id |
|隐藏选项组| 选项组 ID |
|显示选项组| 选项组 ID |
|设置必填字段| 选项 id |
|淋浴器||
|始终有效| 选项 id |
|始终有效| 选项 id |
|数据元素或跟踪实体属性 id| 选项 id |

分配

数据元素或跟踪实体属性 id


完成警告

#### 数据元素或跟踪实体属性 id

erroroncomplete

数据元素或跟踪实体属性 id

| displayColumnOrder | dataFilters | 表:项目规则操作 |
|---|---|---|
| displayColumnOrder | 下表详细概述了
项目规则变量模型。 | 表:项目规则操作 |
| 名称 | 定义如何使用来自注册和事件的数据填充此变量。 <br> * DATAELMENT_NEWEST_EVENT_PROGRAM_STAGE - 在跟踪器捕获中，获取当前注册中给定计划阶段的事件中数据元素存在的最新值。在事件捕获中，获取组织单元上最新的 10 个事件中的最新值。 <br> * DATAELMENT_NEWEST_EVENT_PROGRAM - 在跟踪器捕获中，获取整个注册过程中数据元素存在的最新值。在事件捕获中，获取组织单元上最新的 10 个事件中的最新值。 <br> * DATAELEMENT_CURRENT_EVENT - 仅获取当前事件中给定数据元素的值。 <br> * DATAELMENT_PREVIOUS_EVENT - 在跟踪器捕获中，获取当前事件之前的项目中的事件中存在的最新值。在事件捕获中，获取组织单位上注册的 10 个先前事件中的最新值。 <br> * CALCULATED_VALUE - 用于保留将由 ASSIGN 项目规则操作分配的变量名称 <br> * TEI_ATTRIBUTE - 获取给定跟踪实体属性的值 | 表:项目规则操作 |
| 名称 | programRuleVariable 的名称 - 该名称用于表达式中。#{myVariable} \> 5| 表:项目规则操作
| 最小最大数据元素 | Defines how this variable is populated with data from the enrollment and events.<br> *DATAELEMENT_NEWEST_EVENT_PROGRAM_STAGE - This source type works the same way as DATAELEMENT_NEWEST_EVENT_PROGRAM, except that it only evaluates values from one program stage. This source type can be useful in program rules where the same data element is used in several program stages, and a rule needs to evaluate the newest data value from within one specific stage. In order to know what event is the newest, the report date (event date) is used. If you have many events with the same report date, the system choose the one with the latest `createdAt` property of the event. <br>*DATAELEMENT_NEWEST_EVENT_PROGRAM - This source type is used when a program rule variable needs to reflect the newest known value of a data element, regardless of what event the user currently has open.<br>**NB** Future dates are "newer" than current or past dates.<br>In order to know what event is the newest, the report date (event date) is used. If you have many events with the same report date, the system choose the one with the latest `createdAt` property of the event.<br>*DATAELEMENT_CURRENT_EVENT - Program rule variables with this source type will contain the data value from the same event that the user currently has open. This is the most commonly used source type, especially for skip logic (hide actions) and warning/error rules.<br>*DATAELEMENT_PREVIOUS_EVENT - Program rule variables with this source type will contain the value from a specified data element from a previous event. Only older events is evaluated, not including the event that the user currently has open. This source type is commonly used when a data element only should be collected once during an enrollment, and should be hidden in subsequent events. Another use case is making rules for validating input where there is an expected progression from one event to the next - a rule can evaluate whether the previous value is higher/lower and give a warning if an unexpected value is entered.<br>*CALCULATED_VALUE - Program rule variable with this source type is not connected directly to any form data - but will be populated as a result of some other program rules **ASSIGN** action. This variable will be used for making preliminary calculations, having a **ASSIGN** program rule action and assigning a value, this value can be used by other program rules - potentially making the expressions simpler and more maintainable. These variables will not be persisted and will stay in memory only during the execution of the set of program rules. Any program rule that assigns a data value to a preliminary calculated value would normally also have a **priority** assigned - to make sure that the preliminary caculation is done before the rule that consumes the calculated value.<br>*TEI_ATTRIBUTE - Populates the program rule variable with a specified tracked entity attribute for the current enrollment. Use this is the source type to create program rules that evaluate data values entered during registration. This source type is also useful when you create program rules that compare data in events to data entered during registration. This source type is only used for tracker programs (programs with registration). | 强制性 |
| 数据 | valueType 参数定义此 ProgramRuleVariable 可包含的值的类型。其值取决于 sourceType 参数。如果源是 DataElement 或 TrackedEntityAttribute<br> ,那么 valueType 将从源的 valueType 派生。当 sourceType 为 CALCULATED_VALUE 时,valueType 应由用户提供,否则<br> 将默认为 ValueType.TEXT | 强制性 |
| 数据元素 | 用于将项目规则变量链接到数据元素。必须用于所有以 DATAELEMENT_ 开头的源类型。 ||
| See an example payload below. | 跟踪属性 | 强制性 |

### 参见说明

- useCodeFor- 选项集

如果选中,变量将使用任何链接选项集的代码(而不是名称)。默认值为未选中,即输入选项名称。

项目阶段

用于指定从哪个特定项目阶段获取 programRuleVariable 值。DATAELEMENT_NEWEST_EVENT_PROGRAM_STAGE 必须使用。

    / api / programRules / <program_rule_uid>

创建项目规则 { #webapi_creating_program_rules } 

    / api / programRules / <program_rule_uid>

要检索programRules的列表,您可以执行GET请求,如下所示:

    / api / programRules / <program_rule_uid>

要检索单个programRule,您可以执行GET请求,如下所示:

    / api / programRules

要保存/添加单个programRule,您可以执行POST请求,如下所示:

    / api / programRules / <program_rule_uid>

## 要更新单个programRule,您可以执行如下PUT请求:

    / api / programRules / <program_rule_uid>

要删除单个programRule,您可以执行以下DELETE请求:

| 默认值 | Validation rule | Parameter name |
|---|---|---|
| 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. | 表格表单查询参数 |
| Filter on whether the current user can manage the returned users through the managed user group relationships. | 串 | 描述 |
| 聚乙烯 | 假 | 填入表格数据值的时间段。 |

欧

用户标识

用于填充表单数据值的组织单位。

元数据

假

真

是否包含表格各部分每个数据元素的元数据。

要检索数据集的表单,您可以执行GET请求,如下所示:

    / api / dataSets / <dataset-id> /form.json

检索具有标识符“BfMAe6Itzgt”的数据集的表单
XML:

##     / api / dataSets / BfMAe6Itzgt / form

要检索包含JSON中的元数据的表单,请执行以下操作:



    /api/dataSets/BfMAe6Itzgt/form.json?metaData=true

| 检索填充了特定时期数据值的表单,并
XML 中的组织单位: | Parameter name |
|---|---|
| displayColumnOrder | ```bash
curl -d @form.html "localhost/api/dataSets/BfMAe6Itzgt/form"
  -H "Content-Type:text/html" -u admin:district -X PUT
``` |
| 文件资料 { #webapi_documents }  | 对文件的引用可以与文档资源一起存储。 |
| 表格文件字段 | 字段名称 |

描述

名称

文件唯一名称

外部

标识文件位置的标志。外部文件为 TRUE,内部文件为 FALSE

网址

文件的位置。外部文件的 URL。内部文件的文件资源 ID(请参阅 [文件资源](metadata.md#webapi_file_resources))。

对文档端点的GET请求将返回所有文档:

    / api / documents

## 对文档端点的POST请求将创建一个新文档:

```bash
curl -X POST -d @document.json -H "Content-type: application/json"
  "http://dhis.domain/api/documents"

{
  "name": "dhis home",
  "external": true,
  "url": "https://www.dhis2.org"
}

/ api / documents / <documentId>

/ api / documents / <documentId> / data

名称,uid,代码,简称
“男”,“男”
“女性”,“女性”

GET /api/deletedObjects.json?klass=DataElement

/ api / deletedObjects

GET /api/deletedObjects.json?klass=DataElement

GET /api/deletedObjects.json?klass=Indicator&deletedAt=2015-01-01

/ api / dashboards / <uid> /收藏

/ api /仪表板/ iMnYyBfSxmM /收藏

/ api / <object-type> / <object-id> /订阅者

/api/visualizations/DkPKc1EUmC2/subscribers

/ api / <object-type> / <object-id> /已订阅

/api/visualizations/DkPKc1EUmC2/subscribed

curl "https://server/api/fileResources/xm4JwRwke0i" -H "Accept: application/json"

/ api / metadata / version / history?baseline = Version_2

{
  "metadataversions": [{
    "name": "Version_3",
    "type": "BEST_EFFORT",
    "created": "2016-06-30T06:01:23.680+0000",
    "id": "FVkGzSjAAYg",
    "hashCode": "70b779ea448b0da23d8ae0bd59af6333"
  }, {
    "name": "Version_4",
    "type": "BEST_EFFORT",
    "created": "2016-06-30T06:01:28.684+0000",
    "id": "Ayz2AEMB6ry",
    "hashCode": "848bf6edbaf4faeb7d1a1169445357b0"
  }]
 }

curl -X POST -u admin:district "https://play.dhis2.org/dev/api/metadata/version/create?type=BEST_EFFORT"

{
  "name": "Version_1",
  "created": "2016-06-30T05:54:41.139+0000",
  "lastUpdated": "2016-06-30T05:54:41.333+0000",
  "externalAccess": false,
  "publicAccess": "--------",
  "user": {
    "name": "John Traore",
    "created": "2013-04-18T17:15:08.407+0000",
    "lastUpdated": "2016-04-06T00:06:06.571+0000",
    "externalAccess": false,
    "displayName": "John Traore",
    "id": "xE7jOejl9FI"
  },
  "displayName": "Version_1",
  "type": "BEST_EFFORT",
  "hashCode": "fd1398ff7ec9fcfd5b59d523c8680798",
  "id": "SjnhUp6r4hG"
}

元数据存储库 { #webapi_metadata_repository } 

DHIS2 提供了一个包含元数据包的元数据存储库
各种内容。元数据包是符合 DHIS2 的 JSON 文档
它描述了一组元数据对象。

### 要检索可用元数据包的索引,您可以发出
对 *metadataRepo* 资源的 GET 请求:

    GET /api/synchronization/metadataRepo

元数据包条目包含有关包的信息和
相关包的 URL。索引可能如下所示:

```json
{
  "packages": [
    {
      "id": "sierre-leone-demo",
      "name": "Sierra Leone demo",
      "description": "Sierra Leone demo database",
      "version": "0.1",
      "href": "https://dhis2.org/metadata-repo/221/sierra-leone-demo/metadata.json"
    },
    {
      "id": "trainingland-org-units",
      "name": "Trainingland organisation units",
      "description": "Trainingland organisation units with four levels",
      "version": "0.1",
      "href": "https://dhis2.org/metadata-repo/221/trainingland-org-units/metadata.json"
    }
  ]
}

curl "localhost:8080/api/synchronization/metadataPull" -X POST
  -d "https://dhis2.org/metadata-repo/221/trainingland-org-units/metadata.json"
  -H "Content-Type:text/plain" -u admin:district

 {
  "httpStatus": "Conflict",
  "httpStatusCode": 409,
  "status": "ERROR",
  "message": "Provided URL is not in the remote servers allowed list",
  "errorCode": "E1004"
}

{
  "createdBy": {
      "displayName": "John Kamara",
      "name": "John Kamara",
      "id": "N3PZBUlN8vq",
      "username": "district"
  },
  "user": {
      "displayName": "John Kamara",
      "name": "John Kamara",
      "id": "N3PZBUlN8vq",
      "username": "district"
  }
}

/api/metadata/proposals

POST /api/metadata/proposals

`change` 属性包含相同的 JSON 对象,可直接发布到相应的端点以创建对象。

要提议更新现有元数据对象,请发送一个 JSON 有效载荷,如下例所示:

```json
{
  "type": "UPDATE",
  "target": "ORGANISATION_UNIT",
  "targetId": "<id>",
  "change": [
    {"op": "replace", "path": "/name", "value": "New name"}
  ]
}

POST /api/metadata/proposals/<uid>

PATCH /api/metadata/proposals/<uid>