=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml 2014-06-11 06:44:51 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-06-14 18:06:52 +0000
@@ -4595,9 +4595,12 @@
query
Query string. Attribute query parameter can be used to define which attributes to
- include in the response. If no attributes but a program is defined, the attributes
- from the program will be used. If no program is defined, all attributes will be
- used.
+ include in the response. If no attributes but a program is defined, the attributes
+ from the program will be used. If no program is defined, all attributes will be
+ used. There are two formats. The first is a plan query string. The second is on the
+ format <operator>:<query>. Operators can be EQ | LIKE. EQ implies exact
+ matches on words, LIKE implies partial matches on words. The query will be split on
+ space, where each word will form a logical AND query.
attribute
@@ -4747,10 +4750,13 @@
A query for all instances associated with a specific organisation unit can look like
this:
api/trackedEntityInstances.json?ou=DiszpKrYNg8
- A query on all attributes for a specific value and organisation unit:
+ A query on all attributes for a specific value and organisation unit, using an exact word
+ match:
api/trackedEntityInstances.json?query=scott&ou=DiszpKrYNg8
+ A query on all attributes for a specif value, using a partial word match:
+ api/trackedEntityInstances.json?query=LIKE:scott&ou=DiszpKrYNg8
You can query on multiple words separated by the the URL character for space which is
- %20:
+ %20, will use a logical AND query for each word:
api/trackedEntityInstances.json?query=isabel%20may&ou=DiszpKrYNg8
A query where the attributes to include in th response are specified looks like
this: