追踪器¶

{
  "trackedEntityInstance": "oi3PMIGYJH8",
  <entity_details>,
  ],
  "enrollments": [
    {
      "enrollment": "EbRsJr8LSSO",
      <enrollment_details>
      "notes": [
        {
          "note": "vxmCvYcPdaW",
          "value": "Enrollment note 2.",
        },
        {
          "value": "Enrollment note 1",
        }
      ],

      "events": [
        {
          "event": "zfzS9WeO0uM",
          <event_details>,
          "notes": [
            {
              "note": "MAQFb7fAggS",
              "value": "Event Note 1.",
            },
            {
              "value": "Event Note 2.",
            }
          ],
        },
        {
          ...
        }
      ]
    }
  ]
}

/api/40/programStageWorkingLists

/api/programStageWorkingLists

## Tracker Import (`POST /api/tracker`) { #webapi_nti_import }

The `POST /api/tracker` endpoint allows clients to import the following tracker objects into DHIS2:

* **跟踪实体**
* **入学人数**
* **活动**
* **关系**
* 嵌入其他[跟踪器对象]的数据（#webapi_nti_tracker_objects）

与其他跟踪器导入端点相比，主要变化有

1. 导入有效载荷可****嵌套式****或****扁平式****
2. 调用可以是****同步****或****异步****
3. 导入 ***CSV*** 事件有效载荷

### 请求参数{ #request-parameters } 

目前，跟踪器导入端点支持以下参数：

| existing tracked entity UIDs | 描述 | 类型 | `order` |
|---|---|---|---|
| 异步导入时,会立即返回一个 *Location* 标头,指向 *importReport* 的位置。有效载荷还包含一个已创建任务的 json 对象。 | To resolve this, either: | Boolean | 跟踪器或事件项目的标识符。该参数为必填参数。 |
| ```
GET /tracker/jobs/{uid}
``` | The endpoint `POST /api/tracker` is also called the tracker importer. This endpoint allows clients
to import i.e. create, update and delete | DateTime | Enrollments |
| 设置整体导入模式,决定是否仅 `VALIDATE` 或也 `COMMIT` 元数据,这与我们旧的 dryRun 标志具有相似的功能。 | 表示导入模式。可以是仅验证（干运行）或提交（默认）。 | DateTime | 跟踪器导入项目支持以下参数: |
| 方案 | 表示导入时元数据引用使用的总体 idScheme。默认为 UID。可为特定元数据重写（如下所列） | DateTime | uid"、"代码"、"名称"、"属性 |
| 数据元素标识方案 | 表示导入数据元素时使用的 idScheme。 | DateTime | uid"、"代码"、"名称"、"属性 |
| programStageIdScheme | 表示导入时组织单位要使用的 idScheme。 | DateTime | uid"、"代码"、"名称"、"属性 |
| 程序标识方案 | 表示导入项目时使用的 idScheme。 | DateTime | uid"、"代码"、"名称"、"属性 |
| 程序阶段标识方案 | 表示导入时用于项目阶段的 idScheme。 | DateTime | uid"、"代码"、"名称"、"属性 |
| programIdScheme | 表示导入时类别选项组合使用的 idScheme。 | DateTime | uid"、"代码"、"名称"、"属性 |
| `UID`, `CODE`, `NAME`, `ATTRIBUTE:{uid}` | 表示导入时类别选项使用的 idScheme。 | DateTime | uid"、"代码"、"名称"、"属性 |
| Sets import strategy, `CREATE_AND_UPDATE` will try and match on identifier, if it doesn't exist, it will create the object. | Enum | DateTime | `idScheme` parameter |
| 设置原子模式,在旧的导入器中,我们总是进行*best effort*导入,这意味着即使某些引用不存在,我们仍然会导入(即数据元素组导入时缺少数据元素)。新进口商的默认设置是不允许这样做,并且类似地拒绝任何验证错误。设置 `NONE` 模式模拟了旧的行为. | Enum | DateTime | `idScheme` parameter |
| 设置刷新模式,控制何时刷新内部缓存。*强烈*建议将其保留为`AUTO`(这是默认设置)。仅将 `OBJECT` 用于调试目的,您会看到休眠异常并想查明堆栈发生的确切位置(休眠只会在刷新时抛出,因此很难知道哪个对象有问题)。 | Enum | DateTime | `idScheme` parameter |
| IdScheme used for category option references. Defaults to the `idScheme` parameter. | 表示验证步骤的完整性。可以跳过、设置为快速失败（第一次出错时返回）或完全失败（默认），后者将返回发现的所有错误。 | DateTime | `idScheme` parameter |
| Indicates the effect the import should have. Can either be `CREATE`, `UPDATE`, `CREATE_AND_UPDATE` and `DELETE`, which respectively only allows importing new data, importing changes to existing data, importing any new or updates to existing data, and finally deleting data. | Enum | Boolean | 跟踪器或事件项目的标识符。该参数为必填参数。 |
| Indicates how the import responds to validation errors. If `ALL`, all data imported must be valid for any data to be committed. For `OBJECT`, only the data committed needs to be valid, while other data can be invalid. | Enum | Boolean | 跟踪器或事件项目的标识符。该参数为必填参数。 |
| Indicates the frequency of flushing. This is related to how often data is pushed into the database during the import. Primarily used for debugging reasons, and should not be changed in a production setting | 如果为 "true"，它将跳过运行导入的任何项目规则 | Boolean | 跟踪器或事件项目的标识符。该参数为必填参数。 |

