dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #27360
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 941: minor docs for app web-api
------------------------------------------------------------
revno: 941
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Tue 2014-01-07 13:56:46 +0100
message:
minor docs for app web-api
modified:
src/docbkx/en/dhis2_user_man_apps.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_apps.xml'
--- src/docbkx/en/dhis2_user_man_apps.xml 2013-12-23 09:16:02 +0000
+++ src/docbkx/en/dhis2_user_man_apps.xml 2014-01-07 12:56:46 +0000
@@ -131,4 +131,15 @@
under services and from the module overview page. It can also be accessed from the home page
of the apps module. Click on an app in the list in order to launch it.</para>
</section>
+ <section>
+ <title>Web-API for Apps</title>
+ <para>From DHIS 2.14 there is also additional support for apps through the web-api. The <emphasis role="italic">/api/apps</emphasis>
+ endpoint can be used for installing, deleting, listing apps.</para>
+ <para><emphasis role="bold">To list all installed apps (mediatypes works as usual, accept header or file extension, xml and
+ json):</emphasis><screen>curl -X GET -u user:pass -H "Accept: application/json" http://server/api/apps</screen></para>
+ <para><emphasis role="bold">To install an
+ app:</emphasis><screen>curl -X POST -u user:pass -F file=@app.zip http://server/api/apps</screen></para>
+ <para><emphasis role="bold">To delete an
+ app:</emphasis><screen>curl -X DELETE -u user:pass http://server/api/apps/<app-name></screen></para>
+ </section>
</chapter>