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

可视化¶

您可以使用“写反馈”工具来创建工单和消息。¶

一张票和一条消息的唯一区别是你可以给票证的状态和优先级。设置状态:

POST / api / messageConversations / <uid> / status

设置优先级:

POST / api / messageConversations / / priority¶

在 2.29 中,验证分析生成的消息现在也用于状态和优先级属性。默认情况下,消息由验证分析将继承验证规则的优先级问题,或者如果消息包含多个最重要的规则。

在 2.30 中,可以将验证规则分配给任何用户,同时工单仍然需要分配给系统反馈接收者中的一个用户团体。

Table: A list of valid status and priority values

状态

Priority

OPEN

LOW

PENDING

MEDIUM¶

INVALID

HIGH

SOLVED

也可以给工单添加内部消息,只能看到拥有“管理票证”权限的用户。创建一个内部回复,包括“内部”参数,并将其设置为

curl -d "This is an internal message"
  "https://play.dhis2.org/demo/api/33/messageConversations/ZjHHSjyyeJ2?internal=true"
  -H "Content-Type:text/plain" -u admin:district -X POST

可视化
仪表板 { #webapi_dashboard }
仪表板旨在为您提供多个分析的概览地图、图表、数据透视表和报告等项目,它们一起可以提供您数据的全面概览。仪表板可用通过 dashboards 资源在 Web API 中。仪表板包含一个仪表板*项目*列表。一个项目可以代表一个单一的资源,比如图表、地图或报告表,或表示指向分析的链接列表资源,如报告、资源、表格报告和用户。一种仪表板项目最多可以包含八个链接。通常,仪表板客户可以选择直接在一个用户界面,同时将多对象项目渲染为可点击链接。

/ api /仪表板

| eventCreatedPeriod | Parameter name | Potential duplicate status | 仪表板资源将提供仪表板列表。请记住仪表板对象是共享的,因此列表将受当前已验证的用户。您可以检索有关一个的更多信息特定的仪表板,请点击其链接,类似于: | |---|---|---|---| | /api/dashboards/vQFhmLJU5sK.json | 仪表板包含名称和创建日期等信息以及仪表板项目数组。 JSON 格式的响应看起来类似对此回复(某些信息已被删除,以便简洁)。 | 搜索仪表板 { #webapi_searching_dasboards } | 6 | | 通过指定特定字段可以获得更定制的响应在请求中。下面提供了一个示例,它将返回更多有关用户仪表板上每个对象的详细信息。 | / api / dashboards / vQFhmLJU5sK /?fields =:all,dashboardItems [:all] | 搜索仪表板 { #webapi_searching_dasboards } | 25 | | 最小-最大数据元素 { #webapi_min_max_data_elements } | /api/dashboards/q/my-query.json /api/dashboards/search?q=my-query | 例如,此查询: | Relationship Type {0} constraint requires a {1} but a {2} was found. |

将搜索以下内容:

分析对象名称包含字符串“ ma”

每种类型最多返回6¶

For REPORT and MAP types, return up to 20 items

Table: dashboards/q and dashboards/search query parameters

查询参数

描述

类型

默认¶

计数

添加可视化{ #add-a-visualization }¶

Positive integer

String [MAP|USER|REPORT|RESOURCE|VISUALIZATION#124;EVENT_VISUALIZATION,EVENT_CHART,EVENT_REPORT]

The number of items of max types to return

Positive integer

更新项目{ #update-an-item }¶

The type to return the maxCount for

String [MAP|USER|REPORT|RESOURCE|VISUALIZATION#124;EVENT_VISUALIZATION,EVENT_CHART,EVENT_REPORT]

不适用

删除项目{ #remove-an-item }¶

{
  "visualizations": [{
    "name": "ANC: ANC 3 Visits Cumulative Numbers",
    "id": "arf9OiyV7df",
    "type": "LINE"
  }, {
    "name": "ANC: 1st and 2rd trends Monthly",
    "id": "jkf6OiyV7el",
    "type": "PIVOT_TABLE"
  }],
  "eventVisualizations": [{
    "name": "Inpatient: Cases 5 to 15 years this year (case)",
    "id": "TIuOzZ0ID0V",
    "type": "LINE_LIST"
  }, {
    "name": "Inpatient: Cases last quarter (case)",
    "id": "R4wAb2yMLik",
    "type": "LINE_LIST"
  }],
  "maps": [{
    "name": "ANC: 1st visit at facility (fixed) 2013",
    "id": "YOEGBvxjAY0"
  }, {
    "name": "ANC: 3rd visit coverage 2014 by district",
    "id": "ytkZY3ChM6J"
  }],
  "reports": [{
    "name": "ANC: 1st Visit Cumulative Chart",
    "id": "Kvg1AhYHM8Q"
  }, {
    "name": "ANC: Coverages This Year",
    "id": "qYVNH1wkZR0"
  }],
  "searchCount": 8,
  "visualizationCount": 2,
  "eventVisualizationCount": 2,
  "mapCount": 2,
  "reportCount": 2,
  "userCount": 0,
  "eventReports": 0,
  "eventCharts" :0,
  "resourceCount": 0
}

String [MAP|USER|REPORT|RESOURCE|VISUALIZATION#124;EVENT_VISUALIZATION,EVENT_CHART,EVENT_REPORT]

创建、更新和删除仪表板遵循标准 REST¶

语义。为了创建一个新的仪表板,您可以创建一个 POST 请求/api/dashboards 资源。从消费者的角度首先创建仪表板然后添加项目可能会很方便到它。请求有效负载支持 JSON 和 XML 格式。至创建一个名为“我的仪表板”的仪表板,您可以在其中使用有效负载像这样的 JSON:

{
  “名称”:“我的仪表板”
}

更新,例如重命名,仪表板,您可以使用 PUT 请求类似的请求负载相同的 api/dashboards 资源。

要删除仪表板,您可以向特定的人发出 DELETE 请求与此类似的仪表板资源:

/ api /仪表板/ vQFhmLJU5sK

ValidationRuleGroup	Parameter name	Potential duplicate status
To add a visualization to a specific dashboard, send a PUT request to:	```
/api/dashboards/ChZ236jPgXs
```	UID \
```json
{
"name": "test",
"layout": {
"columns": []
},
"itemConfig": {
"insertPosition": "END"
},
"restrictFilters": false,
"allowedFilters": [],
"favorites": [],
"displayName": "test",
"user": {
"id": "xE7jOejl9FI",
"code": null,
"name": "John Traore",
"username": "admin"
},
"id": "ChZ236jPgXs",
"dashboardItems": [
{
"x": 0,
"y": 0,
"w": 20,
"h": 29,
"id": "cKd9PKBuHv6",
"type": "VISUALIZATION",
"position": null,
"visualization": {
"id": "LW0O27b7TdD",
"name": "ANC: 1-3 dropout rate Yearly"
},
"i": "cKd9PKBuHv6",
"minH": 4,
"firstOfType": true,
"width": 20,
"height": 29
}
],
"starred": false
}
```	Update an Item	UID \
不	The payload must be the latest Dashboard object, including all its items with the updated property value.	Remove an Item

To remove an item from a dashboard, remove it from the Dashboard payload and send a PUT request to:¶

 /api/dashboards/ChZ236jPgXs

Defining a dashboard layout { #webapi_dasboard_layout }

You can define and save a layout for each dashboard. The following object is responsible to hold this setting.

{
  "layout": {
    "spacing": {
      "column": 5,
      "row": 5
    },
    "columns": [{
      "index": 0,
      "span": 2
    }, {
      "index": 1,
      "span": 1
    }]
  }
}

The layout definition will be applied for all dashboard items related to the given dashboard, respecting layout attributes like spacing, columns, span and so on. See, below, a brief description of each attribute.

| The manual merge is suitable when there are resolvable conflicts or when not all the data needs to be moved during the merge. For example, if an attribute has different values in both tracked entities , the user can specify whether to keep the original value or move over the duplicate's value. Since the manual merge involves the user explicitly requesting to move data, there are some additional checks: | Parameter name | |---|---| | Two mappings for the Referrals Age category. A program indicator can choose which mapping | Endpoint responses { #webapi_data_items_possible_responses } | | 是的 | This is the root object | | displayColumnOrder | spacing | | 枚举(参见元数据和渲染类型表中的列表) | 目的 | | 列 | Stores specific parameters related to columns (at the moment, index and span) | | Array of objects | 可视化 { #webapi_visualization } | | dataFilters | This API was introduced to unify both charts and reportTables APIs and entirely replace them by the visualizations API. | | GET /api/metadata/proposals?filter=status:eq:ACCEPTED | API的根端点是/ api / visualizations,下表中描述了当前属性和元素的列表。 | | dueDate | 领域 | | lastUpdatedDate | id | | 这种访问级别的限制稍多一些。受保护项目中的数据只有在所有者组织单位属于用户捕获范围的情况下才能被用户访问。只有当所有者组织单位属于用户的捕获范围时,用户才能访问受保护项目内的数据。但是,如果用户用户可以通过打破玻璃获得临时所有权。玻璃](#webapi_tracker_ownership_override)获得临时所有权。用户必须说明为什么要访问手头的数据。他们为什么要访问手头的数据。然后,系统会将理由和访问审核记录在案,并提供 3 个月的临时访问权限。访问审计日志,并为用户提供 3 小时的临时访问权限。请注意,打破玻璃时时,所有者组织单位保持不变,只有打碎玻璃的用户才能获得临时访问权。获得临时访问权。 | 码 | | > Note

The repetition attribute (in rows, columns or filters) indicates the events indexes to be retrieved. Taking the example above (in the previous json payload), it can be read as follows:
1 = First event
2 = Second event
3 = Third event
...
-2 = Third latest event
-1 = Second latest event
0 = Latest event (default) | 名称 |
| The name of the EventVisualiation | type | | The type of the Visualization. The valid types are: COLUMN, STACKED_COLUMN, BAR, STACKED_BAR, LINE, AREA, PIE, RADAR, GAUGE, YEAR_OVER_YEAR_LINE YEAR_OVER_YEAR_COLUMN, SINGLE_VALUE, PIVOT_TABLE. | title | | A custom title. | subtitle | | A custom subtitle. | 描述 | | Defines a custom description for the Visualization. | created | | The date/time of the Visualization creation. | 开始日期 | | The beginning date used during the filtering. | 结束日期 | | The ending date used during the filtering. | sortOrder | | Events resource only. Custom period on scheduledDate. See "custom date periods" section. | user | | An object representing the creator of the Visualization. | 结束日期 | | The ending date used during the filtering. | sortOrder | | The sorting order of this EventVisualiation. Integer value. | user | | An object representing the creator of the Visualization. | publicAccess | | Sets the permissions for public access. | displayDensity | | The display density of the text. | fontSize | | The font size of the text. | relativePeriods | | An object representing the relative periods used in the analytics query. | 传说 | | An object representing the definitions for the legend and legend set, display style (FILL or TEXT) and display strategy (FIXED or BY_DATA_ITEM). | aggregationType | | Determines how the values are aggregated (if applicable). Valid options: SUM, AVERAGE, AVERAGE_SUM_ORG_UNIT, LAST, LAST_AVERAGE_ORG_UNIT, FIRST, FIRST_AVERAGE_ORG_UNIT, COUNT, STDDEV, VARIANCE, MIN, MAX, NONE, CUSTOM or DEFAULT. | regressionType | | A valid regression type: NONE, LINEAR, POLYNOMIAL or LOESS. | targetLineValue | | The chart target line. Accepts a Double type. | targetLineLabel | | The chart target line label. | rangeAxisLabel | | 请求查询参数 { #webapi_analytics_query_parameters } | domainAxisLabel | | The chart horizontal axis (x) label/title. | rangeAxisMaxValue | | The chart axis maximum value. Values outside of the range will not be displayed. | rangeAxisMinValue | | The chart axis minimum value. Values outside of the range will not be displayed. | rangeAxisSteps | | The chart axis minimum value. Values outside of the range will not be displayed. | rangeAxisDecimals | | The number of axis steps between the minimum and maximum values. | rangeAxisDecimals | | The number of decimals for the axes values. | baseLineValue | | A chart baseline value. | digitGroupSeparator | | The digit group separator. Valid values: COMMA, SPACE or NONE. | topLimit | | A chart baseline label. | digitGroupSeparator | | The digit group separator. Valid values: COMMA, SPACE or NONE. | topLimit | | The top limit set for the Pivot table. | measureCriteria | | Describes the criteria applied to this measure. | percentStackedValues | | Uses stacked values or not. More likely to be applied for graphics/charts. Boolean value. | externalAccess | | The program stage associated. | 项目状态 | | 不 | externalAccess | | 项目状态。可以是 "激活"、"已完成 "或 "已取消"。 | userOrganisationUnitGrandChildren | | The event status. It can be ACTIVE, COMPLETED, VISITED, SCHEDULE, OVERDUE, SKIPPED. | reportingParams | | Indicates whether the EventVisualization is available as external read-only. Boolean value. | userOrganisationUnit | | sortOrder | colTotals | | Indicates if the user has an organisation unit. Boolean value. | userOrganisationUnitChildren | | Indicates if the user has a children organisation unit. Boolean value. | userOrganisationUnitGrandChildren | | Indicates if the user has a grand children organisation unit. Boolean value. | rowTotals | | Indicates whether the visualization is using cumulative values. Boolean value. | hideEmptyColumns | | Custom period on incidentDate. See "custom date periods" section. | colTotals | | Displays (or not) the columns totals. Boolean value. | rowSubTotals | | Displays (or not) the row sub-totals. Boolean value. | fixRowHeaders | | 不 | completedOnly | | Indicates whether the EventVisualization is using cumulative values. Boolean value. | hideEmptyRows | | Indicates whether to hide rows with no data values. Boolean value. | showDimensionLabels | | Flag used in analytics requests. If true, only completed events/enrollments will be taken into consideration. Boolean value. | showDimensionLabels | | Hides the title or not. Boolean value. | hideSubtitle | | Hides the subtitle or not. Boolean value. | hideLegend | | Defines a custom description for the EventVisualiation. | showHierarchy |

Displays (or not) the organisation unit hierarchy names. Boolean value.¶

showData

Used by charts to hide or not data/values within the rendered model. Boolean value.

lastUpdatedBy

Object that represents the user that applied the last changes to the Visualization.

lastUpdated

The date/time of the last time the Visualization was changed. favorites

List of user ids who have marked this object as a favorite.

subscribers

The dimensions defined for the rows.

filterDimensions

Set of available object translation, normally filtered by locale.¶

outlierAnalysis

Object responsible to keep settings related to outlier analysis. The internal attribute 'outlierMethod' supports: IQR, STANDARD_Z_SCORE, MODIFIED_Z_SCORE. The 'normalizationMethod' accepts only Y_RESIDUALS_LINEAR for now.

seriesKey

Styling options for and whether or not to display the series key.

传说

Options for and whether or not to apply legend colors to the chart series.

检索可视化¶

To retrieve a list of all existing visualizations, in JSON format, with some basic information (including identifier, name and pagination) you can make a GET request to the URL below. You should see a list of all public/shared visualizations plus your private ones.

GET /api/visualizations.json

如果要检索特定可视化的JSON定义,可以将其各自的标识符添加到URL:

GET /api/visualizations/hQxZGXqnLS9.json

| The manual merge is suitable when there are resolvable conflicts or when not all the data needs to be moved during the merge. For example, if an attribute has different values in both tracked entities , the user can specify whether to keep the original value or move over the duplicate's value. Since the manual merge involves the user explicitly requesting to move data, there are some additional checks: | Parameter name | |---|---| | Two mappings for the Referrals Age category. A program indicator can choose which mapping | Endpoint responses { #webapi_data_items_possible_responses } | | 是的 | json { "interpretations": [ { "id": "Lfr8I2RPU0C" }, { "id": "JuwgdJlJPGb" }, { "id": "WAoU2rSpyZp" } ] } | | displayColumnOrder | 创建,更新和删除可视化 { #webapi_visualization_add_update_remove_visualizations } | | 枚举(参见元数据和渲染类型表中的列表) | json { "columns": [ { "dimension": "J5jldMd8OHv", "items": [ { "name": "CHP", "id": "uYxK4wmcPqA", "displayName": "CHP", "displayShortName": "CHP", "dimensionItemType": "ORGANISATION_UNIT_GROUP" }, { "name": "Hospital", "id": "tDZVQ1WtwpA", "displayName": "Hospital", "displayShortName": "Hospital", "dimensionItemType": "ORGANISATION_UNIT_GROUP" } ] } ], "rows": [ { "dimension": "SooXFOUnciJ", "items": [ { "name": "DOD", "id": "B0bjKC0szQX", "displayName": "DOD", "displayShortName": "DOD", "dimensionItemType": "CATEGORY_OPTION_GROUP" }, { "name": "CDC", "id": "OK2Nr4wdfrZ", "displayName": "CDC", "displayShortName": "CDC", "dimensionItemType": "CATEGORY_OPTION_GROUP" } ] } ], "filters": [ { "dimension": "ou", "items": [ { "name": "Sierra Leone", "id": "ImspTQPwCqd", "displayName": "Sierra Leone", "displayShortName": "Sierra Leone", "dimensionItemType": "ORGANISATION_UNIT" }, { "name": "LEVEL-1", "id": "LEVEL-H1KlN4QIauv", "displayName": "LEVEL-1" } ] } ], "name": "HIV Cases Monthly", "description": "Cases of HIV across the months", "category": "XY1vwCQskjX", "showDimensionLabels": true, "hideEmptyRows": true, "hideEmptyColumns": true, "skipRounding": true, "aggregationType": "SUM", "regressionType": "LINEAR", "type": "PIVOT_TABLE", "numberType": "VALUE", "measureCriteria": "Some criteria", "showHierarchy": true, "completedOnly": true, "displayDensity": "NORMAL", "fontSize": "NORMAL", "digitGroupSeparator": "SPACE", "legendDisplayStyle": "FILL", "legendDisplayStrategy": "FIXED", "hideEmptyRowItems": "BEFORE_FIRST_AFTER_LAST", "fixColumnHeaders": true, "fixRowHeaders": false, "regression": false, "cumulative": true, "sortOrder": 1, "topLimit": 2, "rowTotals": true, "colTotals": true, "hideTitle": true, "hideSubtitle": true, "hideLegend": true, "showData": true, "percentStackedValues": true, "noSpaceBetweenColumns": true, "rowSubTotals": true, "colSubTotals": true, "userOrgUnitType": "TEI_SEARCH", "externalAccess": false, "publicAccess": "--------", "reportingParams": { "reportingPeriod": true, "organisationUnit": true, "parentOrganisationUnit": true, "grandParentOrganisationUnit": true }, "parentGraphMap": { "ImspTQPwCqd": "" }, "access": { "read": true, "update": true, "externalize": true, "delete": false, "write": true, "manage": false }, "optionalAxes": [ { "dimensionalItem": "fbfJHSPpUQD", "axis": 1 }, { "dimensionalItem": "cYeuwXTCPkU", "axis": 2 } ], "relativePeriods": { "thisYear": false, "quartersLastYear": true, "last52Weeks": false, "thisWeek": false, "lastMonth": false, "last14Days": false, "biMonthsThisYear": false, "monthsThisYear": false, "last2SixMonths": false, "yesterday": false, "thisQuarter": false, "last12Months": false, "last5FinancialYears": false, "thisSixMonth": false, "lastQuarter": false, "thisFinancialYear": false, "last4Weeks": false, "last3Months": false, "thisDay": false, "thisMonth": false, "last5Years": false, "last6BiMonths": false, "last4BiWeeks": false, "lastFinancialYear": false, "lastBiWeek": false, "weeksThisYear": false, "last6Months": false, "last3Days": false, "quartersThisYear": false, "monthsLastYear": false, "lastWeek": false, "last7Days": false, "thisBimonth": false, "lastBimonth": false, "lastSixMonth": false, "thisBiWeek": false, "lastYear": false, "last12Weeks": false, "last4Quarters": false }, "user": {}, "yearlySeries": [ "THIS_YEAR" ], "userGroupAccesses": [ { "access": "rwx-----", "userGroupUid": "ZoHNWQajIoe", "displayName": "Bo District M&E officers", "id": "ZoHNWQajIoe" } ], "userAccesses": [ { "access": "--------", "displayName": "John Barnes", "id": "DXyJmlo9rge", "userUid": "DXyJmlo9rge" } ], "legendSet": { "name": "Death rate up", "id": "ham2eIDJ9k6", "legends": [ { "startValue": 1, "endValue": 2, "color": "red", "image": "some-image" }, { "startValue": 2, "endValue": 3, "color": "blue", "image": "other-image" } ] }, "outlierAnalysis": { "enabled": true, "outlierMethod": "IQR", "thresholdFactor": 1.5, "normalizationMethod": "Y_RESIDUALS_LINEAR", "extremeLines": { "enabled": true, "value": 3.5 } }, "legend": { "strategy": "FIXED", "style": "FILL", "set": { "id": "fqs276KXCXi", "displayName": "ANC Coverage" }, "showKey": false }, "seriesKey": { "hidden": true, "label": { "fontStyle": { "textColor": "#cccddd" } } }, "axes": [ { "index": 0, "type": "RANGE", "label": { "fontStyle": { "textColor": "#cccddd" } }, "title": { "text": "Range axis title", "textMode": "CUSTOM", "fontStyle": { "textColor": "#000000" } }, "decimals": 1, "maxValue": 100, "minValue": 20, "steps": 5, "baseLine": { "value": 50, "title": { "text": "My baseline", "fontStyle": { "textColor": "#000000" } } }, "targetLine": { "value": 80, "title": { "text": "My targetline", "fontStyle": { "textColor": "#cccddd" } } } }, { "index": 1, "type": "DOMAIN", "label": { "fontStyle": { "textColor": "#000000" } }, "title": { "text": "Domain axis title", "textMode": "CUSTOM", "fontStyle": { "textColor": "#cccddd" } } } ], "axes": [ { "index": 0, "type": "RANGE", "label": { "fontStyle": { "textColor": "#cccddd" } }, "title": { "text": "Range axis title", "fontStyle": { "textColor": "#000000" } }, "decimals": 1, "maxValue": 100, "minValue": 20, "steps": 5, "baseLine": { "value": 50, "title": { "text": "My baseline", "fontStyle": { "textColor": "#000000" } } }, "targetLine": { "value": 80, "title": { "text": "My targetline", "fontStyle": { "textColor": "#cccddd" } } } }, { "index": 1, "type": "DOMAIN", "label": { "fontStyle": { "textColor": "#000000" } }, "title": { "text": "Domain axis title", "fontStyle": { "textColor": "#cccddd" } } } ] } | | 列 | Stores specific parameters related to columns (at the moment, index and span) | | Array of objects | 可视化 { #webapi_visualization } | | dataFilters | The EventVisualization API is designed to help clients to interact with event charts and reports. The endpoints of this API are used by the Event Visualization application which allows the creation, configuration and management of charts and reports based on the client's definitions. The main idea is to enable clients and users to have a unique and centralized API providing all types of event charts and reports as well as specific parameters and configuration for each type of event visualization. This API was introduced with the expectation to unify both eventCharts and eventReports APIs and entirely replace them in favour of the eventVisualizations API (which means that the usage of eventCharts and eventReports APIs should be avoided). In summary, the following resources/APIs: /api/eventCharts, /api/eventReports are being replaced by /api/eventVisualizations | | GET /api/metadata/proposals?filter=status:eq:ACCEPTED | An EventVisualization object is composed of many attributes (some of them related to charting and others related to reporting), but the most important ones responsible to reflect the core information of the object are: "id", "name", "type", "dataDimensionItems", "columns", "rows" and "filters". The root endpoint of the API is /api/eventVisualizations, and the list of current attributes and elements are described in the table below. | | dueDate | 领域 | | lastUpdatedDate | id | | 这种访问级别的限制稍多一些。受保护项目中的数据只有在所有者组织单位属于用户捕获范围的情况下才能被用户访问。只有当所有者组织单位属于用户的捕获范围时,用户才能访问受保护项目内的数据。但是,如果用户用户可以通过打破玻璃获得临时所有权。玻璃](#webapi_tracker_ownership_override)获得临时所有权。用户必须说明为什么要访问手头的数据。他们为什么要访问手头的数据。然后,系统会将理由和访问审核记录在案,并提供 3 个月的临时访问权限。访问审计日志,并为用户提供 3 小时的临时访问权限。请注意,打破玻璃时时,所有者组织单位保持不变,只有打碎玻璃的用户才能获得临时访问权。获得临时访问权。 | 码 | | > Note

The repetition attribute (in rows, columns or filters) indicates the events indexes to be retrieved. Taking the example above (in the previous json payload), it can be read as follows:
1 = First event
2 = Second event
3 = Third event
...
-2 = Third latest event
-1 = Second latest event
0 = Latest event (default) | 名称 |
| The name of the EventVisualiation | type | | The type of the Visualization. The valid types are: COLUMN, STACKED_COLUMN, BAR, STACKED_BAR, LINE, AREA, PIE, RADAR, GAUGE, YEAR_OVER_YEAR_LINE YEAR_OVER_YEAR_COLUMN, SINGLE_VALUE, PIVOT_TABLE. | title | | A custom title. | subtitle | | Defines a custom description for the Visualization. | created | | Defines a custom description for the EventVisualiation. | created | | Events resource only. Custom period on scheduledDate. See "custom date periods" section. | 开始日期 | | An object representing the creator of the Visualization. | 结束日期 | | The ending date used during the filtering. | sortOrder | | The sorting order of this EventVisualiation. Integer value. | user | | An object representing the creator of the Visualization. | publicAccess | | Sets the permissions for public access. | displayDensity | | The display density of the text. | fontSize | | The font size of the text. | relativePeriods | | An object representing the relative periods used in the analytics query. | 传说 | | An object representing the definitions for the legend and legend set, display style (FILL or TEXT) and display strategy (FIXED or BY_DATA_ITEM). | aggregationType | | Determines how the values are aggregated (if applicable). Valid options: SUM, AVERAGE, AVERAGE_SUM_ORG_UNIT, LAST, LAST_AVERAGE_ORG_UNIT, FIRST, FIRST_AVERAGE_ORG_UNIT, COUNT, STDDEV, VARIANCE, MIN, MAX, NONE, CUSTOM or DEFAULT. | regressionType | | A valid regression type: NONE, LINEAR, POLYNOMIAL or LOESS. | targetLineValue | | The chart target line. Accepts a Double type. | targetLineLabel | | The chart target line label. | rangeAxisLabel | | 请求查询参数 { #webapi_analytics_query_parameters } | domainAxisLabel | | The chart horizontal axis (x) label/title. | rangeAxisMaxValue | | The chart axis maximum value. Values outside of the range will not be displayed. | rangeAxisMinValue | | The chart axis minimum value. Values outside of the range will not be displayed. | rangeAxisSteps | | The number of axis steps between the minimum and maximum values. | rangeAxisDecimals | | The number of decimals for the axes values. | baseLineValue | | A chart baseline value. | baseLineLabel | | A chart baseline label. | digitGroupSeparator | | The digit group separator. Valid values: COMMA, SPACE or NONE. | topLimit | | The top limit set for the Pivot table. | measureCriteria | | Describes the criteria applied to this measure. | percentStackedValues | | Uses stacked values or not. More likely to be applied for graphics/charts. Boolean value. | noSpaceBetweenColumns | | 不 | externalAccess | | Indicates whether the EventVisualization is available as external read-only. Boolean value. | userOrganisationUnit | | Indicates if the user has an organisation unit. Boolean value. | userOrganisationUnitChildren | | Indicates if the user has a children organisation unit. Boolean value. | userOrganisationUnitGrandChildren | | Indicates if the user has a grand children organisation unit. Boolean value. | rowTotals | | Custom period on incidentDate. See "custom date periods" section. | colTotals | | Displays (or not) the columns totals. Boolean value. | rowSubTotals | | Displays (or not) the row sub-totals. Boolean value. | colSubTotals | | 不 | cumulativeValues | | Indicates whether the EventVisualization is using cumulative values. Boolean value. | hideEmptyRows | | Indicates whether to hide rows with no data values. Boolean value. | completedOnly | | Flag used in analytics requests. If true, only completed events/enrollments will be taken into consideration. Boolean value. | showDimensionLabels | | { "periodFrom": -15, "periodTo": 15} | hideTitle | | See an example payload below. | hideSubtitle | | 结束日期 | showHierarchy | | "displayOrderColumns": ["enrollmentDate", "program"] | showData | | Used by charts to hide or not data/values within the rendered model. Boolean value. | lastUpdatedBy | | Object that represents the user that applied the last changes to the EventVisualization. | lastUpdated | | The date/time of the last time the EventVisualization was changed. | favorites | | List of user ids who have marked this object as a favorite. | subscribers | | 不 | translations | | 不 | 项目 | | The program associated. | 项目阶段 | | The program stage associated. | 项目状态 | | 项目状态。可以是 "激活"、"已完成 "或 "已取消"。 | eventStatus | | The event status. It can be ACTIVE, COMPLETED, VISITED, SCHEDULE, OVERDUE, SKIPPED. | dataType |

The event data type. It can be AGGREGATED_VALUES or EVENTS.¶

columnDimensions

The dimensions defined for the columns.

rowDimensions

The dimensions defined for the rows.

filterDimensions

The dimensions defined for the filters.¶

outputType

Indicates output type of the EventVisualization. It can be EVENT, ENROLLMENT or TRACKED_ENTITY_INSTANCE.

collapseDataDimensions

<attribute id>

hideNaData

Indicates whether to hide N/A data. Boolean value.

hideEmptyColumns

Indicates whether to hide columns with no data values. Boolean value.¶

fixColumnHeaders

Fixes (or not) the pivot table column headers. Boolean value.

fixRowHeaders¶

Fixes (or not) the pivot table row headers. Boolean value.

Retrieving event visualizations { #webapi_event_visualization_retrieving_event_visualizations }

To retrieve a list of all existing event visualizations, in JSON format, with some basic information (including identifier, name and pagination) you can make a GET request to the URL below. You should see a list of all public/shared event visualizations plus your private ones. GET /api/eventVisualizations.json If you want to retrieve the JSON definition of a specific EventVisualization you can add its respective identifier to the URL: GET /api/eventVisualizations/hQxZGXqnLS9.json The following representation is an example of a response in JSON format (for brevity, certain information has been removed). For the complete schema, please use GET /api/schemas/eventVisualization.

{
    "lastUpdated": "2021-11-25T17:18:03.834",
    "href": "http://localhost:8080/dhis/api/eventVisualizations/EZ5jbRTxRGh",
    "id": "EZ5jbRTxRGh",
    "created": "2021-11-25T17:18:03.834",
    "name": "Inpatient: Mode of discharge by facility type this year",
    "publicAccess": "rw------",
    "userOrganisationUnitChildren": false,
    "type": "STACKED_COLUMN",
    "subscribed": false,
    "userOrganisationUnit": false,
    "rowSubTotals": false,
    "cumulativeValues": false,
    "showDimensionLabels": false,
    "sortOrder": 0,
    "favorite": false,
    "topLimit": 0,
    "collapseDataDimensions": false,
    "userOrganisationUnitGrandChildren": false,
    "displayName": "Inpatient: Mode of discharge by facility type this year",
    "percentStackedValues": false,
    "noSpaceBetweenColumns": false,
    "showHierarchy": false,
    "hideTitle": false,
    "showData": true,
    "hideEmptyRows": false,
    "hideNaData": false,
    "regressionType": "NONE",
    "completedOnly": false,
    "colTotals": false,
    "sharing": {
      "owner": "GOLswS44mh8",
      "external": false,
      "users": {},
      "userGroups": {},
      "public": "rw------"
    },
    "programStatus": "CANCELLED",
    "hideEmptyRowItems": "NONE",
    "hideSubtitle": false,
    "outputType": "EVENT",
    "hideLegend": false,
    "externalAccess": false,
    "colSubTotals": false,
    "rowTotals": false,
    "digitGroupSeparator": "SPACE",
    "program": {
      "id": "IpHINAT79UW"
    },
    "access": {
      "read": true,
      "update": true,
      "externalize": true,
      "delete": true,
      "write": true,
      "manage": true
    },
    "lastUpdatedBy": {
      "displayName": "John Traore",
      "name": "John Traore",
      "id": "xE7jOejl9FI",
      "username": "admin"
    },
    "relativePeriods": {
      "thisYear": false,
      ...
    },
    "programStage": {
      "id": "A03MvHHogjR"
    },
    "createdBy": {
      "displayName": "Tom Wakiki",
      "name": "Tom Wakiki",
      "id": "GOLswS44mh8",
      "username": "system"
    },
    "user": {
      "displayName": "Tom Wakiki",
      "name": "Tom Wakiki",
      "id": "GOLswS44mh8",
      "username": "system"
    },
    "attributeDimensions": [],
    "translations": [],
    "legend": {
      "set": {
        "id": "gFJUXah1uRH"
      },
      "showKey": false,
      "style": "FILL",
      "strategy": "FIXED"
    },
    "filterDimensions": [
      "ou",
      "H6uSAMO5WLD"
    ],
    "interpretations": [],
    "userGroupAccesses": [],
    "subscribers": [],
    "columns": [
      {
        "id": "X8zyunlgUfM"
      }
    ]
    "periods": [],
    "categoryDimensions": [],
    "rowDimensions": [
      "pe"
    ],
    "itemOrganisationUnitGroups": [],
    "programIndicatorDimensions": [],
    "attributeValues": [],
    "columnDimensions": [
      "X8zyunlgUfM"
    ],
    "userAccesses": [],
    "favorites": [],
    "dataDimensionItems": [],
    "categoryOptionGroupSetDimensions": [],
    "organisationUnitGroupSetDimensions": [],
    "organisationUnitLevels": [],
    "organisationUnits": [
      {
        "id": "ImspTQPwCqd"
      }
    ],
    "filters": [
      {
        "id": "ou"
      },
      {
        "id": "H6uSAMO5WLD"
      }
    ],
    "rows": [
      {
        "id": "pe"
      }
    ]
}

A more tailored response can be obtained by specifying, in the URL, the fields you want to extract. Ie.: GET /api/eventVisualizations/hQxZGXqnLS9.json?fields=interpretations will return

| The manual merge is suitable when there are resolvable conflicts or when not all the data needs to be moved during the merge. For example, if an attribute has different values in both tracked entities , the user can specify whether to keep the original value or move over the duplicate's value. Since the manual merge involves the user explicitly requesting to move data, there are some additional checks: | Parameter name | |---|---| | Two mappings for the Referrals Age category. A program indicator can choose which mapping | These operations follow the standard REST semantics. A new EventVisualization can be created through a POST request to the /api/eventVisualizations resource with a valid JSON payload. An example of payload could be: | | GET /api/metadata/proposals?filter=status:eq:ACCEPTED | For multi-program support, the root program should not be specified. This will turn the eventVisualization into a multi-program. Consequently, we have to specify the program and programStage (when applicable) for each dimension in rows, columns, and filters. | | 枚举(参见元数据和渲染类型表中的列表) | json "program": null, "columns": [ { "dimension": "ou", "items": [ { "id": "O6uvpzGd5pu" } ], "program": { "id": "IpHINAT79UW" } }, { "dimensionType": "CATEGORY_OPTION_GROUP_SET", "items": [ { "id": "JLGV7lRQRAg" }, { "id": "p916ZCVGNyq" } ], "dimension": "C31vHZqu0qU", "program": { "id": "kla3mAPgvCH" }, "programStage": { "id": "aNLq9ZYoy9W" } } ] | | > Note

The repetition attribute (in rows, columns or filters) indicates the events indexes to be retrieved. Taking the example above (in the previous json payload), it can be read as follows:
1 = First event
2 = Second event
3 = Third event
...
-2 = Third latest event
-1 = Second latest event
0 = Latest event (default) | To update a specific EventVisualization, you can send a `PUT` request to the same `/api/eventVisualizations` resource with a similar payload `PLUS` the respective EventVisualization's identifier, ie.:
PUT /api/eventVisualizations/hQxZGXqnLS9
Finally, to delete an existing EventVisualization, you can make a DELETE request specifying the identifier of the EventVisualization to be removed, as shown: DELETE /api/eventVisualizations/hQxZGXqnLS9 | | 释义 { #webapi_interpretations } | For resources related to data analysis in DHIS2, such as visualizations, maps, event reports, event charts and even visualizations you can write and share data interpretations. An interpretation can be a comment, question, observation or interpretation about a data report or visualization. | | / api /解释 | 阅读口译 { #webapi_reading_interpretations } | | 为了阅读解释,我们将与 /api/interpretations 资源。使用字段的典型 GET 请求过滤可以是这样的: | GET /api/interpretations?fields=*,comments[id,text,user,mentions] | | JSON 响应格式的输出可能如下所示(附加为简洁起见省略了字段): | json { "interpretations": [ { "id": "XSHiFlHAhhh", "created": "2013-05-30T10:24:06.181+0000", "text": "Data looks suspicious, could be a data entry mistake.", "type": "MAP", "likes": 2, "user": { "id": "uk7diLujYif" }, "reportTable": { "id": "LcSxnfeBxyi" }, "visualization": { "id": "LcSxnfeBxyi" } }, { "id": "kr4AnZmYL43", "created": "2013-05-29T14:47:13.081+0000", "text": "Delivery rates in Bo looks high.", "type": "VISUALIZATION", "likes": 3, "user": { "id": "uk7diLujYif" }, "visualization": { "id": "HDEDqV3yv3H" }, "mentions": [ { "created": "2018-06-25T10:25:54.498", "username": "boateng" } ], "comments": [ { "id": "iB4Etq8yTE6", "text": "This report indicates a surge.", "user": { "id": "B4XIfwOcGyI" } }, { "id": "iB4Etq8yTE6", "text": "Likely caused by heavy rainfall.", "user": { "id": "B4XIfwOcGyI" } }, { "id": "SIjkdENan8p", "text": "Have a look at this @boateng.", "user": { "id": "xE7jOejl9FI" }, "mentions": [ { "created": "2018-06-25T10:03:52.316", "username": "boateng" } ] } ] } ] } | | Table: Interpretation fields | 领域 | | 描述 | id | | The interpretation identifier. | created | | The time of when the interpretation was created. | type |

The type of analytical object being interpreted. Valid options: VISUALIZATION, MAP, EVENT_REPORT, EVENT_CHART, EVENT_VISUALIZATION, DATASET_REPORT.

user

Association to the user who created the interpretation.

visualization

Association to the visualization if type is VISUALIZATION

eventVisualization

Association to the event visualization if type is EVENT_VISUALIZATION

map

Association to the map if type is MAP.¶

eventReport

Association to the event report is type is EVENT_REPORT.

eventChart

Association to the event chart if type is EVENT_CHART.

dataSet

Association to the data set if type is DATASET_REPORT.

comments

Array of comments for the interpretation. The text field holds the actual comment.

mentions

Array of mentions for the interpretation. A list of users identifiers.¶

对于所有分析对象,您可以将 /data 附加到 URL 以检索与资源关联的数据(相对于元数据)。作为一个例子,通过跟随地图链接并附加 /data 可以通过检索主题地图的 PNG(图像)表示以下网址:

https://play.dhis2.org/demo/api/maps/bhmHJ4ZCdCd/data

对于所有分析对象,您可以通过*提及*进行过滤。检索所有您提到的用户的解释/评论三个选项。您可以通过解释提及(提及在解释中描述):

GET /api/interpretations?fields=*,comments[*]&filter=mentions.username:in:[boateng]

您可以通过解释评论提及(在任何评论):

GET / api / interpretations?fields = ,评论[]¶

  &filter = comments.mentions.username:in:[boateng]

您可以按包含提及的解释进行过滤在解释或任何评论中(或结点):

GET /api/interpretations?fields=*,comments[*]&filter=mentions:in:[boateng]

写作解释 { #webapi_writing_interpretations }

在编写解释时,您将提供解释文本作为使用内容类型为“text/plain”的 POST 请求的请求正文。 URL 模式如下所示,其中 {object-type} 指的是被解释的对象的类型,{object-id} 指的是被解释对象的标识符。

/ api / interpretations / {object-type} /¶

Valid options for object type are visualization, map, eventReport, eventChart, eventVisualization and dataSetReport.

下面列出了一些有效的解释示例。

Note

The eventCharts and eventReports APIs are deprecated. We recommend using the eventVisualizations API instead.

/api/interpretations/visualization/hQxZGXqnLS9
/api/interpretations/map/FwLHSMCejFu
/api/interpretations/eventReport/xJmPLGP3Cde
/api/interpretations/eventChart/nEzXB2M9YBz
/api/interpretations/eventVisualization/nEzXB2M9YBz
/api/interpretations/dataSetReport/tL7eCjmDIgM

As an example, we will start by writing an interpretation for the visualization with identifier EbRN2VIbPdV. To write visualization interpretations we will interact with the /api/interpretations/visualization/{visualizationId} resource. The interpretation will be the request body. Based on this we can put together the following request using cURL:

```bash¶

curl -d "This visualization shows a significant ANC 1-3 dropout" -X POST "https://play.dhis2.org/demo/api/interpretations/visualization/EbRN2VIbPdV" -H "Content-Type:text/plain" -u admin:district

请注意,响应提供了一个带有值的 Location 标头
指示创建的解释的位置。这很有用
从客户的角度来看,当您想向
解释。

更新和删除解释 { #webapi_updating_removing_interpretations } 

要更新现有解释,您可以使用 PUT 请求,其中
解释文本是使用以下 URL 模式的请求正文,
其中 {id} 指的是解释标识符:

    / api / interpretations / {id}

基于此,我们可以使用curl来更新解释:

```bash
curl -d "This visualization shows a high dropout" -X PUT
  "https://play.dhis2.org/demo/api/interpretations/visualization/EV08iI1cJRA" -H "Content-Type:text/plain" -u admin:district

您可以使用与上面相同的 URL 模式使用 DELETE 请求来删除解释。

创建解释注释 { #webapi_creating_interpretation_comments }

在为解释撰写评论时,您将提供评论¶

text 作为使用内容类型的 POST 请求的请求正文 “文本/纯文本”。 URL 模式如下所示,其中 {interpretation-id} 指的是解释标识符。

/ api / interpretations / {interpretation-id} /评论

其次,我们将对我们在上面的例子。通过查看解释响应,您将看到返回一个 Location 标头。这个标题告诉我们的 URL 新创建的解释,从中我们可以阅读它的标识符。此标识符是随机生成的,因此您必须用您自己的命令替换下面命令中的那个。写评论我们可以与/api/interpretations/{id}/comments进行交互像这样的资源:

curl -d "An intervention is needed" -X POST
  "https://play.dhis2.org/demo/api/interpretations/j8sjHLkK8uY/comments"
  -H "Content-Type:text/plain" -u admin:district

更新和删除解释注释 { #webapi_updating_removing_interpretation_comments }

要更新解释注释,您可以使用 PUT 请求,其中评论文本是使用以下 URL 模式的请求正文:

/ api / interpretations / {interpretation-id} / comments / {comment-id}

基于此,我们可以使用curl来更新注释:

curl "https://play.dhis2.org/demo/api/interpretations/j8sjHLkK8uY/comments/idAzzhVWvh2"
  -d "I agree with that." -X PUT -H "Content-Type:text/plain" -u admin:district

您可以使用与上面相同的 URL 模式,使用 DELETE 请求到删除解释注释。

喜欢的解释 { #webapi_liking_interpretations }

要喜欢一个解释,你可以使用一个空的 POST 请求到 *喜欢*资源:

POST / api / interpretations / {id} / like

将为当前经过身份验证的用户添加一个赞。一个用户可以只喜欢解释一次。
要删除解释的赞,您可以使用 DELETE 请求与类似操作相同的资源。可以通过查看解释的类似状态来查看常规 Web API 表示: GET /api/interpretations/{id}

在 likes 字段中可以找到喜欢的信息,它代表喜欢的数量,以及 likedBy 数组,它枚举了喜欢的用户喜欢这个解释。 ```json { "id": "XSHiFlHAhhh", "text": "Data looks suspicious, could be a data entry mistake.", "type": "VISUALIZATION", "likes": 2, "likedBy": [ { "id": "k7Hg12fJ2f1" }, { "id": "gYhf26fFkjFS" } ] }

### SQL视图 { #webapi_sql_views } 

SQL 视图资源允许您创建和检索结果集
SQL 视图。 SQL 视图可以直接针对
数据库并通过 Web API 资源呈现结果集。

    / api / sqlViews

SQL 视图对于创建可能更容易的数据视图很有用
用SQL构造比较结合Web的多个对象
应用项目接口。举个例子,假设我们被要求提供一个视图
所有组织单位及其名称、父名称、组织单位
级别和名称,以及数据库中列出的坐标。风景
可能看起来像这样:

```sql
select ou.name as orgunit, par.name as parent, ou.coordinates, ous.level, oul.name 
from organisationunit ou
inner join _orgunitstructure ous on ou.organisationunitid = ous.organisationunitid
inner join organisationunit par on ou.parentid = par.organisationunitid
inner join orgunitlevel oul on ous.level = oul.level
where ou.coordinates is not null
order by oul.level, par.name, ou.name;

我们将使用 curl 首先在 DHIS2 服务器上执行视图。这¶

本质上是一个物化过程,并确保我们拥有检索时可通过 SQL 视图获得的最新数据从服务器。您可以先从 SQL 视图中查找 api/sqlViews 资源,然后使用以下命令进行 POST:

curl "https://play.dhis2.org/demo/api/sqlViews/dI68mLkP1wN/execute" -X POST -u admin:district

The next step in the process is the retrieval of the data. The endpoint is available at:

/api/sqlViews/{id}/data(.csv)

The id path represents the SQL view identifier. The path extensions refers to the format of the data download. Append either data for JSON data or data.csv for comma separated values. Support response formats are json, xml, csv, xls, html and html+css.

As an example, the following command would retrieve CSV data for the SQL view defined above.

curl "https://play.dhis2.org/demo/api/sqlViews/dI68mLkP1wN/data.csv" -u admin:district

SQL视图有三种类型:

SQL 视图: 标准 SQL 视图。

*物化的SQL视图:*物化的SQL视图,意思是

写入磁盘。需要更新以反映变化

底层表。支持过滤结果集的标准。

SQL 查询: 普通 SQL 查询。支持内联变量	自定义查询。
标准 { #webapi_sql_view_criteria }	您可以通过以下方式对结果集中的列进行简单过滤
使用列名将 criteria 查询参数附加到 URL
并过滤由列分隔的值作为参数值,在
以下格式:
/ api / sqlViews / {id} / data?criteria = col1:value1&criteria = col2:value2	As an example, to filter the SQL view result set above to only return
organisation units at level 4 you can use the following URL:

https://play.dhis2.org/demo/api/sqlViews/dI68mLkP1wN/data.csv?criteria=level:4

变数 { #webapi_sql_view_variables }

SQL 视图支持变量替换。变量替换只是可用于 query 类型的 SQL 视图,这意味着 SQL 视图不是在数据库中创建,但只是作为常规 SQL 查询执行。变量可以直接插入到 SQL 查询中,并且必须在这种格式:

$¶

例如,检索给定的所有数据元素的 SQL 查询通过变量定义值类型的值类型可以看像这样:

从dataelement中选择*,其中valuetype ='$ {valueType}';

然后可以在请求时将这些变量作为 URL 的一部分提供通过 sqlViews Web API 资源。可以提供变量以下格式:

/ api / sqlViews / {id} / data?var = key1:value1&var = key2:value2

与上面的示例相对应的示例查询如下所示:

/api/sqlViews/dI68mLkP1wN/data.json?var=valueType:int

valueType 变量将替换为 int 值,并且查询将返回具有 int 值类型的数据元素。

变量参数必须仅包含字母数字字符。这¶

变量必须包含字母数字、破折号、下划线和空格仅字符。

query 类型的 SQL 视图还支持两个系统定义的变量,这些变量允许查询访问有关执行视图的用户的信息:

变量

手段

${_current_user_id}

用户的数据库ID

${_current_username}

用户的用户名

这些变量的值不能作为URL的一部分提供。它们始终充满有关用户的信息。

例如,以下 query 类型的 SQL 视图显示分配给用户的所有组织单位:¶

select ou.path, ou.name
from organisationunit ou_user
join organisationunit ou on ou.path like ou_user.path || '%'
join usermembership um on um.organisationunitid = ou_user.organisationunitid
where um.userinfoid = ${_current_user_id}
order by ou.path;

找到结果（状态代码 200）{ #results-found-status-code-200 }¶

The SQL view API supports data filtering, equal to the metadata object_filter. For a complete list of filter operators you can look at the documentation for metadata object_filter.

未找到结果（状态代码 200）{ #results-not-found-status-code-200 }¶

/api/sqlViews/w3UxFykyHFy/data.json?filter=orgunit_level:eq:2&filter=orgunit_name:ilike:bo

无效查询（状态代码 409）{ #invalid-query-status-code-409 }¶

/api/sqlViews/w3UxFykyHFy/data.json?filter=orgunit_level:in:[2,4]

And last, an example to return all org units that does not start with "Bo":¶

/api/sqlViews/w3UxFykyHFy/data.json?filter=orgunit_name:!like:Bo

数据项 { #webapi_data_items }

This endpoint allows the user to query data related to a few different dimensional items. These items are: INDICATOR, DATA_ELEMENT, DATA_SET, PROGRAM_INDICATOR, PROGRAM_DATA_ELEMENT, PROGRAM_ATTRIBUTE, OPTION_SET. The endpoint supports only GET requests and, as other endpoints, can return responses in JSON or XML format.

该URL是/ api / dataItems,并且可以想象,它能够在同一GET请求中通过同一端点检索不同的对象。因此,某些可用的可查询属性将根据要查询的维项目而有所不同。

为了理解上面的陈述,让我们看一下以下请求示例:¶

1)GET /api/dataItems?filter=dimensionItemType:eq:DATA_ELEMENT&filter=valueType:eq:TEXT 在这个例子中,项目类型DATA_ELEMENT 有一个valueType 属性,可以在查询中使用。

2) GET /api/dataItems?pageSize=50&order=displayName:asc&filter=dimensionItemType:eq:PROGRAM_INDICATOR&filter=displayName:ilike:someName&filter=programId:eq:WSGAb5XwJ3Y

| The manual merge is suitable when there are resolvable conflicts or when not all the data needs to be moved during the merge. For example, if an attribute has different values in both tracked entities , the user can specify whether to keep the original value or move over the duplicate's value. Since the manual merge involves the user explicitly requesting to move data, there are some additional checks: | Parameter name | |---|---| | Two mappings for the Referrals Age category. A program indicator can choose which mapping | Endpoint responses { #webapi_data_items_possible_responses } | | 是的 | Results found (status code 200) | | displayColumnOrder | Results not found (status code 200) | | 属性是描述被跟踪实体的值。属性可以通过通过被跟踪实体类型或项目关联。这意味着属性既可以是被追踪实体的一部分,也可以是注册的一部分。跟踪实体和注册的一部分。重要的是,一个属性只能有一个值,即使一个一个属性只能有一个值,即使一个被跟踪实体有多个注册表来定义该属性。这是因为实体最终拥有属性值。 | Invalid query (status code 409) | | Get translations | 分页 { #webapi_data_items_pagination } | | This endpoint also supports pagination as a default option. If needed, you can disable pagination by adding paging=false to the GET request, i.e.: /api/dataItems?filter=dimensionItemType:in:[INDICATOR]&paging=false. | 这是启用分页时的有效负载示例。请记住,分页是默认选项,不需要显式设置。 | | json { "pager": { "page": 1, "pageCount": 20, "total": 969, "pageSize": 50 }, "dataItems": [...] } | > Note

For elements where there is an associated Program, the program name should also be returned as part of the element name (as a prefix). The only exception is Program Indicators. We will not prefix the element name in this case, in order to keep the same behavior as existing endpoints.

The /dataItems endpoint will bring only data items that are defined as aggregatable type. The current list of valid aggregatable types is: TEXT, LONG_TEXT, LETTER, BOOLEAN, TRUE_ONLY, NUMBER, UNIT_INTERVAL, PERCENTAGE, INTEGER, INTEGER_POSITIVE, INTEGER_NEGATIVE, INTEGER_ZERO_OR_POSITIVE, COORDINATE.

Even though the response returns several different attributes, the filtering can only be applied to specific ones: displayName, name, valueType, id, dimensionItemType, programId.

The order will be considered invalid if it is set on top of name (ie.: order=name:asc) and a filter is set to displayName (ie.: filter=displayName:ilike:aName), and vice-versa. | | 名称 | 现在,我们已经了解了此端点的主要功能和用法,让我们看一下响应中返回的属性列表。 | | Table: Data items attributes | 领域 | | 描述 | id |

The unique identifier.¶

码

A custom code to identify the dimensional item.

名称	Parameter name	displayName	The display name defined.
shortName	DHIS2 has several resources for data analysis. These resources include
maps, visualizations, eventVisualizations, reports and documents. By visiting these resources you will retrieve information about the resource. For instance, by navigating to `/api/visualizations/R0DVGvXDUNP` the response will contain the name, last date of modification and so on for the chart. To retrieve the analytical representation, for instance, a PNG representation of the visualization, you can append /data to all these resources. For instance, by visiting `/api/visualizations/R0DVGvXDUNP/data` the system will return a PNG image of the visualization.	displayShortName	The display short name defined.
dimensionItemType	The dimension type. Possible types: INDICATOR, DATA_ELEMENT, REPORTING_RATE, PROGRAM_INDICATOR, PROGRAM_DATA_ELEMENT, PROGRAM_ATTRIBUTE.	valueType	The display short name defined.
simplifiedValueType	The genereal representation of a value type. Valid values: NUMBER, BOOLEAN, DATE, FILE_RESOURCE, COORDINATE, TEXT	项目Id	相关的项目 ID。
查看分析性资源表示 { #webapi_viewing_analytical_resource_representations }	DHIS2 has several resources for data analysis. These resources include
maps, visualizations, eventVisualizations, reports and documents. By visiting these resources you will retrieve information about the resource. For instance, by navigating to `/api/visualizations/R0DVGvXDUNP` the response will contain the name, last date of modification and so on for the chart. To retrieve the analytical representation, for instance, a PNG representation of the visualization, you can append /data to all these resources. For instance, by visiting `/api/visualizations/R0DVGvXDUNP/data` the system will return a PNG image of the visualization.	Table: Analytical resources	Resource
The display short name defined.
Data URL	Resource representations	eventCharts	活动图
/api/eventCharts/<identifier>/data	png	maps	地图

/api/maps/<identifier>/data

png

| eventCreatedPeriod | json { "object": { "publicAccess": "rw------", "externalAccess": false, "user": {}, "userAccesses": [], "userGroupAccesses": [ { "id": "hj0nnsVsPLU", "access": "rw------" }, { "id": "qMjBflJMOfB", "access": "r-------" } ] } } | Parameter name | |---|---|---| | json | jsonp | html | xml | pdf | xls | csv | Event chart view | 活动图 |

/api/eventVisualizations/<identifier>/data

eventCreatedPeriod	Parameter name
reports	标准报告
/api/reports/<identifier>/data	pdf \| xls \| html

documents

资源资源