**注意**：idScheme 及其元数据特定 idScheme 参数，如
orgUnitIdScheme、programIdScheme......用于允许和使用默认的 `AUTO`。
AUTO` 已被删除。默认 idScheme 已为 `UID`。任何
idScheme "AUTO "发送的请求将与之前的行为相同，即使用 "UID
使用 `UID`进行匹配。

### 扁平和嵌套有效载荷{ #flat-and-nested-payloads } 

导入器支持平面和嵌套有效载荷。主要区别在于客户对数据结构的要求不同。

** 平坦部**
:   扁平结构有效载荷简单明了。它可以包含我们拥有的每个核心跟踪器对象的集合。这可与已分配了 UID 的现有数据无缝配合。但是，对于新数据，客户端必须为对象之间的任何引用提供新的 UID。例如，如果您导入一个带有新注册信息的新跟踪实体，则该跟踪实体要求客户端提供一个 UID，以便将注册信息与该 UID 相链接。

**嵌套**
:   嵌套有效载荷是最常用的结构。在这里，跟踪对象被嵌入其父对象中；例如，跟踪实体中的注册。这种结构的优点是，客户端不需要为这些连接提供 UID，因为在导入过程中，它们会被赋予这种连接，因为它们是嵌套在一起的。

> **注**
>
> 虽然嵌套有效载荷可能会让客户端更容易处理，但有效载荷总是会在导入前被扁平化。这意味着，对于大型导入，提供扁平结构的有效载荷既能提供更多控制，又能降低导入过程本身的开销。

下面列出了**FLAT**和**NESTED**版本有效载荷的示例。两种情况使用的数据相同。

#### ***扁平***有效载荷{ #flat-payload } 

``json
{
  "trackedEntities"：[
    {
      "orgUnit"："O6uvpzGd5pu"、
      "trackedEntity"："Kj6vYde4LHh"、
      "trackedEntityType"："Q9GufDoplCL"
    }
  ],
  "注册"：[
    {
      "orgUnit"："O6uvpzGd5pu"、
      "program"："f1AyMswryyQ"、
      "trackedEntity"："Kj6vYde4LHh"、
      "注册"： "MNWZ6hnn"MNWZ6hnuhSw"、
      "trackedEntityType"："Q9GufDoplCL"、
      "enrolledAt"："2019-08-19T00:00:00.000",
      "deleted": false、
      "occurredAt"："2019-08-19T00:00:00.000",
      "状态"："ACTIVE"、
      "备注"：[],
      属性[],
    }
  ],
  "事件"：[
    {
      "scheduledAt"："2019-08-19T13:59:13.688",
      "程序"："f1AyMswryyQ"、
      "事件"："ZwwuwNp6gVd"、
      "programStage"："nlXNK4b7LVr"、
      "orgUnit"："O6uvpzGd5pu"、
      "trackedEntity"："Kj6vYde4LHh"、
      "enrollment"："MNWZ6hnuhSw"、
      "enrollmentStatus"："ACTIVE"、
      "状态"："ACTIVE"、
      "occurredAt"："2019-08-01T00:00:00.000",
      "attributeCategoryOptions"："xYerKDKCefk"、
      "deleted": false、
      "attributeOptionCombo"："HllvX50cXC0"、
      "dataValues"：[
        {
          "updatedAt"："2019-08-19T13:58:37.477",
          "storedBy"："admin"、
          "dataElement"："BuZ5LGNfGEU"、
          "值"："20",
          "providedElsewhere": false
        },
        {
          "updatedAt"："2019-08-19T13:58:40.031",
          "storedBy"："admin"、
          "dataElement"："ZrqtjjveTFc"、
          "值"："男性"、
          "providedElsewhere": false
        },
        {
          "updatedAt"："2019-08-19T13:59:13.691",
          "storedBy"："admin"、
          "dataElement"："mB2QHw1tU96"、
          "值"："[-11.566044,9.477801]",
          "providedElsewhere": false
        }
      ],
      "备注"：[]
    },
    {
      "scheduledAt"："2019-08-19T13:59:13.688",
      "程序"："f1AyMswryyQ"、
      "事件"："XwwuwNp6gVE"、
      "programStage"："PaOOjwLVW23"、
      "orgUnit"："O6uvpzGd"O6uvpzGd5pu"、
      "trackedEntity"："Kj6vYde4LHh"、
      "enrollment"："MNWZ6hnuhSw"、
      "enrollmentStatus"："ACTIVE"、
      "状态"："ACTIVE"、
      "occurredAt"："2019-08-01T00:00:00.000",
      "attributeCategoryOptions"："xYerKDKCefk"、
      "deleted": false、
      "attributeOptionCombo"："HllvX50cXC0"、
      "备注"：[]
    }
  ],
  "关系"：[
    {
      "relationshipType"："Udhj3bsdHeT"、
      "来自"：{
        "trackedEntity"：{ "trackedEntity"："Kj6vYde4LHh" }
      },
      "到"：{
        "trackedEntity"：{ "trackedEntity"："Gjaiu3ea38E" }
      }
    }
  ]
}

### SYNC 和 ASYNC{ #sync-and-async } 
对用户而言，同步导入与异步导入的主要区别在于 API 的即时响应。对于同步导入，一旦导入完成，将立即返回导入摘要（importSummary）。但是，对于异步导入，响应将是即时的，并包含客户端可以轮询导入更新的引用。

对于重要的导入，客户端使用异步导入可能会有好处，可以避免等待响应的时间过长。


下面是**ASYNC**响应的示例。关于 **SYNC** 响应，请查看 [importSummary 部分]（#webapi_nti_import_summary）。

``json
{
    "httpStatus"："OK"、
    "httpStatusCode"：200,
    "status"："确定"、
    "信息"："已添加跟踪任务"、
    "响应"：{
        "responseType"："TrackerJob"、
        "id"："LkXBUdIgbe3"、
        "location"："https://play.dhis2.org/dev/api/tracker/jobs/LkXBUdIgbe3"
    }
}

[
  {
    "uid": "mEfEaFSCKCC",
    "level": "INFO",
    "category": "TRACKER_IMPORT_JOB",
    "time": "2021-01-01T00:00:06.00",
    "message": "TRACKER_IMPORT_JOB ( mEfEaFSCKCC ) finished in 6.00000 sec. Import:Done",
    "completed": true,
    "id": "mEfEaFSCKCC"
  },
  {
    "uid": "mEfEaFSCKCC",
    "level": "DEBUG",
    "category": "TRACKER_IMPORT_JOB",
    "time": "2021-01-01T00:00:05.00",
    "message": "TRACKER_IMPORT_JOB ( mEfEaFSCKCC ) commit completed in 1.00000 sec. Import:commit",
    "completed": true,
    "id": "mEfEaFSCKCC"
  },
  {
    "uid": "mEfEaFSCKCC",
    "level": "DEBUG",
    "category": "TRACKER_IMPORT_JOB",
    "time": "2021-01-01T00:00:04.00",
    "message": "TRACKER_IMPORT_JOB ( mEfEaFSCKCC ) programruleValidation completed in 1.00000 sec. Import:programruleValidation",
    "completed": true,
    "id": "mEfEaFSCKCC"
  },
  {
    "uid": "mEfEaFSCKCC",
    "level": "DEBUG",
    "category": "TRACKER_IMPORT_JOB",
    "time": "2021-01-01T00:00:03.00",
    "message": "TRACKER_IMPORT_JOB ( mEfEaFSCKCC ) programrule completed in 1.00000 sec. Import:programrule",
    "completed": true,
    "id": "mEfEaFSCKCC"
  },
  {
    "uid": "mEfEaFSCKCC",
    "level": "DEBUG",
    "category": "TRACKER_IMPORT_JOB",
    "time": "2021-01-01T00:00:02.00",
    "message": "TRACKER_IMPORT_JOB ( mEfEaFSCKCC ) validation completed in 1.00000 sec. Import:validation",
    "completed": true,
    "id": "mEfEaFSCKCC"
  },
  {
    "uid": "mEfEaFSCKCC",
    "level": "DEBUG",
    "category": "TRACKER_IMPORT_JOB",
    "time": "2021-01-01T00:00:01.00",
    "message": "TRACKER_IMPORT_JOB ( mEfEaFSCKCC ) preheat completed in 1.00000 sec. Import:preheat",
    "completed": true,
    "id": "mEfEaFSCKCC"
  },
  {
    "uid": "mEfEaFSCKCC",
    "level": "INFO",
    "category": "TRACKER_IMPORT_JOB",
    "time": "2021-01-01T00:00:00.00",
    "message": "TRACKER_IMPORT_JOB ( mEfEaFSCKCC ) started by admin ( xE7jOejl9FI ) Import:Start",
    "completed": true,
    "id": "mEfEaFSCKCC"
  }
]

***状态****

导入摘要的属性 "status "表示导入的整体状态。如果在导入过程中没有出现错误或警告，"status "将报告为 "OK"。如果导入过程中出现任何错误或警告，则状态类型为 `ERROR` 或 `WARNING`。

状态 "基于最重要的 "验证报告"。ERROR "的重要性最高，其次是 "WARNING"，最后是 "OK"。这意味着，只要在导入过程中发现一个错误，就会报告`ERROR`，而不管出现多少警告。

> **注**
>
> 如果使用 AtomicMode "OBJECT"（原子模式）执行导入，导入时将导入任何数据而不会出现验证错误，但如果发现任何错误，总体状态仍将是 "ERROR"。

***验证报告****

如果在导入过程中出现任何错误或警告，"validationReport "可能包括 "errorReports "和 "warningReports"。如果存在，它们会提供遇到的任何错误或警告的详细列表。

ID of an existing tracker import job.
```json
{
  "validationReport": {
    "errorReports": [
      {
        "message": "Could not find TrackedEntityType: `Q9GufDoplCL`.",
        "errorCode": "E1005",
        "trackerType": "TRACKED_ENTITY",
        "uid": "Kj6vYde4LHh"
      },
      ...
    ],
    "warningReports" : [ ... ]
  }
}

