dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 897
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2013-12-25 22:58:16 +0100
message:
  Analytics tables 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	2013-12-25 11:49:31 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-12-25 21:58:16 +0000
@@ -3217,6 +3217,38 @@
       the pivot table module. The analytics tables can be generated with a POST or PUT request
       to:</para>
     <screen>http://&lt;server-url>/api/resourceTables/analytics</screen>
+    <table frame="all">
+      <title>Analytics tables optional query parameters</title>
+      <tgroup cols="3">
+        <colspec colname="c1" colnum="1" colwidth="2.38*"/>
+        <colspec colname="c2" colnum="2" colwidth="1*"/>
+        <colspec colname="c3" colnum="3" colwidth="3.76*"/>
+        <thead>
+          <row>
+            <entry>Query parameter</entry>
+            <entry>Options value</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>skipResourceTables</entry>
+            <entry>false | true</entry>
+            <entry>Skips generation of resource tables</entry>
+          </row>
+          <row>
+            <entry>skipAggregate</entry>
+            <entry>false | true</entry>
+            <entry>Skips generation of aggregate data and completeness data</entry>
+          </row>
+          <row>
+            <entry>skipEvents</entry>
+            <entry>false | true</entry>
+            <entry>Skips generation of event data</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
     <para>The data mart is tables containing pre-calculated aggregated data which are used by DHIS 2
       analysis modules and can be used directly by SQL reports. The data mart tables can be
       generated with a POST or PUT request to:</para>