Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: order parameter for tracker entities #1206

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

docs: order parameter for tracker entities #1206

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
88c2457
docs: order parameter for enrollment
zubaira Jul 11, 2023
4d52e62
column supported for ordering
zubaira Jul 11, 2023
27afc9a
add columns support for ordering
zubaira Jul 11, 2023
30a8a61
correction
zubaira Jul 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/developer/web-api/tracker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1199,9 +1199,7 @@ The following endpoint supports standard parameters for pagination.
|`page`|`Integer`| Any positive integer |Page number to return. Defaults to 1 if missing|
|`pageSize`|`Integer`| Any positive integer |Page size. Defaults to 50. |
|`totalPages`|`Boolean`| `true`|`false` |Indicates whether to return the total number of pages in the response |
|`skipPaging`|`Boolean`| `true`|`false` |Indicates whether paging should be ignored and all rows should be returned. Defaults to `false`, meaning that by default all requests are paginated, unless `skipPaging=true`|
|`order`|`String`|comma-delimited list of `OrderCriteria` in the form of `propName:sortDirection`.<br><br> Example: `createdAt:desc`<br><br>**Note:** `propName` is case sensitive, `sortDirection` is case insensitive|Sort the response based on given `OrderCriteria`|

|`skipPaging`|`Boolean`| `true`&#124;`false` |Indicates whether paging should be ignored and all rows should be returned. Defaults to `false`, meaning that by default all requests are paginated, unless `skipPaging=true`|
> **Caution**
>
> Be aware that the performance is directly related to the amount of data requested. Larger pages will take more time to return.
Expand Down Expand Up @@ -1283,6 +1281,8 @@ The endpoint returns a list of tracked entities that match the request parameter
|`includeDeleted`|`Boolean`|`true`&#124;`false`|Indicates whether to include soft-deleted elements|
|`includeAllAttributes`|`Boolean`|`true`&#124;`false`|Indicates whether to include all TEI attributes|
|`potentialDuplicate`|`Boolean`|`true`&#124;`false`| Filter the result based on the fact that a TEI is a Potential Duplicate. true: return TEIs flagged as Potential Duplicates. false: return TEIs NOT flagged as Potential Duplicates. If omitted, we don't check whether a TEI is a Potential Duplicate or not. |
|`order`|`String`|comma-delimited list of property name or attribute and sort direction pairs in format `propName:sortDirection`.|Sort the response based on given order values.<br><br>Example: `createdAt:desc` or `SzVk2KvkSSd:asc`<br><br>**Note:** `propName` is case sensitive, `sortDirection` is case insensitive. Supported are `trackedEntity, createdAt, createdAtClient, updatedAt, updatedAtClient and enrollmentDate`.|


The available assigned user modes are explained in the following table.

Expand Down Expand Up @@ -1878,6 +1878,7 @@ Returns a list of events based on filters.
|`trackedEntity`|`String`|`uid`| Identifier of tracked entity instance|
|`enrollment`|`String`|Comma-delimited list of `uid`| Filter the result down to a limited set of IDs by using enrollment=id1;id2.|
|`includeDeleted`|`Boolean`| | When true, soft deleted events will be included in your query result.|
|`order`|`String`|comma-delimited list of property name or attribute and sort direction pairs in format `propName:sortDirection`.|Sort the response based on given order values.<br><br>Example: `created:desc` or `SzVk2KvkSSd:asc`<br><br>**Note:** `propName` is case sensitive, `sortDirection` is case insensitive. Supported are `created, lastupdated, enrollmentdate, incidentdate, status, trackedentityinstanceid, organisationunitid, storedby, programinstanceid, enddate, programid, completedby, createdbyuserinfo and lastupdatedbyuserinfo`.|

The query is case-insensitive. The following rules apply to the query parameters.

Expand Down