{
  "stats": {
    "created": 2,
    "updated": 2,
    "deleted": 1,
    "ignored": 5,
    "total": 10
  }
}

{
  "timingsStats": {
    "timers": {
      "preheat": "0.234086 sec.",
      "preprocess": "0.000058 sec.",
      ...
      "totalImport": "0.236810 sec.",
      "validation": "0.001533 sec."
    }
  }
}

如图所示，每种类型的跟踪器对象都将被报告，每种类型都有自己的统计信息和 `对象报告`。这些 `objectReports` 将提供每个导入对象的详细信息，如类型、uid 以及任何适用的错误或警告报告。

***信息****

如果导入突然结束，"信息 "将包含与所发生情况有关的更多信息。

### 导入摘要报告级别{ #import-summary-report-level } 

如前所述，可以使用特定的 `reportMode` 参数检索 `GET /tracker/jobs/{uid}/report`。默认情况下，该端点将返回一个`reportMode``ERROR`的`importSummary`。

| 默认值 | 描述 |
|---|---|
| importStrategy | The stats object provides an overview of the import operation. After an import is completed, these will be the
actual counts displaying how many objects were created, updated, deleted and ignored. |
| 警报 | ```json
{
  "stats": {
    "created": 2,
    "updated": 2,
    "deleted": 1,
    "ignored": 5,
    "total": 10
  }
}
``` |
| ERRORS"（默认值） | The `updated` field refers to the number of objects updated. If an object has a uid set in the payload, it
will be treated as an update as long as that same uid exists in the database. |

此外，所有 `reportMode` 都会在适用时返回 `status`、`stats`、`bundleReport` 和 `message` 。

### 错误代码{ #webapi_nti_error_codes }

不同的错误情形有不同的错误代码。下表列出了新 Tracker API 抛出的错误代码列表，以及错误信息和一些附加说明。错误信息中的占位符（`{0}`、`{1}`、`{2}`...）通常是 uids，除非另有说明。

