David c ken patch 1

src/developer/web-api/analytics.md

@@ -184,9 +184,8 @@ The `/dimensions` API also provides an endpoint where the clients can get the *r
 
     /api/33/dimensions/recommendations?fields=id&dimension=dx:fbfJHSPpUQD
 
-In the example above, the client will receive back all the *Categories* that are configured as `Data dimension`s and associated (through data sets and category combos) with the data element `fbfJHSPpUQD`.
-In addition, all *Organization Unit Group Set*s that are configured as `Data dimension`s will also (and always) be returned as part of the response.
-
+In the example above, the response will contain the categories which are configured as data dimensions and associated, through data sets and category combos, with the data element `fbfJHSPpUQD`.
+In addition, all org unit group sets which are configured as data dimensions will be returned.
 
 The endpoint supports multiple data elements. If one wishes to send multiple data elements, they should be separated by `;`. For example:
 
@@ -196,7 +195,6 @@ The endpoint supports multiple data elements. If one wishes to send multiple dat
 >
 > This endpoint returns only dimensions that can be read by the current logged user. It will check if the current user can read the data or the metadata of the respective recommended dimension. Non-authorized dimensions are omitted from the list.
 
-
 The base URL to the analytics resource is `/api/analytics`. To request
 specific dimensions and dimension items you can use a query string on
 the following format, where `dim-id` and `dim-item` should be substituted with real values:
@@ -318,8 +316,8 @@ below.
 
   - For the organization unit dimension, you can specify items as either
     the organization unit or its sub-units associated with the currently
-    authenticated user. Use the keys USER_ORGUNIT for the organization unit
-    itself or USER_ORGUNIT_CHILDREN for its sub-units. You may also specify
+    authenticated user. Use the keys `USER_ORGUNIT` for the organization unit
+    itself or `USER_ORGUNIT_CHILDREN` for its sub-units. You may also specify
     organization unit identifiers directly or use a combination of both.
     The authenticated user must have permission to export and analyze data
     for the designated organization units. If no organization unit permissions
@@ -620,7 +618,7 @@ XML looks like this:
     api/analytics/dataValueSet.xml?dimension=dx:Uvn6LCg7dVU;OdiHJayrsKo
       &dimension=pe:LAST_4_QUARTERS&dimension=ou:lc3eMKXaEfw;PMa2VCrupOd
 
-A request which aggregates data for data element operands and uses CODE
+A request which aggregates data for data element operands and uses `CODE`
 as output identifier scheme looks like the below. When defining the
 output identifier scheme, all metadata objects part of the response are
 affected:
@@ -630,7 +628,7 @@ affected:
 
 When using attribute-based identifier schemes for export there is a risk
 of producing duplicate data values. The boolean query parameter
-duplicatesOnly can be used for debugging purposes to return only
+`duplicatesOnly` can be used for debugging purposes to return only
 duplicates data values. This response can be used to clean up the
 duplicates:
 
@@ -807,7 +805,7 @@ Table: Query parameters for event query analytics only
 
 | Query parameter | Required | Description | Options |
 |---|---|---|---|
