Merge pull request #596 from RizaFarheen/main

Human Task APIs
orkes-io · Jan 5, 2024 · ee2dbec · ee2dbec
2 parents b0e79ef + c10f3ef
commit ee2dbec
Show file tree

Hide file tree

Showing 14 changed files with 35 additions and 39 deletions.
diff --git a/docs/reference-docs/api/human-tasks/action-logs.md b/docs/reference-docs/api/human-tasks/action-logs.md
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
 Used to retrieve human task action logs.
 
 :::note
-The invoking user should be a task owner, an ADMIN, or an assignee to the task. When using application credentials, the application should be the owner of the task in the workflow definition.
+The invoking user should be a task owner, an ADMIN, or an assignee to the task. 
 :::
 
 ## Input Payload

diff --git a/docs/reference-docs/api/human-tasks/claim-task-conductor-user.md b/docs/reference-docs/api/human-tasks/claim-task-conductor-user.md
@@ -10,14 +10,14 @@ import TabItem from '@theme/TabItem';
 Used to claim a human task by an authenticated Conductor user. Use this API to claim a task for a user with Conductor identity.
 
 :::note
-The invoking user should be a task owner, an ADMIN, or a CONDUCTOR_USER or CONDUCTOR_GROUP assignee to the task. If the task is assigned using the __Free for all__ policy, any Conductor user will be able to retrieve the task. When using application credentials, the application should be the owner of the task in the workflow definition.
+The invoking user should be a task owner, an ADMIN, or a CONDUCTOR_USER or CONDUCTOR_GROUP assignee to the task. If the task is not assigned to anyone/group, any Conductor user will be able to retrieve the task. 
 :::
 
 ## Input Payload
 
 | Attribute  | Description                                                |
 |------------|------------------------------------------------------------| 
-| taskId     | The *taskId* of the human task which you want to retrieve. | 
+| taskId     | The *taskId* of the human task to be claimed. | 
 
 ## API Endpoint 
 

diff --git a/docs/reference-docs/api/human-tasks/claim-task-external-user.md b/docs/reference-docs/api/human-tasks/claim-task-external-user.md
@@ -21,16 +21,14 @@ proceed to the next step.
 :::note 
 The invoking user should be a task owner or an ADMIN. The provided userId will be matched if the assignee on the
 task is of type EXTERNAL_USER, CONDUCTOR_USER or CONDUCTOR_GROUP. If the assignee type is EXTERNAL_GROUP, the system
-will assume the external system has validated the claim criteria. If the task is assigned using the __Free for all__
-policy, any user will be able to retrieve the task. When using application credentials, the application should be the
-owner of the task in the workflow definition.
+will assume the external system has validated the claim criteria. If the task is not assigned to any one, any user will be able to retrieve the task. 
 :::
 
 ## Input Payload
 
 | Attribute  | Description                                                |
 |------------|------------------------------------------------------------| 
-| taskId     | The *taskId* of the human task which you want to retrieve. | 
+| taskId     | The *taskId* of the human task to be claimed. | 
 | userId     | The *userId* of the user claiming this task.               | 
 
 ## API Endpoint

diff --git a/docs/reference-docs/api/human-tasks/delete-task-ui-template.md b/docs/reference-docs/api/human-tasks/delete-task-ui-template.md
@@ -5,9 +5,9 @@ sidebar_position: 13
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Delete Human Task Template
+# Delete Human Task User Form/Template
 
-Used to delete a human task template by id. Use this API to delete a task template specification stored in Conductor.
+Used to delete a human task template by its name. Use this API to delete a task template specification stored in Conductor.
 
 :::danger Deleting Templates
 If the template is used by a workflow, it will fail to render.
@@ -17,12 +17,12 @@ If the template is used by a workflow, it will fail to render.
 
 | Attribute | Description                                                   |
 |-----------|---------------------------------------------------------------| 
-| id        | The *id* of the human task template which you want to delete. | 
+| name        | The *name* of the human task user-form/template to be deleted. | 
 
 ## API Endpoint 
 
 ```
-DELETE human/template/{id}
+DELETE human/template/{name}
 ```
 
 ## Client SDK Methods

diff --git a/docs/reference-docs/api/human-tasks/delete-task.md b/docs/reference-docs/api/human-tasks/delete-task.md
@@ -11,8 +11,7 @@ This API is only to be used to delete a task that is disconnected from a workflo
 normal conditions, this API wouldn't have to be used.
 
 :::note
