Partial update Task
PATCH {{url}}/{{tenantName}}/{{instanceName}}/tasks/{{task_id}}
Example overview
Updated name
, dueDate
, status
, priority
fields
HTTP Request
Method: PATCH
Endpoint: {url}/{tenantName}/{instanceName}/tasks/{taskId}
in our example it would be: https://api.live.welkincloud.io/gh/sb-demo/tasks/28b38060-db66-4183-bcaa-34751308573a
Parameters
Name | Located in | Description | Required | Type |
---|---|---|---|---|
tenantName | path | Name of tenant | Yes | string |
instanceName | path | Name of instance | Yes | string |
taskId | path | Task identifier | Yes | UUID |
name | body | Short name of the task | Yes | string |
description | body | Detailed text description of the task | No | string |
priority | body | task priority | Yes | LOW , MEDIUM , HIGH , URGENT |
status | body | task status | Yes | TODO , IN_PROGRESS , COMPLETED , CANCELED |
dueDate | body | deadline for the task | No | Datetime in ISO-8601 format |
assignee | body | user responsible for the task | Yes | {"id": ""} |
patient | body | task-related patient | No | {"id": ""} |
Responses
Code | Description |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Request Body
{"name"=>"Updated task", "description"=>"Create new patient profile", "dueDate"=>"2021-12-01T12:16:38.514Z", "priority"=>"URGENT", "status"=>"IN_PROGRESS", "assignee"=>{"id"=>"03a87f5b-3a04-4be8-b0ad-7a34a5b2892d"}, "patient"=>{"id"=>"fff8d36d-01ef-4bf4-ba92-bacfa954c178"}}