=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml' --- src/docbkx/en/dhis2_user_man_web_api.xml 2014-05-31 10:44:43 +0000 +++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-06-01 11:36:13 +0000 @@ -4150,6 +4150,9 @@ Category option combo update will remove obsolete and generate missing category option combos for all category combinations: api/maintenance/categoryOptionComboUpdate + Cache clearing will clear the application Hibernate cache and the analytics partition + caches: + api/maintenance/cacheClearing
System resource @@ -4275,34 +4278,28 @@ currently logged in as, including username, user credentials, assigned organisation units: /api/me - Gives information about currently - unread messages and interpretations. + Gives information about currently unread messages and interpretations: /api/me/dashboard - Lists all messages and interpretations in - the inbox (including replies). + Lists all messages and interpretations in the inbox (including replies): /api/me/inbox - Gives the full profile information - for current user. This endpoint support both GET to - retrieve profile and POST to update profile (the exact same - format is used). + Gives the full profile information for current user. This endpoint support both GET to retrieve profile and POST + to update profile (the exact same format is used): /api/me/user-account - Returns true or false, - indicating whether the current user has been granted the given <auth> authorization. + Returns true or false, indicating whether the current user has been granted the given + <auth> authorization: /api/me/authorization/<auth> - Lists all organisation units - directly assigned to the user. + Lists all organisation units directly assigned to the user: /api/me/organisationUnits - Gives all the datasets assigned to the - users organisation units, and their direct children. This endpoint contains all required - information to build a form based on one of our datasets. If you want all descendants of your - assigned organisation units, you can use the query parameter includeDescendants=true. + Gives all the datasets assigned to the users organisation units, and their direct + children. This endpoint contains all required information to build a form based on one of our + datasets. If you want all descendants of your assigned organisation units, you can use the + query parameter includeDescendants=true : /api/me/dataSets - Gives all the programs assigned to the - users organisation units, and their direct children. This endpoint contains all required - information to build a form based on one of our datasets. If you want all descendants of your - assigned organisation units, you can use the query parameter includeDescendants=true. + Gives all the programs assigned to the users organisation units, and their direct + children. This endpoint contains all required information to build a form based on one of our + datasets. If you want all descendants of your assigned organisation units, you can use the + query parameter includeDescendants=true : /api/me/programs
@@ -4459,20 +4456,24 @@ HTTP POST method. You can post the payload the the following URL: /api/trackedEntityInstances - For example, let us create a new instance of a Person and setting the age to - 30:{ + For example, let us create a new instance of a person tracked entity and specify its + first name and last name + attributes:{ "trackedEntity": "cyl5vuJ5ETQ", - "orgUnit": "ImspTQPwCqd", + "orgUnit": "DiszpKrYNg8", "attributes": [ { - "attribute": "spFvx9FndA4", - "value": "30" + "attribute": "dv3nChNSIxy", + "value": "Joe" + }, + { + "attribute": "hwlRTFIFSUq", + "value": "Smith" } ] } - To push this to the server, you can use the cURL - command:curl -X POST -d @data.json -H "Content-Type: application/json" -u admin:district - http://apps.dhis2.org/demo/api/trackedEntityInstances -v + To push this to the server you can use the cURL command like + this:curl -d @tei.json "apps.dhis2.org/demo/api/trackedEntityInstances" -X POST -H "Content-Type: application/json" -u admin:district -v
Updating a tracked entity instance