-The invoking user should be a task owner or an ADMIN to the task. When using application credentials, 
-the application should be the owner of the task in the workflow definition.
+The invoking user should be a task owner or an ADMIN to the task. 
 :::
 
 :::warning Note
@@ -24,12 +23,12 @@ error state and the workflow would have to be retried or restarted to create a n
 
 | Attribute  | Description                                              |
 |------------|----------------------------------------------------------| 
-| taskId     | The *taskId* of the human task which you want to delete. | 
+| taskId     | The *taskId* of the human task to be deleted. | 
 
 ## API Endpoint 
 
 ```
-DELETE human/tasks/{taskId}
+DELETE human/tasks/delete/{taskId}
 ```
 
 ## Client SDK Methods

diff --git a/docs/reference-docs/api/human-tasks/get-task-list.md b/docs/reference-docs/api/human-tasks/get-task-list.md
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
 Used to retrieve a list of human tasks by filters. An example use of this API will be to compose an inbox view for a user.
 
 :::note
-The invoking user should be a task owner, an ADMIN, or an assignee to the tasks returned. When using application credentials, the application should be the owner of the task in the workflow definition.
+The invoking user should be a task owner, an ADMIN, or an assignee to the tasks returned.
 :::
 
 ## Input Payload

diff --git a/docs/reference-docs/api/human-tasks/get-task-ui-template.md b/docs/reference-docs/api/human-tasks/get-task-ui-template.md
@@ -5,20 +5,20 @@ sidebar_position: 12
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Get Human Task Template
+# Get Human Task User Forms (Templates)
 
-Used to retrieve a human task template by id. Use this API to retrieve a task template specification stored in Conductor.
+Used to retrieve a human task user forms/templates by id. Use this API to retrieve a user form/template specification stored in Conductor.
 
 ## Input Payload
 
 | Attribute | Description                                                     |
 |-----------|-----------------------------------------------------------------| 
-| id        | The *id* of the human task template which you want to retrieve. | 
+| humanTaskId        | The *id* of the human task in which the user form/template is added. | 
 
 ## API Endpoint 
 
 ```
-GET human/template/{id}
+GET human/template/{humanTaskId}
 ```
 
 ## Client SDK Methods

diff --git a/docs/reference-docs/api/human-tasks/get-task.md b/docs/reference-docs/api/human-tasks/get-task.md
@@ -7,10 +7,10 @@ import TabItem from '@theme/TabItem';
 
 # Get Human Task
 
-Used to retrieve a human task by id. Use this API to retrieve a task and its details.
+Used to retrieve a human task by using the task ID. Use this API to retrieve a task and its details.
 
 :::note
-The invoking user should be a task owner, an ADMIN, or an assignee to the task. If the task is assigned using the __Free for all__ policy, any user will be able to retrieve the task. When using application credentials, the application should be the owner of the task in the workflow definition.
+The invoking user should be the task admin, a cluster Admin, or an assignee to the task. If the task is not assigned to anyone, any user can retrieve the task.
 :::
 
 ## Input Payload

diff --git a/docs/reference-docs/api/human-tasks/list-task-ui-templates.md b/docs/reference-docs/api/human-tasks/list-task-ui-templates.md
@@ -13,8 +13,8 @@ Used to list all human task templates stored in Conductor and optionally filter
 
 | Attribute | Description         |
 |-----------|---------------------| 
-| name      | UI template name    | 
-| version   | UI template version | 
+| name      | The user-form/template name to be filtered.   | 
+| version   | The version of the user-form/template to be filtered.| 
 
 ## API Endpoint 
 

diff --git a/docs/reference-docs/api/human-tasks/reassign-human-task.md b/docs/reference-docs/api/human-tasks/reassign-human-task.md
@@ -10,16 +10,15 @@ Admin API used for re-assigning a task to a different assignment policy. Use thi
 longer valid and the task needs to be reassigned so that it can proceed further.
 
 :::note 
-The invoking user should be a task owner or an ADMIN to the task. When using application credentials, the
-application should be the owner of the task in the workflow definition.
+The invoking user should be a task owner or an ADMIN to the task. 
 :::
 
 ## Input Payload
 
 | Attribute    | Description                                                                                                                  |
 |--------------|------------------------------------------------------------------------------------------------------------------------------| 
