dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #30723
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 1101: Minor fix
------------------------------------------------------------
revno: 1101
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2014-06-11 08:44:51 +0200
message:
Minor fix
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-06-06 08:30:48 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-06-11 06:44:51 +0000
@@ -471,18 +471,18 @@
role="italic">id</emphasis> and <emphasis role="italic">name</emphasis> for every object.
For object that are either collections, or is a complex object which have properties on their
own, you can use the format <emphasis role="italic"
- >?field=id,name,dataSets[id,name]</emphasis> which would return <emphasis role="italic"
+ >?fields=id,name,dataSets[id,name]</emphasis> which would return <emphasis role="italic"
>id</emphasis>, <emphasis role="italic">name</emphasis> of the root, and the <emphasis
role="italic">id</emphasis> and <emphasis role="italic">name</emphasis> of every dataSet on
that object. Negation can be done with the exclamation operator, and we have a set of presets
of field select (see below).</para>
<para><emphasis role="bold">Example 1</emphasis>: Get <emphasis role="italic">id</emphasis> and
<emphasis role="italic">name</emphasis> on the indicators
- resource<screen>/api/indicators?field=id,name</screen></para>
+ resource<screen>/api/indicators?fields=id,name</screen></para>
<para><emphasis role="bold">Example 2</emphasis>: Get <emphasis role="italic">id</emphasis>,
<emphasis role="italic">name</emphasis> from dataElements, and also <emphasis role="italic"
>id</emphasis> and <emphasis role="italic">name</emphasis> from the dataSets on
- dataElements<screen>/api/dataElements?field=id,name,dataSets[id,name]</screen></para>
+ dataElements<screen>/api/dataElements?fields=id,name,dataSets[id,name]</screen></para>
<para>To exclude a property from the output, you can use the '!' operator, this is allowed
anywhere in the query, and will simply not include that property (as it might have been
inserted in some of the presets).</para>