=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml 2014-06-29 20:34:06 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-06-29 21:26:34 +0000
@@ -382,7 +382,8 @@
operator is the comparison operator you want to perform
and value is the value to check against (not all operators
require value). Please see the schema section to discover
- which properties are available.
+ which properties are available. Recursive filtering, ie. filtering on associated objects or
+ collection of objects, are supported as well.
Available Operators
@@ -451,13 +452,15 @@
- Different operators will be applied as and, and equal
- operators will be applied as or. The filtering mechanism
- allows for recursion. See below for an example:
- Example 1: Get dataElements with ID1 and
+ Different operators will be applied as logical and query,
+ and equal operators will be applied as logical or query. The
+ filtering mechanism allows for recursion. See below for an example:
+ Example 1: Get data elements with id property ID1 or
ID2:/api/dataElements?filter=id:eq:ID1&filter=id:eq:ID2
- Example 2: Get all dataElements which has the dataSet
+ Example 2: Get all data elements which has the dataSet
with id ID1:/api/dataElements?filter=dataSets.id:eq:ID1
+ Example 3: Get all data elements with aggregation operator "sum" and value type
+ "int":/api/dataElements.json?filter=aggregationOperator:eq:sum&type:eq:int
Meta-data field inclusion / exclusion
@@ -500,7 +503,7 @@
<field-name>
- Include property with name, if it exists
+ Include property with name, if it exists.
<object>[<field-name>, ...]
@@ -560,9 +563,10 @@
Examples:
Include all fields on on dataSets except
organisationUnits:/api/dataSets?fields=:all,!organisationUnits
- For a dataSet with ID abc123 give me only the
- organisationUnits collection, but exclude the id from the orgUnit
- collection:/api/dataSets/abc123?fields=organisationUnits[:all,!id]
+ Include only id, name and the collection of organisation units from a data set, but
+ exclude the id from organisation
+ units:/api/dataSets/BfMAe6Itzgt?fields=id,name,organisationUnits[:all,!id]
+ Include only
Meta-data create, read, update, delete