dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 1144
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2014-07-16 12:29:37 +0700
message:
  document field transformers
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-07-16 05:25:11 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2014-07-16 05:29:37 +0000
@@ -567,6 +567,16 @@
       units:<screen>/api/dataSets/BfMAe6Itzgt?fields=id,name,organisationUnits[:all,!id]</screen></para>
     <para><emphasis role="bold">Example</emphasis>: Include nameable properties from all
       indicators:<screen>/api/indicators.json?fields=:nameable</screen></para>
+    <section>
+      <title>Field transformers</title>
+      <para>In DHIS 2.17 we introduced field transformers, the idea is to allow further
+        customization of the properties on the server side. For 2.17 we only supports one
+        transformer called <emphasis role="bold">rename</emphasis>, it can be used like
+        this:<screen>/api/dataElements/ID?fields=id|rename(i),name|rename(n)</screen></para>
+      <para>This will rename the <emphasis role="italic">id</emphasis> property to <emphasis
+          role="italic">i</emphasis> and <emphasis role="italic">name</emphasis> property to
+          <emphasis role="italic">n</emphasis>.</para>
+    </section>
   </section>
   <section>
     <title>Meta-data create, read, update, delete</title>