=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml 2014-06-16 20:02:18 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-06-24 19:25:41 +0000
@@ -4374,10 +4374,24 @@
Alternatively, you can submit the setting value as the request body, where content type is
set to "text/plain". As an example, you can use curl like this:
curl "apps.dhis2.org/demo/api/systemSettings/my-key" -d "My long value" -H "Content-Type: text/plain" -u admin:district -v
+ To set system settings in bulk you can send a JSON object with a property -value pair for
+ each system setting key-value pair using a POST request:
+ {
+ "keyApplicationNotification": "Welcome",
+ "keyApplicationIntro": "DHIS 2",
+ "keyApplicationFooter": "Read more at dhis2.org"
+}
You should replace my-key with your real key and my-val with your real value. To retrieve
the value for a given key in plain text you can make a GET
request to the following URL:
/api/systemSettings/my-key
+ Alternatively, you can specify the key as a query parameter:
+ /api/systemSettings?key=my-key
+ You can retrieve specific system settings as JSON by repeating the key query
+ parameter:
+ curl "apps.dhis2.org/demo/api/systemSettings?key=keyApplicationNotification&key=keyApplicationIntro" -H "Content-Type: application/json" -u admin:district -v
+ You can retrieve all system settings with a GET request:
+ /api/systemSettings
To delete a system setting, you can make a DELETE
request to the URL similar to the one used above for retrieval.