-| ouMode | No | The mode of selecting organisation units. Default is DESCENDANTS, meaning all sub units in the hierarchy. CHILDREN refers to immediate children in the hierarchy; SELECTED refers to the selected organisation units only. More details [here](#webapi_tracker_orgunit_scope) | DESCENDANTS, CHILDREN, SELECTED |
+| ouMode | No | The mode of selecting organisation units. Default is `DESCENDANTS`, meaning all sub units in the hierarchy. `CHILDREN` refers to immediate children in the hierarchy; `SELECTED` refers to the selected organisation units only. More details [here](#webapi_tracker_orgunit_scope) | DESCENDANTS, CHILDREN, SELECTED |
 | asc | No | Dimensions to be sorted ascending, can reference event date, org unit name and code and any item identifiers. | `ouname` | `programstatus` | `eventstatus` | `createdbydisplayname` | `lastupdatedbydisplayname` | `eventdate` | `enrollmentdate` | `incidentdate` | `lastupdated` | item identifier |
 | desc | No | Dimensions to be sorted descending, can reference event date, org unit name and code and any item identifiers. | `ouname` | `programstatus` | `eventstatus` | `createdbydisplayname` | `lastupdatedbydisplayname` | `eventdate` | `enrollmentdate` | `incidentdate` | `lastupdated` | item identifier |
 | coordinatesOnly | No | Whether to only return events which have coordinates. | false | true |
@@ -816,11 +814,11 @@ Table: Query parameters for event query analytics only
 | headers | No | The name of the headers to be returned as part of the response. | One or more headers name separated by comma |
 | page | No | The page number. Default page is 1. | Numeric positive value |
 | pageSize | No | The page size. Default size is 50 items per page. | Numeric zero or positive value |
-| eventDate | no | (`events` resource only) Custom period on `eventDate` (see "custom date periods" section) | see "date and period format" section |
-| enrollmentDate | no | Custom period on `enrollmentDate` (see "custom date periods" section) | see "date and period format" section |
-| scheduledDate | no | (`events` resource only) Custom period on `scheduledDate` (see "custom date periods" section) | see "date and period format" section |
-| incidentDate | no | Custom period on `incidentDate` (see "custom date periods" section) | see "date and period format" section |
-| lastUpdated | no | Custom period on `lastUpdated` (see "custom date periods" section) | see "date and period format" section |
+| eventDate | no | Events resource only. Custom period on `eventDate`. See "custom date periods" section. | See "date and period format" section |
+| enrollmentDate | no | Custom period on `enrollmentDate`. See "custom date periods" section. | See "date and period format" section |
+| scheduledDate | no | Events resource only. Custom period on `scheduledDate`. See "custom date periods" section. | See "date and period format" section |
+| incidentDate | no | Custom period on `incidentDate`. See "custom date periods" section. | See "date and period format" section |
+| lastUpdated | no | Custom period on `lastUpdated`. See "custom date periods" section. | See "date and period format" section |
 
 
 

src/developer/web-api/data.md

@@ -509,7 +509,7 @@ Table: Data value set query parameters
 | startDate | Start date for the time span of the values to export. |
 | endDate | End date for the time span of the values to export. |
 | orgUnit | Organisation unit identifier. Can be repeated any number of times. |
-| children | Whether to include the children in the hierarchy of the organisation units. |
+| children | Whether to include the children in the hierarchy of the organisation units. Boolean value (default `false`).|
 | orgUnitGroup | Organisation unit group identifier. Can be repeated any number of times. |
 | attributeOptionCombo | Attribute option combo identifier. Can be repeated any number of times. |
 | includeDeleted | Whether to include deleted data values. |

src/developer/web-api/metadata.md

@@ -13,19 +13,12 @@ The full set of identifier scheme object types available are listed
 below, using the name of the property to use in queries:
 
   - idScheme
-
   - dataElementIdScheme
-
   - categoryOptionComboIdScheme
-
   - orgUnitIdScheme
-
   - programIdScheme
-
   - programStageIdScheme
-
   - trackedEntityIdScheme
-
   - trackedEntityAttributeIdScheme
 
 The general idScheme applies to all types of objects. It can be
@@ -988,7 +981,7 @@ table. You can also apply this to all available types by using
 `type:fields=<filter>` and `type:filter=<filter>`. You can also
 enable/disable the export of certain types by setting `type=true|false`.
 
-Table: Export Parameter
+Table: Export parameters
 
 | Name | Options | Description |
 |---|---|---|
@@ -999,6 +992,7 @@ Table: Export Parameter
 | locale | <locale\> | Change from user locale, to your own custom locale. |
 | defaults | INCLUDE/EXCLUDE | Should auto-generated category object be included or not in the payload. If you are moving metadata between 2 non-synced instances, it might make sense to set this to EXCLUDE to ease the handling of these generated objects. |
 | skipSharing | false/true | Enabling this will strip the sharing properties from the exported objects. This includes *user*, *publicAccess*, *userGroupAccesses*, *userAccesses*, and *externalAccess*. |
+| inclusionStrategy | NON_NULL, ALWAYS, NON_EMPTY | *NON_NULL* includes properties which are not null, *ALWAYS* includes all properties, *NON_EMPTY* includes non empty properties (will not include strings of 0 length or empty collections) |
 | download | false/true | Enabling this will add HTTP header Content-Disposition that specifies that the data should be handled as an attachment and will be offered by web browsers as a download. |
 
 ### Metadata export examples { #webapi_metadata_export_examples } 
@@ -1048,7 +1042,7 @@ These exports can then be imported using `/api/metadata`.
 
 These endpoints also support the following parameters:
 
-Table: Export Parameter
+Table: Export parameters
 
 | Name | Options | Description |
 |---|---|---|
@@ -1069,7 +1063,7 @@ generated by the metadata export API can be imported directly.
 The metadata import endpoint support a variety of parameters, which are
 listed below.
 
-Table: Import Parameter
+Table: Import parameters
 
 | Name | Options (first is default) | Description |
 |---|---|---|
@@ -1079,11 +1073,10 @@ Table: Import Parameter
 | preheatMode | REFERENCE, ALL, NONE | Sets the preheater mode, used to signal if preheating should be done for `ALL` (as it was before with *preheatCache=true*) or do a more intelligent scan of the objects to see what to preheat (now the default), setting this to `NONE` is not recommended. |
 | importStrategy | CREATE_AND_UPDATE, CREATE, UPDATE, DELETE | Sets import strategy, `CREATE_AND_UPDATE` will try and match on identifier, if it doesn't exist, it will create the object. |
 | atomicMode | ALL, NONE | Sets atomic mode, in the old importer we always did a *best effort* import, which means that even if some references did not exist, we would still import (i.e. missing data elements on a data element group import). Default for new importer is to not allow this, and similar reject any validation errors. Setting the `NONE` mode emulated the old behavior. |
-| flushMode | AUTO, OBJECT | Sets the flush mode, which controls when to flush the internal cache. It is *strongly* recommended to keep this to `AUTO` (which is the default). Only use `OBJECT` for debugging purposes, where you are seeing hibernate exceptions and want to pinpoint the exact place where the stack happens (hibernate will only throw when flushing, so it can be hard to know which object had issues). | 
+| flushMode | AUTO, OBJECT | Sets the flush mode, which controls when to flush the internal cache. It is *strongly* recommended to keep this to `AUTO` (which is the default). Only use `OBJECT` for debugging purposes, where you are seeing hibernate exceptions and want to pinpoint the exact place where the stack happens (hibernate will only throw when flushing, so it can be hard to know which object had issues). |
 | skipSharing | false, true | Skip sharing properties, does not merge sharing when doing updates, and does not add user group access when creating new objects. |
 | skipValidation | false, true | Skip validation for import. `NOT RECOMMENDED`. |
 | async | false, true | Asynchronous import, returns immediately with a *Location* header pointing to the location of the *importReport*. The payload also contains a json object of the job created. |
-| inclusionStrategy | NON_NULL, ALWAYS, NON_EMPTY | *NON_NULL* includes properties which are not null, *ALWAYS* include all properties, *NON_EMPTY* includes non empty properties (will not include strings of 0 length, collections of size 0, etc.) |
 | userOverrideMode | NONE, CURRENT, SELECTED | Allows you to override the user property of every object you are importing, the options are NONE (do nothing), CURRENT (use import user), SELECTED (select a specific user using overrideUser=X) |
 | overrideUser | User ID | If userOverrideMode is SELECTED, use this parameter to select the user you want override with. |
 
@@ -3864,7 +3857,6 @@ curl "localhost:8080/api/synchronization/metadataPull" -X POST
   -H "Content-Type:text/plain" -u admin:district
 ```
 
-
 > **Note**
 >
 > The supplied URL will be checked against the config property `metadata.sync.remote_servers_allowed` in the `dhis.conf` file.
@@ -3873,8 +3865,8 @@ curl "localhost:8080/api/synchronization/metadataPull" -X POST
 > - supply `https://server1.org/path/to/resource` -> this will be accepted
 > - supply `https://server2.org/resource/path` -> this will be accepted
 > - supply `https://oldserver.org/resource/path` -> this will be rejected
->
-Sample failure response
+
+Sample failure response in JSON format.
 
 ```json
  {