-| taskId       | The *taskId* of the human task which you want to retrieve.                                                                   | 
-| Request Body | New assignment policy with corresponding values. Supported policies are `free_for_all`, `least_busy_group_member`, and `fixed`   | 
+| taskId       | The *taskId* of the human task to be reassigned.                                                                  | 
+| Request Body | New assignment policy with corresponding values. Supported policies are `EXTERNAL_USER`, `EXTERNAL_GROUP`, `CONDUCTOR_USER` and `CONDUCTOR_GROUP`.  | 
 
 ## API Endpoint
 

diff --git a/docs/reference-docs/api/human-tasks/release-human-task.md b/docs/reference-docs/api/human-tasks/release-human-task.md
@@ -10,14 +10,14 @@ Used for releasing a previously claimed task. If the user is unable to complete
 release the task so that a new claimant can claim this task.
 
 :::note 
-The invoking user should be a task owner, an ADMIN, or a claimant to the task. When using application credentials, the application should be the owner of the task in the workflow definition.
+The invoking user should be a task owner, an ADMIN, or a claimant to the task.
 :::
 
 ## Input Payload
 
 | Attribute    | Description                                               |
 |--------------|-----------------------------------------------------------| 
-| taskId       | The *taskId* of the human task which you want to release. | 
+| taskId       | The *taskId* of the human task to be released. | 
 
 ## API Endpoint
 

diff --git a/docs/reference-docs/api/human-tasks/save-task-ui-template.md b/docs/reference-docs/api/human-tasks/save-task-ui-template.md
@@ -5,15 +5,15 @@ sidebar_position: 14
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Save Human Task Template
+# Save Human Task User Form/Template
 
 Used to save human task templates stored in Conductor.
 
 ## Input Payload
 
 | Attribute       | Description         |
 |-----------------|---------------------| 
-| Request Payload | UI template payload | 
+| Request body | UI template payload | 
 
 ## API Endpoint 
 

diff --git a/docs/reference-docs/api/human-tasks/search-task-list.md b/docs/reference-docs/api/human-tasks/search-task-list.md
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
 Used to retrieve a list of human tasks by search criteria. This API is similar to the API [List Human Tasks](/content/reference-docs/api/human-tasks/get-task-list).
 
 :::note
-The invoking user should be a task owner, an ADMIN, or an assignee to the tasks returned. When using application credentials, the application should be the owner of the task in the workflow definition.
+The invoking user should be a task owner, an ADMIN, or an assignee to the tasks returned. 
 :::
 
 ## Input Payload
@@ -20,7 +20,7 @@ The invoking user should be a task owner, an ADMIN, or an assignee to the tasks
 | queryId            | Not used/supported at this time                                                                    |
 | start              | Marks the start of the records list                                                                |
 | size               | Marks the number of records from the beginning that should be returned                             |
-| freeText           | Additional criteria of a free text - this can include input/output values and other indexed fields |
+| outputfreeText           | Additional criteria of a free text - this can include input/output values and other indexed fields |
 | query              | Query for searching the tasks                                                                      |
 | jsonQuery          | JSON query for searching the tasks                                                                 |
 | includeInputOutput | Boolean to indicate if the inputs and outputs of the task should be included in the response       |

diff --git a/docs/reference-docs/api/human-tasks/update-human-task.md b/docs/reference-docs/api/human-tasks/update-human-task.md
@@ -6,19 +6,19 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
 
 # Update Human Task
 
-Used for updating a claimed task. Optionally complete the task.
+Used for updating a claimed task. Optionally this cane be used to complete the task.
 
 :::note 
-The invoking user should be a task owner, an ADMIN, or a claimant to the task. When using application credentials, the application should be the owner of the task in the workflow definition.
+The invoking user should be a task owner, an ADMIN, or a claimant to the task. 
 :::
 
 ## Input Payload
 
 | Attribute    | Description                                                                                                         |
 |--------------|---------------------------------------------------------------------------------------------------------------------| 
-| taskId       | The *taskId* of the human task which you want to release.                                                           | 
-| complete     | Boolean to mark if the task is complete or not, send this as false for just updating data, and keep the task in progress | 
-| Request Body | Output of the human task work - usually the payload of the human task form entries                                  | 
+| taskId       | The *taskId* of the human task to be updated.                                                           | 
+| complete     | Boolean to mark if the task is complete or not, send this as false for just updating data, and keep the task in progress. Set this is true to complete the task. | 
+| Request Body | Output of the human task work - usually the payload of the human task form entries.                                | 
 
 ## API Endpoint