| When the import is completed, the `bundleReport` contains all the [tracker objects](#tracker-objects) imported. | An example for `TRACKED_ENTITY`: | 描述 |
|:--|:----|:----|
| E1000 | 信息 | If the import ended abruptly, the `message` would contain further information in relation to what
happened. |
| E1001 | A import summary report can be retrieved using a specific `reportMode` parameter in a `GET /tracker/jobs/{uid}/report` 
request. By default the endpoint will return an `importSummary` with `reportMode` `ERROR`. | Parameter
| E1002 | TrackedEntityInstance: `{0}`，已存在。 | Returns everything from `WARNINGS`, plus `timingsStats` |
| WARNINGS | Returns everything from `ERRORS`, plus `warningReports` in `validationReports` | |
| E1005 | Returns only `errorReports` in `validationReports` | In addition, all `reportModes` will return `status`, `stats`, `bundleReport` and `message` when
applicable. |
| E1006 | There are various error codes for different error scenarios. The following table has the list of
error codes thrown from the new Tracker API, along with the error messages and some additional
descriptions. The placeholders in the error messages (`{0}`,`{1}`,`{2}`..) are usually uids unless
otherwise specified. | Error Code |
| E1007 | 描述 | E1000 |
| E1009 | User: `{0}`, has no data write access to TrackedEntityType: `{1}`. | The error occurs when the user is not authorized to create or modify data of the TrackedEntityType `{1}` |
| E1010 | TrackedEntity: `{0}`, already exists. | 系统无法找到在事件有效负载中指定了 uid `{0}` 的项目。这也可能意味着登录用户无法访问特定项目。 |
| E1011 | User: `{0}`, has no write access to TrackedEntity: `{1}`. | E1005  |
| E1012 | Error thrown when trying to fetch a non existing TrackedEntityType with uid `{0}` . This might also mean that the user does not have read access to the TrackedEntityType. | E1006 |
| E1013 | Error thrown when the system was not able to find a matching TrackedEntityAttribute with uid `{0}`. This might also mean that the user does not have access to the TrackedEntityAttribute. | E1007  |
| E1014 | Mismatch between value type of a TrackedEntityAttribute and its provided attribute value. The actual validation error will be displayed in `{1}`. | E1008 |
| E1015 | TrackedEntityInstance: `{0}`, 已经在计划 `{1}` 中注册。 | 如果该计划已存在另一个有效注册，则不能注册该计划。至少必须先完成当前注册。 |
| E1016 | TrackedEntityInstance: `{0}`, 已经在 Program. ` 中注册：{1}`，而且该项目只允许注册一次。 | 根据项目 `{1}` 配置，一个 TrackedEntity 只能注册该项目一次。看起来 TrackedEntity `{0}` 已经在该项目中注册过一次。因此不能再添加另一个注册。 |
| E1018 | E1011 | 有效负载中缺少被定义为项目强制属性的属性值。确保在有效负载中提供强制属性的属性值。  |
| E1019 | E1012 | 注册有效负载中指定的属性 uid `{0}` 与项目无关。  |
| E1020 | 注册日期：`{0}`，不能是未来日期。 | Could not find ProgramStage: `{0}`, linked to Event. |
| E1021 | 事件日期：`{0}`，不能是未来日期。 | 事件发生日期不能是未来日期，除非项目在配置中允许这样做。 |
| E1022 | TrackedEntityInstance: `{0}`，必须与 Program `{1}` 具有相同的 TrackedEntityType。 | 项目被配置为接受与注册有效负载中提供的不同的 TrackedEntityType uid。 |
| E1023 | DisplayIncidentDate 为 true，但属性 occurredAt 为空或格式无效：{0}`。 | 项目已配置 DisplayIncidentDate，但有效载荷中的日期要么为空，要么无效。 |
| E1025 | 属性 enrolledAt 为空或格式无效：{0}`。 | EnrolledAt Date 是注册的必填项。请确保它不是空值，并具有有效的日期格式。 |
| E1029 | E1019 | 事件有效载荷使用项目 `{1}`，该项目未配置为可被组织单位 `{0}` 访问。 |
| E1030 | E1020 | Enrollment date: `{0}`, cannot be a future date. |
| E1031 | E1021 | Incident date: `{0}`, cannot be a future date. |
| E1032 | E1022 | |
| E1033 | 项目被配置为接受与注册有效负载中提供的不同的 TrackedEntityType uid。 | |
| E1035 | 事件：{0}`，ProgramStage 值为 NULL。 | |
| E1036 | 事件：`{0}`，TrackedEntityInstance 没有指向现有对象。 | 系统无法找到事件有效载荷中指定 uid 的 TrackedEntity。这也可能意味着用户没有读取 TrackedEntity 的权限。 |
| E1039 | DisplayIncidentDate is true but property occurredAt is null. | 特定注册的 ProgramStage 已存在一个事件。由于项目阶段被配置为不可重复，因此无法为同一项目阶段添加另一个事件。  |
| E1041 | Property enrolledAt is null. | 注册有效载荷包含一个项目 `{1}`，该项目未配置为可被组织单位 `{0}` 访问。 |
| E1042 | 事件：{0}`，需要有完成日期。 | 如果项目被配置为具有 completeExpiryDays，则 COMPLETED 事件有效负载必须具有 CompletedDate 属性。状态为 "已完成 "的事件应具有非空的 completedDate 属性和有效的日期格式。 |
| E1043 | Event OrganisationUnit: `{0}`, and Program: `{1}`, don't match. | 没有 "F_EDIT_EXPIRED "权限的用户无法更新已过期的事件，因为该事件已在其项目中配置。 |
| E1046 | Event: `{0}`, already exists. | 事件有效负载中应包含 occuredAt 或 scheduledAt 属性。 |
| E1047 | Event occurredAt date is missing. | 事件 occuredAt 或 scheduledAt 的值早于 PeriodType 开始日期。  |
| E1048 | 对象：`{0}`，uid：`{1}`，uid 格式无效。 | 有效的 uid 有 11 个字符。第一个字符必须是字母（a-z 或 A-Z），其余 10 个字符可以是字母数字（a-z 或 A-Z 或 0-9）。 |
| E1049 | Event: `{0}`, do not exist. | E1033 |
| E1050 | E1039 | ProgramStage: `{0}`, is not repeatable and an event already exists. |
| E1055 | 由于项目具有非默认的 CategoryCombo，因此不允许使用默认的 AttributeOptionCombo。 | 项目被配置为包含非默认 CategoryCombo，但请求使用了默认 AttributeOptionCombo。 |
| E1056 | Event occurredAt or scheduledAt has a value that is earlier than the PeriodType start date. | E1049 |
| E1057 | The system could not find an OrganisationUnit with uid `{0}`. | E1050  |
| E1063 | TrackedEntityInstance: `{0}`, 不存在。 | E1051 |
| E1064 | Event completedAt can only be passed in the payload if status is COMPLETED | E1052 |
| E1068 | 找不到 TrackedEntityInstance: `{0}`，链接到 Enrollment。 | E1054 |
| E1069 | E1055 | 系统无法找到注册有效负载中指定的项目。这也可能意味着用户没有项目的读取权限。 |
| E1070 | E1056 | Event date: `{0}`, is before start date: `{1}`, for AttributeOption: `{2}`. |
| E1074 | E1057 | |
| E1075 | The CategoryOption has an end date configured, the Event date in the payload cannot be later than this end date. | |
| E1076 | TrackedEntity: `{0}`, does not exist. | |
| E1077 | E1064 | |
| E1080 | Could not find TrackedEntity: `{0}`, linked to Enrollment. | The system could not find the TrackedEntity specified in the Enrollment payload. This might also mean that the user does not have read access to the TrackedEntity. |
| E1081 | Could not find Program: `{0}`, linked to Enrollment. | 系统无法找到注册有效负载中指定的项目。这也可能意味着用户没有项目的读取权限。 |
| E1082 | Could not find OrganisationUnit: `{0}`, linked to Enrollment. | The system could not find the OrganisationUnit specified in the Enrollment payload. |
| E1083 | FeatureType is missing. | E1075 |
| E1084 | 文件资源：`{0}`，无法找到引用。 | |
| E1085 | 属性：{0}`，值与值类型不匹配：`{1}`. | 属性值类型与其提供的属性值不匹配。 |
| E1089 | E1076 | `{0}` `{1}` is mandatory and can't be null |
| E1090 | Attribute: `{0}`, text value exceed the maximum allowed length: `{0}`. | E1079 |
| E1091 | E1080 | 在项目共享配置中，用户没有该项目的写入权限。 |
| E1095 | E1081 | 在项目阶段共享配置中，用户没有写入该项目阶段的权限。  |
| E1096 | E1082 | 在项目共享配置中，用户没有该项目的读取权限。 |
| E1099 | E1083 | User: `{0}`, is not authorized to modify completed events. |
| E1100 | 用户: `{0}`, 没有'F_TEI_CASCADE_DELETE'权限删除 TrackedEntityInstance: `{1}`。 | Event: `{0}`, references a Program Stage `{1}` that does not belong to Program `{2}`. |
| E1102 | 用户： `{0}`, 没有访问被跟踪实体的权限：`{1}`, 项目：`{2}`, 组合。 | 当用户的组织单位不拥有该特定项目的 TrackedEntity 的所有权时，就会抛出此错误。拥有 TrackedEntity-Program 组合的组织单位应属于用户的捕获范围（有时是搜索范围）。 |
| E1103 | E1091 | User: `{0}`, has no data write access to Program: `{1}`. |
| E1104 | E1095 | 与项目相关联的 TrackedEntityType 的共享配置规定，用户没有数据读取权限。 |
| E1112 | E1096 | User: `{0}`, has no data read access to Program: `{1}`. |
| E1113 | E1099 | User: `{0}`, has no write access to CategoryOption: `{1}`. |
| E1114 | E1100 | User: `{0}`, is lacking 'F_TEI_CASCADE_DELETE' authority to delete TrackedEntity: `{1}`. |
| E1115 | E1102 | |
| E1116 | 当用户的组织单位不拥有该特定项目的 TrackedEntity 的所有权时,就会抛出此错误。拥有 TrackedEntity-Program 组合的组织单位应属于用户的捕获范围(有时是搜索范围)。 | E1103|
| E1117 | There exists undeleted Events for this Enrollment. If the user does not have 'F_ENROLLMENT_CASCADE_DELETE' authority, then these Events has to be deleted first explicitly to be able to delete the Enrollment. | |
| E1118 | User: `{0}`, has no data read access to program: `{1}`, TrackedEntityType: `{2}`. | |
| E1119 | E1112 | |
| E1120 | 项目阶段 `{0}` 不允许用户赋值 | 事件有效载荷具有 assignedUserId，但项目阶段未配置为允许用户分配。 |
| E1121 | If the Enrollment is soft deleted, no modifications on it are allowed. | |
| E1122 | TrackedEntity: `{0}`, is already deleted and can't be modified. | |
| E1123 | E1115 | |
| E1124 | E1116 | |
| E1125 | 值 `{0}` 不是选项集 `{3}` 中 `{1}` `{2}` 的有效选项。 | |
| E1300 | 由项目规则生成 (`{0}`) - `{1}` | |
| 事件有效载荷具有 assignedUserId,但项目阶段未配置为允许用户分配。 | 由项目规则生成 (`{0}`) - 不存在强制性数据元素 `{1}` | |
| E1302 | E1122 | |
| E1303 | E1123 | |
| E1304 | E1124 | |
| E1305 | 数据元素 `{0}` 不是 `{1}` 项目阶段的一部分 | |
| E1306 | 由项目规则 (`{0}`) 生成 - 不存在强制属性 `{1}` | |
| E1307 | 由项目规则生成 (`{0}`) - 无法为数据元素 `{1}` 赋值。提供的值必须为空或与计算值 `{2}` 匹配。 | |
| E1308 | 由项目规则 (`{0}`) 生成 - 数据元素 `{1}` 被事件 `{2}` 替换 | |
| E1309 | 由项目规则 (`{0}`) 生成 - 无法为属性 `{1}` 赋值。提供的值必须为空或与计算值 `{2}` 匹配。 | |
| E1310 | 由项目规则 (`{0}`) 生成 - 属性 `{1}` 被替换为 `{2}` | |
| 由项目规则生成 (`{0}`) - 不存在强制性数据元素 `{1}` | E1302 | DataElement `{0}` is not valid: `{1}` |
| E1303 | 由项目规则 (`{0}`) 生成 - 数据元素 `{1}` 是必填项，不能删除。 | |
| E1304 | DataElement `{0}` is not a valid data element| |
| E1305 | 数据元素 `{0}` 不是 `{1}` 项目阶段的一部分 | |
| E1306 | 由项目规则 (`{0}`) 生成 - 属性 `{1}` 是强制性的，不能删除。 | |
| E4000 | 由项目规则生成 (`{0}`) - 无法为数据元素 `{1}` 赋值。提供的值必须为空或与计算值 `{2}` 匹配。 | |
| E4001 | 由项目规则 (`{0}`) 生成 - 数据元素 `{1}` 被事件 `{2}` 替换 | |
| E4006 | 由项目规则 (`{0}`) 生成 - 无法为属性 `{1}` 赋值。提供的值必须为空或与计算值 `{2}` 匹配。 | |
| E4009 | 关系类型 `{0}` 无效。 | |
| E4010 | 由项目规则 (`{0}`) 生成 - 属性 `{1}` 被替换为 `{2}` | |
| E4012 | Event {0} of an enrollment does not point to an existing tracked entity. The data in your system might be corrupted | |
| E4014 | E1314 | |
| 由项目规则 (`{0}`) 生成 - 数据元素 `{1}` 是必填项,不能删除。 | E1315 | |
| Status `{0}` does not allow defining data values. Statuses that do allow defining data values are: {1} | E1316 | |
| No event can transition from status `{0}` to status `{1}`. | E1317 | |
| 由项目规则 (`{0}`) 生成 - 属性 `{1}` 是强制性的,不能删除。 | E4000 | |
| Relationship: `{0}` cannot link to itself | E4001 | |
| Relationship Item `{0}` for Relationship `{1}` is invalid: an Item can link only one Tracker entity. | E4006 | 导入项目无法持久化跟踪器对象，因为引用无法持久化。 |
| E9999 | 不适用 | E4012 |

### 验证方式 { #webapi_nti_validation }

使用跟踪器导入项目导入数据时，会执行一系列验证以确保数据的有效性。本节将介绍执行的一些不同类型的验证，以便更好地了解导入验证是否失败。

#### 所需属性{ #required-properties } 

在导入数据时，每个跟踪器对象都有一些必须具备的属性。有关所需属性的完整列表，请参阅[跟踪器对象部分](tracker.md#webapi_nti_tracker_objects)。

在验证必填属性时，我们通常说的是对其他数据或元数据的引用。在这种情况下，有三个主要标准：

1. E4016
2. Relationship: `{0}`, do not exist.
3. E4017

如果第一个条件失败，导入将失败，并提示缺少引用。但是，假设引用指向的内容不存在或用户无法访问。在这种情况下，这两种情况都会导致无法找到引用的信息。

#### 格式{ #formats } 

跟踪器对象的某些属性需要特定的格式。在导入数据时，这些属性中的每个属性都会根据预期格式进行验证，并根据格式错误的属性返回不同的错误信息。以下是一些通过这种方式验证的属性示例：

- E4020
- User: `{0}`, has no write access to relationship: `{1}`.
- E5000

#### 用户访问{ #user-access } 
所有导入的数据都将根据数据中引用的元数据（[共享](tracker.md#webapi_nti_metadata_sharing)）和组织单位（[组织单位范围](tracker.md#webapi_nti_ou_scope)）进行验证。有关共享和组织单位作用域的更多信息，请参阅以下章节。

在数据库中查找引用的同时，也会验证共享。用户访问权限之外的元数据将被视为不存在。导入将验证数据中引用的任何元数据。

另一方面，组织单位具有双重作用。它主要是确保数据只有在导入用户 "捕获范围 "内的组织单位时才能导入。其次，组织单位还用于限制可用的项目。这意味着，如果你试图为一个无法访问你要导入的项目的组织单位导入数据，导入将是无效的。

拥有 "ALL "权限的用户在导入数据时将忽略共享和组织单位范围的限制。但是，他们不能导入不能访问注册程序的组织单位的注册信息。

#### 属性和数据值{ #attribute-and-data-values } 

属性和数据值分别是被跟踪实体和事件的一部分。不过，属性可以通过类型（TrackedEntityType）或项目（Program）与被跟踪实体关联。此外，属性也可以是唯一的。

导入过程中的初始验证是确保为属性或数据元素提供的值符合预期的值类型。例如，假设你导入了一个数值类型数据元素的值。在这种情况下，预期值就是数值。任何与类型和值不匹配相关的错误都会导致相同的错误代码，但会有与违规类型相关的特定消息。

强制性属性和数据值也会被检查。目前不允许删除强制属性。有些用例要求单独发送值，而有些用例则要求将所有值作为一个整体发送。程序可配置为在 "ON_COMPLETE "或 "ON_UPDATE_AND_INSERT "时验证强制属性，以适应这些用例。

导入时将验证唯一属性。也就是说，只要所提供的值在整个系统中是唯一的属性，就会通过。但是，如果发现唯一值被导入实体以外的任何其他跟踪实体使用，则导入将失败。

#### 组态 { #configuration } 

导入项目中最后一部分验证是基于用户对相关元数据的配置进行的验证。有关每种配置的更多信息，请查看相关章节。可配置验证的一些示例：
- 特征类型（用于几何图形）
- If the first condition fails, the import will fail with a message about a missing reference.
However, suppose the reference points to something that doesn't exist or which the user cannot
access. In that case, both cases will result in a message about the reference not being found.
- Formats
- Some of the properties of tracker objects require a specific format. When importing data, each of
these properties is validated against the expected format and will return different errors depending
on which property has a wrong format. Some examples of properties that are validated this way:
- 还有更多

UIDs (These cover all references to other data or metadata in DHIS2.)

### 计划规则{ #webapi_nti_program_rules }

用户可以配置[项目规则](metadata.md#webapi_program_rules)，为跟踪器表单添加条件行为。除了在跟踪器应用项目中运行这些规则外，跟踪器导入项目也将运行这些规则的一部分。由于导入项目也会运行这些规则，因此我们可以确保额外的验证级别。

并非所有项目规则操作都受支持，因为它们只适用于前台演示。受支持的项目规则操作的完整列表如下。

  |计划规则行动|支持的|
  |---|:---:|
  |**显示文本**| |
  |**显示键值配对**| |
  |**HIDEFIELD**||
  |**隐藏部分**||
  |**分配**|**X**|
  |**显示警告**|**X**|
  |**淋浴**|**X**|
  |**完成时发出警告**|**X**|
  |**完成时出错**|**X**|
  |**创建活动**||
  |**设置必填字段**|**X**|
  |**发送信息**|**X**|
  |**日程安排信息**|**X**|

项目规则在导入项目中的评估方式与在 Tracker 应用项目中的评估方式相同。总之，执行项目规则时会考虑以下条件：

* 项目规则必须与导入的数据相关联。例如，项目阶段或数据元素。
* 项目规则的条件必须为真

项目规则的结果取决于这些规则中定义的操作：

* 项目规则操作可能会导致两种不同的结果：警告或错误。
  * X
    * SHOWWARNING 和 WARNINGONCOMPLETION 操作只能生成警告。
    * SHOWERROR、ERRORONCOMPLETION 和 SETMANDATORYFIELD 操作只能生成错误。
    * ASSIGN 操作既可生成警告，也可生成错误。
      * X
      * ERRORONCOMPLETION
      * 当操作要为一个已有值的属性/数据元素赋值，而要赋的值不同时，除非 `RULE_ENGINE_ASSIGN_OVERWRITE` 系统设置为 true，否则会产生错误。

此外，项目规则也会产生副作用，如发送和计划信息。有关副作用的更多信息，请参阅下一节。

> **注**
>
> 在导入过程中，可以使用 `skipProgramRules` 参数跳过项目规则。

### 副作用{ #webapi_nti_side_effects }

导入完成后，可能会触发一些特定任务。这些任务就是我们所说的 "副作用"。这些任务执行的操作并不影响导入本身。

副作用是脱离导入运行的任务，但总是由导入触发。由于副作用与导入分离，因此即使导入成功，副作用也可能失败。此外，只有在导入成功时才会运行侧效应，因此侧效应也不会失败。

SCHEDULEMESSAGE

  |X|支持的|描述|
  |---|:---:|---|
  |**跟踪通知**|**X**| 更新可触发通知。触发通知的更新包括**注册**、**事件更新**、**事件或注册完成**。 |
  |**计划规则通知***|**X**| 项目规则可触发通知。请注意，这些通知是通过 DHIS2 规则引擎生成的项目规则效果的一部分。|

  > **注**
  >
  > 某些配置可以控制副作用的执行。可以在导入过程中设置 `skipSideEffects` 标志，以完全跳过副作用。例如，如果你导入了一些不想触发通知的内容，这个参数就很有用。

### 为事件分配用户{ #webapi_nti_user_event_assignment }

将事件当作任务来处理，对特定的工作流程大有裨益，因此可以为事件分配一个用户。

为事件指定用户不会改变用户的访问权限，但会在事件和用户之间创建一个链接。
当一个事件分配了一个用户时，您可以使用 API 中的 "assignedUser "字段作为参数来查询事件。

要为事件分配用户时，只需在 `assignedUser` 字段中提供要分配的用户的 UID 即可。请参阅以下示例：

```json
{
  ...
  "events": [
    {
      "event": "ZwwuwNp6gVd",
      "programStage": "nlXNK4b7LVr",
      "orgUnit": "O6uvpzGd5pu",
      "enrollment": "MNWZ6hnuhSw",
      "assignedUser" : "M0fCOxtkURr"
    }
  ],
  ...
}

GET /api/tracker/trackedEntities?orgUnit=DiszpKrYNg8

GET /api/tracker/trackedEntities?filter=zHXD5Ve1Efw:EQ:A
    &attribure=AMpUYgxuCaE&orgUnit=DiszpKrYNg8;yMCshbaVExv

GET /api/tracker/trackedEntities?filter=zHXD5Ve1Efw:EQ:A
    &filter=AMpUYgxuCaE:LIKE:Road
    &orgUnit=DiszpKrYNg8

GET /api/tracker/trackedEntities?orgUnit=DiszpKrYNg8
    &program=ur1Edk5Oe2n
    &filter=lw1SqmMlnfh:GT:150
    &filter=lw1SqmMlnfh:LT:190

GET /api/tracker/trackedEntities?orgUnit=DiszpKrYNg8
    &program=ur1Edk5Oe2n
    &filter=lw1SqmMlnfh:EQ:/:/,//

GET /api/tracker/trackedEntities?orgUnit=DiszpKrYNg8
    &filter=dv3nChNSIxy:IN:Scott;Jimmy;Santiago

GET /api/tracker/trackedEntities?filter=zHXD5Ve1Efw:EQ:A
    &orgUnit=O6uvpzGd5pu&ouMode=DESCENDANTS
    &program=ur1Edk5Oe2n

GET /api/tracker/trackedEntities?
    &orgUnit=O6uvpzGd5pu&program=ur1Edk5Oe2n
    &enrollmentEnrolledAfter=2013-01-01
    &enrollmentEnrolledBefore=2013-09-01

GET /api/tracker/trackedEntities?filter=zHXD5Ve1Efw:EQ:A
    &orgUnit=O6uvpzGd5pu
    &ouMode=DESCENDANTS
    &trackedEntity=cyl5vuJ5ETQ

GET /api/tracker/trackedEntities?filter=zHXD5Ve1Efw:EQ:A
    &orgUnit=O6uvpzGd5pu
    &ouMode=DESCENDANTS
    &page=2&pageSize=3

{
  "instances": [
    {
      "trackedEntity": "IzHblRD2sDH",
      "trackedEntityType": "nEenWmSyUEp",
      "createdAt": "2014-03-26T15:40:36.669",
      "createdAtClient": "2014-03-26T15:40:36.669",
      "updatedAt": "2014-03-28T12:28:17.544",
      "orgUnit": "g8upMTyEZGZ",
      "inactive": false,
      "deleted": false,
      "relationships": [],
      "attributes": [
        {
          "attribute": "VqEFza8wbwA",
          "code": "MMD_PER_ADR1",
          "displayName": "Address",
          "createdAt": "2016-01-12T00:00:00.000",
          "updatedAt": "2016-01-12T00:00:00.000",
          "valueType": "TEXT",
          "value": "1061 Marconi St"
        },
        {
          "attribute": "RG7uGl4w5Jq",
          "code": "Longitude",
          "displayName": "Longitude",
          "createdAt": "2016-01-12T00:00:00.000",
          "updatedAt": "2016-01-12T00:00:00.000",
          "valueType": "TEXT",
          "value": "27.866613"
        },
        ...,
        ...,
      ],
      "enrollments": [],
      "programOwners": []
    }
  ],
  "page": 1,
  "total": 39,
  "pageSize": 1
}

GET /api/tracker/trackedEntities/IzHblRD2sDH?program=ur1Edk5Oe2n&fields=*

### 事件 (`GET /api/tracker/events`){ #events-get-apitrackerevents } 

有两个端点专门用于处理事件：

- `GET /api/tracker/events`
    - 检索符合给定条件的事件
- `GET /api/tracker/events/{id}`
    - 检索给定 id 的事件

#### 事件收集端点 `GET /api/tracker/events`{ #events-collection-endpoint-get-apitrackerevents } 

ID

|允许值|类型|`order`|描述|
|---|---|---|---|
|程序|JSON格式|```
GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=lxAQ7Zs9VYR&filter=DanTR5x0WDK:EQ:/:/,//
```| 计划标识符|
|程序阶段|JSON格式|```
GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=lxAQ7Zs9VYR&filter=DanTR5x0WDK:EQ:/:/,//
```| 日期时间|
|程序状态|`enum`| `ACTIVE`|`COMPLETED`|`CANCELLED`| 事件在项目中的状态 |
|All endpoints of the `/gist` API accept the same set of parameters.
Parameters and their options that do not make sense in the endpoint context are 
ignored.|JSON格式|Returns a list of events based on the provided filters.|将响应缩小到与给定过滤器匹配的事件。过滤器是以冒号分隔的属性或数据元素 UID，带有操作符和值对。例如：`filter=fazCI2ygYkq:eq:PASSIVE`，操作符以`eq`开头，后跟一个值。作为过滤器值一部分的字符，如 `:`（冒号）或 `,`（逗号），需要用 `/`（斜线）转义。同样，`/` 也需要转义。允许对同一属性/数据元素使用多个操作符/值对，如 `filter=qrur9Dvnyt5:gt:70:lt:80`。不允许重复相同的数据元素 UID。用户需要访问数据元素才能对其进行筛选。|
|过滤器属性|JSON格式|描述|将响应缩小到符合给定过滤器的 TEI。过滤器是以冒号分隔的属性或属性 UID，带有可选的操作符和值对。例如：`filterAttributes=H9IlTX2X6SL:sw:A`，操作符以`sw`开头，后跟一个值。像 `filterAttributes=H9IlTX2X6SL` 这样的过滤器会返回给定属性有值的所有事件。特殊字符（如 `+`）需要按百分比编码，因此应使用 `%2B` 代替 `+`。作为过滤值一部分的字符，如 `:`（冒号）或 `,`（逗号），需要用 `/`（斜线）转义。同样，`/` 也需要转义。允许对同一属性使用多个操作符/值对，如 `filterAttributes=AuPLng5hLbE:gt:438901703:lt:448901704`。不允许重复相同的属性 UID。用户需要访问属性才能对其进行筛选。|
|跟进|`boolean`| `true`|`false` | 项目阶段|
|`trackedEntityInstance`|JSON格式|```
GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=lxAQ7Zs9VYR&filter=DanTR5x0WDK:EQ:/:/,//
```| 被跟踪实体实例的标识符|
|`orgUnit`|JSON格式|```
GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=lxAQ7Zs9VYR&filter=DanTR5x0WDK:EQ:/:/,//
```| filter|
|`ouMode` 见 [ouModes](#Request-parameters-for-Organisational-Unit-selection-mode)。|JSON格式| `SELECTED`|`CHILDREN`|`DESCENDANTS`|  机关单位选择模式|
|状态|JSON格式|`ACTIVE`|`COMPLETED`|`VISITED`|`SCHEDULE`|`OVERDUE`|`SKIPPED` | 跟进|
|发生在|日期时间|[ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) | trackedEntity|
|之前发生|日期时间| [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)| orgUnit|
|计划之后|日期时间|[ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) | orgUnitMode see [orgUnitModes](#webapi_tracker_orgunit_scope)|
|计划之前|日期时间| [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)| status|
|更新后|日期时间| [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)| occurredAfter|
|更新前|日期时间|[ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) | occurredBefore|
|更新范围|持续时间| [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Durations)| Include only items which are updated within the given duration.<br><br> The format is [ISO-8601#Duration](https://en.wikipedia.org/wiki/ISO_8601#Durations)|
|注册后|日期时间|[ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)|指定计划的注册开始日期|
|注册之前|日期时间|[ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)|指定项目的注册结束日期|
|注册发生在`之后|日期时间|[ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)|指定计划中事件的开始日期|
|注册发生在`之前|日期时间|[ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)|给定项目中事件的结束日期|
|跳过内容|`Boolean`| `true`&#124;`false` | 排除响应的元数据部分（提高性能）|
|extent of fields selected by `*` field selector|JSON格式|支持的字段有`assignedUser, assignedUserDisplayName, attributeOptionCombo, completedAt, completedBy, createdAt, createdBy, deleted, enrolledAt, enrollment, enrollmentStatus, event, followup, occurredAt, orgUnit, orgUnitName, program, programStage, scheduleAt, status, storedBy, trackedEntity, updatedAt, updatedBy`.|以逗号分隔的属性名称、属性或数据元素 UID 和排序方向对的列表，格式为 `propName:sortDirection`。<br><br> **注意：** `propName` 区分大小写，`sortDirection` 不区分大小写。 |
|事件|JSON格式|以逗号分隔的 `uid` 列表| Filter the result down to a limited set of IDs by using event=id1;id2.|
|`skipEventId`|`Boolean`| | 跳过响应中的事件标识符|
|属性 Cc"（见注释）|JSON格式| 属性类别组合标识符（必须与 attributeCos 结合使用）|
|属性 Cos"（见注释）|JSON格式| 属性类别选项标识符，用 ; 分隔（必须与 attributeCc 结合使用）|
|包括删除|`Boolean`| |  IdScheme used for category option references. Defaults to the `idScheme` parameter.|
|指定用户模式|JSON格式| `CURRENT`&#124;`PROVIDED`&#124;`NONE`&#124;`ANY`| 串|
|指定用户|JSON格式|以逗号分隔的列表 od `uid`| 使用`assignedUser=id1;id2`将结果筛选到分配给给定用户 ID 的有限事件集。<br><br> 只有当 assignedUserMode 为`PROVIDED`或`null`时，才会考虑该参数。<br><br> 如果出现`assignedUserMode=CURRENT`和`assignedUser=someId`等情况，API 将出错。|

> **注**
>
> 如果查询既不包含 `attributeCC` 也不包含 `attributeCos`、
> 服务器将返回用户具有读取权限的所有属性选项组合的事件。

##### 请求示例{ #example-requests } 

attributeCategoryCombo (see note)

    GET /api/tracker/events?orgUnit=YuQRtpLP10I&ouMode=CHILDREN

查询特定组织单位所有后代的所有事件
单位的所有事件，即子层次结构中的所有组织单位：

    GET /api/tracker/events?orgUnit=O6uvpzGd5pu&ouMode=DESCENDANTS

使用特定程序和组织单位查询所有事件：

    GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=eBAyeGv0exc

查询具有一定节目和组织单位的所有事件，
按截止日期排序
    上升：

    GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=eBAyeGv0exc&order=dueDate

查询某节目中活动日期最新的10个活动
和组织单位 - 按到期日降序分页和排序：

    GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=eBAyeGv0exc
      &order=eventDate:desc&pageSize=10&page=1

查询具有特定节目和组织单位的所有事件
特定的跟踪实体实例：

    GET /api/tracker/events?orgUnit=DiszpKrYNg8
      &program=eBAyeGv0exc&trackedEntityInstance=gfVxE3ALA9m

查询某个程序和组织单位较旧的所有事件
或等于
    2014-02-03：

    GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=eBAyeGv0exc&endDate=2014-02-03

查询具有一定节目阶段、组织单位和
2014年被跟踪实体实例：

    GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=eBAyeGv0exc
      &trackedEntityInstance=gfVxE3ALA9m&occurredAfter=2014-01-01&occurredBefore=2014-12-31

串

    GET /api/tracker/events?orgUnit=DiszpKrYNg8
        &program=lxAQ7Zs9VYR
        &filter=lw1SqmMlnfh:GT:150
        &filter=lw1SqmMlnfh:LT:190

Filter the result down to a limited set of tracked entities with events that are assigned to the given user IDs by using `assignedUser=id1,id2`.This parameter will only be considered if `assignedUserMode` is either `PROVIDED` or `null`. The API will error out, if for example, `assignedUserMode=CURRENT` and `assignedUser=someId`.

    GET /api/tracker/events?orgUnit=DiszpKrYNg8
        &program=lxAQ7Zs9VYR
        &filter=lw1SqmMlnfh:EQ:/:/,//

##### 回应格式 { #response-format } 

JSON` 响应可以如下所示。

``json
{
    "实例"：[
        {
            "event"："rgWr86qs0sI"、
            "状态"："ACTIVE"、
            "程序"："kla3mAPgvCH"、
            "程序阶段"： "aNLq9ZYoy9W"："aNLq9ZYoy9W"、
            "orgUnit"："DiszpKrYNg8"、
            "orgUnitName"："Ngelehun CHC"、
            "关系"：[],
            "occurredAt"："2021-10-12T00:00:00.000",
            "followup": false、
            "deleted": false、
            "createdAt"："2018-10-20T12:09:19.492",
            "更新时间"： false"2018-10-20T12:09:19.492",
            "attributeOptionCombo"："amw2rQP6r6M"、
            "attributeCategoryOptions"："RkbOhHwiOgW"、
            "dataValues"（数据值）： [[
                {
                    "createdAt"："2015-10-20T12:09:19.640",
                    "更新时间"："2015-10-20T12:09:19.640",
                    "storedBy"："系统"、
                    "providedElsewhere": false、
                    "dataElement"："HyJL2Lt37jN"、
                    "值"："12"
                },
              ...
            ],
            "备注"：[]
        }
    ],
    "页"：1,
    "页面大小"：1
}

|事件|状态|计划|计划阶段|注册|机构单位|发生在|计划在|数据元素|值|存储在|提供的其他地方
|---|---|---|---|---|---|---|---|---|---|---|---|
|V1CerIi3sdL|COMPLETED|IpHINAT79UW|A03MvHHogjR|CCBLMntFuzb|DiszpKrYNg8|2020-02-26T23:00:00Z|2020-02-27T23:00:00Z|a3kGcGDCuk6|11|admin|false
|V1CerIi3sdL|COMPLETED|IpHINAT79UW|A03MvHHogjR|CCBLMntFuzb|DiszpKrYNg8|2020-02-26T23:00:00Z|2020-02-27T23:00:00Z|mB2QHw1tU96|[-11.566044,9.477801]|admin|false

GET /api/tracker/events/rgWr86qs0sI

### 注册人数 (`GET /api/tracker/enrollments`){ #enrollments-get-apitrackerenrollments } 

有两个端点专门用于注册：

- `GET /api/tracker/enrollments`
    - Tracked entity `UID`.
- `GET /api/tracker/enrollments/{id}`
    - 检索给定 id 的注册信息

#### 注册信息收集端点 `GET /api/tracker/enrollments`{ #enrollment-collection-endpoint-get-apitrackerenrollments } 

order

|允许值|类型|`order`|描述|
|---|---|---|---|
|`orgUnit`|JSON格式|```
GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=lxAQ7Zs9VYR&filter=DanTR5x0WDK:EQ:/:/,//
```| filter|
|`ouMode` 见 [ouModes](#Request-parameters-for-Organisational-Unit-selection-mode)。|JSON格式| `SELECTED`|`CHILDREN`|`DESCENDANTS`|`ACCESSIBLE`|`CAPTURE`|`ALL| 机关单位选择模式|
|程序|JSON格式|```
GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=lxAQ7Zs9VYR&filter=DanTR5x0WDK:EQ:/:/,//
```| 计划标识符|
|程序状态|`enum`| `ACTIVE`|`COMPLETED`|`CANCELLED`| 计划状态 |
|跟进|`boolean`| `true`|`false` | 跟踪给定程序的实例状态。可以是 `true`|`false` 或省略。|
|更新后|日期时间|[ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) | 项目|
|更新范围|持续时间| [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)| 项目状态 **已过时,将在第 43 版中移除,使用 `status`** |
|注册后|日期时间| [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)|  status|
|注册前|日期时间| [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)| 跟进|
|跟踪实体类型|JSON格式|```
GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=lxAQ7Zs9VYR&filter=DanTR5x0WDK:EQ:/:/,//
```| 被跟踪实体类型的标识符|
|`trackedEntity`|JSON格式|```
GET /api/tracker/events?orgUnit=DiszpKrYNg8&program=lxAQ7Zs9VYR&filter=DanTR5x0WDK:EQ:/:/,//
```| 被跟踪实体实例的标识符|
|注册|JSON格式|以逗号分隔的 `uid` 列表| Filter the result down to a limited set of IDs by using enrollment=id1;id2.|
|包括删除|`Boolean`| |  IdScheme used for category option references. Defaults to the `idScheme` parameter.|
|extent of fields selected by `*` field selector|JSON格式|`UID`, `CODE`, `NAME`, `ATTRIBUTE:{uid}`|以逗号分隔的属性名称、属性或数据元素 UID 和排序方向对列表，格式为 `propName:sortDirection`。|

查询不区分大小写。以下规则适用于查询参数。

- orgUnitIdScheme
  参数（一个或多个）或 *ouMode=ALL* 必须指定。

- 只能使用 *program* 和 *trackedEntity* 参数之一
  指定（零或一）。

- 如果指定了 *programStatus*，那么 *program* 也必须是
  指定的。

- 如果指定了*followUp*，则还必须指定*program*。

- 如果指定了 *enrolledAfter* 或 *enrolledBefore*，则还必须指定 *program*。

##### 请求示例{ #example-requests } 

查询与特定组织单位关联的所有注册
看起来像这样：

    GET /api/tracker/enrollments?orgUnit=DiszpKrYNg8

限制对作为特定活动一部分的注册的响应
程序，您可以包含程序查询
    范围：

    GET /api/tracker/enrollments?orgUnit=O6uvpzGd5pu&ouMode=DESCENDANTS&program=ur1Edk5Oe2n

要将程序注册日期指定为查询的一部分，请执行以下操作：

    GET /api/tracker/enrollments?&orgUnit=O6uvpzGd5pu&program=ur1Edk5Oe2n
      &enrolledAfter=2013-01-01&enrolledBefore=2013-09-01

限制对特定被跟踪实体的注册的响应
您可以包含跟踪实体查询
    范围：

    GET /api/tracker/enrollments?orgUnit=O6uvpzGd5pu&ouMode=DESCENDANTS&trackedEntity=cyl5vuJ5ETQ

要限制对特定被跟踪实体注册的响应
可以包含一个被跟踪实体实例查询参数，在
在本例中，我们将其限制为可为
当前
用户可查看的可用注册：

    GET /api/tracker/enrollments?ouMode=ACCESSIBLE&trackedEntity=tphfdyIiVL6

##### 回应格式 { #response-format } 

JSON` 响应可以如下所示。

```json
{
  "instances": [
    {
      "enrollment": "iKaBMOyq7QQ",
      "createdAt": "2017-03-28T12:28:19.812",
      "createdAtClient": "2016-03-28T12:28:19.812",
      "updatedAt": "2017-03-28T12:28:19.817",
      "trackedEntity": "PpqV8ytvW5i",
      "trackedEntityType": "nEenWmSyUEp",
      "program": "ur1Edk5Oe2n",
      "status": "ACTIVE",
      "orgUnit": "NnQpISrLYWZ",
      "orgUnitName": "Govt. Hosp. Bonthe",
      "enrolledAt": "2020-10-23T12:28:19.805",
      "occurredAt": "2020-10-07T12:28:19.805",
      "followUp": false,
      "deleted": false,
      "events": [],
      "relationships": [],
      "attributes": [],
      "notes": []
    }
  ],
  "page": 1,
  "total": 1,
  "pageSize": 5
}

GET /api/tracker/enrollments/iKaBMOyq7QQ

{
  "enrollment": "iKaBMOyq7QQ",
  "createdAt": "2017-03-28T12:28:19.812",
  "createdAtClient": "2016-03-28T12:28:19.812",
  "updatedAt": "2017-03-28T12:28:19.817",
  "trackedEntity": "PpqV8ytvW5i",
  "trackedEntityType": "nEenWmSyUEp",
  "program": "ur1Edk5Oe2n",
  "status": "ACTIVE",
  "orgUnit": "NnQpISrLYWZ",
  "orgUnitName": "Govt. Hosp. Bonthe",
  "enrolledAt": "2020-10-23T12:28:19.805",
  "occurredAt": "2020-10-07T12:28:19.805",
  "followUp": false,
  "deleted": false,
  "events": [],
  "relationships": [],
  "attributes": [],
  "notes": []
}

/ api / 33 / tracker / ownership / override？trackedEntityInstance = DiszpKrYNg8
  ＆program = eBAyeGv0exc＆reason =耐心+显示+急诊+急诊

/ api / 33 / tracker /所有权/转让？trackedEntityInstance = DiszpKrYNg8
  ＆program = eBAyeGv0exc＆ou = EJNxP3WreNP