dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #29998
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 1064: Event analytics docs
------------------------------------------------------------
revno: 1064
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Sat 2014-05-10 13:22:22 +0200
message:
Event analytics docs
modified:
src/docbkx/en/dhis2_user_man_web_api.xml
--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs
Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription
=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml 2014-05-06 11:16:52 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-05-10 11:22:22 +0000
@@ -1420,7 +1420,7 @@
<row>
<entry>mayAccept</entry>
<entry>Whether the current user may accept this data selection.</entry>
- </row>
+ </row>
<row>
<entry>mayUnaccept</entry>
<entry>Whether the current user may unaccept this data selection.</entry>
@@ -1485,22 +1485,22 @@
</row>
</tbody>
</tgroup>
- </table>
- <para>Note that when querying for the status of data approval, you may specify any combination of the query parameters.
- The combination you specify does not need to describe the place where data is to be approved at one of the approval levels.
- For example:</para>
- <itemizedlist>
- <listitem>
- The organisation unit might not be at an approval level. The approval status is determined by
- whether data is approved at an approval level for an ancestor of the organisation unit.
- </listitem>
- <listitem>
- You may specify individual attribute category options. The approval status is determined by whether
- data is approved for an attribute category option combination that includes one or more of these options.
- </listitem>
- <listitem>
- You may specify a time period that is longer than the period for the data set at which the data is entered and approvede.
- The approval status is determined by whether the data is approved for all the data set periods within the period you specify.
+ </table>
+ <para>Note that when querying for the status of data approval, you may specify any combination of the query parameters.
+ The combination you specify does not need to describe the place where data is to be approved at one of the approval levels.
+ For example:</para>
+ <itemizedlist>
+ <listitem>
+ The organisation unit might not be at an approval level. The approval status is determined by
+ whether data is approved at an approval level for an ancestor of the organisation unit.
+ </listitem>
+ <listitem>
+ You may specify individual attribute category options. The approval status is determined by whether
+ data is approved for an attribute category option combination that includes one or more of these options.
+ </listitem>
+ <listitem>
+ You may specify a time period that is longer than the period for the data set at which the data is entered and approvede.
+ The approval status is determined by whether the data is approved for all the data set periods within the period you specify.
</listitem>
</itemizedlist>
<para>To approve data you can issue a <emphasis role="italic">POST</emphasis> request to the
@@ -1546,22 +1546,22 @@
</row>
</tbody>
</tgroup>
- </table>
- <para>Note that, unlike querying the data approval status, you must specify parameters that correspond to a selection of data that could be approved.
+ </table>
+ <para>Note that, unlike querying the data approval status, you must specify parameters that correspond to a selection of data that could be approved.
In particular, all of the following must be true:</para>
- <itemizedlist>
- <listitem>
- The organisation unit's level must be specified by an approval level.
- </listitem>
- <listitem>
- The category option group (if specified) must be a member of an approval level's category option group set (if specified)
- for an approval level with the same organisation unit level.
- </listitem>
- <listitem>
- The time period specified must match the period type of the data set.
- </listitem>
- <listitem>
- The data set must specify that data can be approved for this data set.
+ <itemizedlist>
+ <listitem>
+ The organisation unit's level must be specified by an approval level.
+ </listitem>
+ <listitem>
+ The category option group (if specified) must be a member of an approval level's category option group set (if specified)
+ for an approval level with the same organisation unit level.
+ </listitem>
+ <listitem>
+ The time period specified must match the period type of the data set.
+ </listitem>
+ <listitem>
+ The data set must specify that data can be approved for this data set.
</listitem>
</itemizedlist>
</section>
@@ -3600,18 +3600,25 @@
</thead>
<tbody>
<row>
- <entry>limit</entry>
- <entry>No</entry>
- <entry>The maximum number of records to return. Cannot be larger than 10 000.</entry>
- <entry>Numeric positive value</entry>
- </row>
- <row>
<entry>sortOrder</entry>
<entry>No</entry>
<entry>Sort the records on the value column in ascending or descending order.</entry>
<entry>ASC | DESC</entry>
</row>
<row>
+ <entry>limit</entry>
+ <entry>No</entry>
+ <entry>The maximum number of records to return. Cannot be larger than 10 000.</entry>
+ <entry>Numeric positive value</entry>
+ </row>
+ <row>
+ <entry>uniqueInstances</entry>
+ <entry>No</entry>
+ <entry>Returns number of distinct tracked entity instances in the events, as opposed
+ to number of events. Applies to programs with registration only.</entry>
+ <entry>false | true</entry>
+ </row>
+ <row>
<entry>skipMeta</entry>
<entry>No</entry>
<entry>Exclude the meta data part of response (improves performance)</entry>
