Search Tasks
GET {{url}}/{{tenantName}}/{{instanceName}}/tasks
Example overview
Search tasks by many parameters
Default behaviour for requests by user: return list of tasks, where current user is assignee or watcher.
Default behaviour for requests by API-Client: return list of all tasks
HTTP Request
Method: GET
Endpoint: {url}/{tenantName}/{instanceName}/tasks
in our example it would be: https://api.live.welkincloud.io/gh/sb-demo/tasks
Deprecated parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| assigneeId | path | replased to assigneeIds | No | UUID (or comma separated list of UUID) |
| patientId | path | replased to patientIds | No | UUID |
| status | path | replased to statuses | No | [TODO, IN_PROGRESS, COMPLETED, CANCELED] - one or more comma separated |
| priority | path | replased to priorities | No | [LOW, MEDIUM, HIGH, URGENT] - one or more comma separated |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
templates | string | Looks for tasks with template. String (or comma separated list of string) | |
withoutTemplate | boolean | Looks for tasks without template | |
assigneeIds | string | assigneeIds | |
patientIds | string | Looks for tasks related to patient. UUID (or comma separated list of UUID) | |
statuses | string | Looks for tasks with status [TODO, IN_PROGRESS, COMPLETED, CANCELED] - one or more comma separated | |
priorities | string | Looks for tasks with priority [LOW, MEDIUM, HIGH, URGENT] - one or more comma separated | |
dueBefore | string | Looks for tasks whose deadline is up to the specified day. Datetime in ISO-8601 format | |
dueAfter | string | Looks for tasks whose deadline is after the specified day. Datetime in ISO-8601 format | |
authorId | string | Looks for tasks created by user ( UUID) | |
dueDate | string | Looks for tasks whose deadline is on the specified day. Datetime in ISO-8601 format | |
search | string | Search by name or description | |
description | string | Looks for tasks whose descriptions partially matches the specified one | |
watcherId | string | Looks for tasks monitored by the specified user (UUID) | |
size | number | ||
page | number | ||
sort | null |