From 819d9a924203ceed7bf3de177dfc721b7ad225b2 Mon Sep 17 00:00:00 2001
From: liivw <164842155+liivw@users.noreply.github.com>
Date: Wed, 25 Sep 2024 19:23:13 +0800
Subject: [PATCH 1/2] Update API docs
- search Human task
- search workflow executions
---
.../api/human-tasks/search-task-list.md | 33 +++++++++++++------
.../workflow/search-workflow-executions.md | 15 +++++----
2 files changed, 32 insertions(+), 16 deletions(-)
diff --git a/docs/reference-docs/api/human-tasks/search-task-list.md b/docs/reference-docs/api/human-tasks/search-task-list.md
index 27b3646b..9ce8dc65 100644
--- a/docs/reference-docs/api/human-tasks/search-task-list.md
+++ b/docs/reference-docs/api/human-tasks/search-task-list.md
@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
# Search Human Tasks
-Used to retrieve a list of human tasks by search criteria.
+Used to retrieve a list of Human tasks based on the provided search criteria.
:::note
The invoking user should be a task owner, an ADMIN, or an assignee to the tasks returned.
@@ -17,13 +17,26 @@ The invoking user should be a task owner, an ADMIN, or an assignee to the tasks
| Attribute | Description |
|--------------------|----------------------------------------------------------------------------------------------------|
-| 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 |
-| 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 |
+| start | The start of the search results list, which is used for pagination. |
+| size | The number of search results that should be returned from the specified start. |
+| searchType | The user making the search. Supported values: ADMIN |
+| definitionNames | An array of Human task definition names. |
+| displayNames | An array of Human task display names. |
+| taskRefNames | An array of Human task reference names. |
+| workflowIds | An array of workflow IDs that contain the Human task. |
+| workflowNames | An array of workflow names that contain the Human task. |
+| states | The Human task state. Supported values:
- PENDING
- ASSIGNED
- IN_PROGRESS
- COMPLETED
- TIMED_OUT
- DELETED
|
+| taskInputQuery | Input data to the Human task. |
+| taskOutputQuery | Output data from the Human task. |
+| fullTextQuery | All data associated with the Human task. This search can be made based on an “AND” and “OR” query. |
+| updateStartTime | The start range for the Human task execution start time.|
+| updateEndTime | The end range for the Human task execution start time. |
+| assignees | An array of assignees. |
+| assignees. user | The assignee’s user ID. |
+| assignees. userType | The assignee’s user type. Supported values: - Conductor User
- Conductor Group
- External User
- External Group
|
+| claimants | An array of claimants. |
+| claimants. user | The claimant’s user ID. |
+| claimants. userType | The claimant's user type. Supported values: - Conductor User
- Conductor Group
- External User
- External Group
|
:::tip
@@ -33,7 +46,7 @@ Use the UI to make searches and you can see the payload sent in the network tab
## API Endpoint
```
-GET human/tasks/search
+POST human/tasks/search
```
## Client SDK Methods
@@ -81,4 +94,4 @@ TODO: Coming soon to the SDKs
```
-
+
\ No newline at end of file
diff --git a/docs/reference-docs/api/workflow/search-workflow-executions.md b/docs/reference-docs/api/workflow/search-workflow-executions.md
index 94409ea7..164f4333 100644
--- a/docs/reference-docs/api/workflow/search-workflow-executions.md
+++ b/docs/reference-docs/api/workflow/search-workflow-executions.md
@@ -5,18 +5,21 @@ sidebar_position: 10
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
-# Search for Workflow Executions
+# Search Workflow Executions
-Used to search for workflow executions.
+Used to retrieve a list of workflow executions based on the provided search criteria.
## Input Payload
| Attribute | Description |
|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Start | Indicates the start index, which is used for pagination. |
-| Size | Indicates the number of results to return. |
-| Query | The query expression in the format FIELD = 'VALUE' or FIELD IN (value1, value2). Only **AND** operations are supported. E.g., workflowId IN ('a', 'b', 'c') AND workflowType ='test_workflow' AND startTime BETWEEN 1000 and 2000. Supported fields for Query are: **workflowId**,**correlationId**, **taskId**, **workflowType**, **taskType**, **status**, **startTime** and **modifiedTime**. |
-| FreeText | All the workflow input, output, and task outputs up to a certain limit (check with your admins to find the size limit) are full-text indexed and can be used to search. |
+| start | The start of the search results list, which is used for pagination. Default value: 0 |
+| size | The number of search results that should be returned from the specified start. Default value = 100 |
+| sort | The manner in which the list will be sorted, in the format "FIELD:ASC|DESC”. Example: `sort = “workflowId:DESC”`. |
+| freeText | All full-text indexed data associated with the workflow execution (workflow input, output, and task outputs), up to a certain limit. Default value: *
**Note**: Check with you admins to get the size limit. |
+| query | The query expression in the format “FIELD = VALUE” or “FIELD IN (value1, value2)”. Supported fields for querying: - workflowId
- correlationId
- workflowType
- status
- startTime
- modifiedTime
Only AND operations are supported.
Example queries: - workflowType = your_workflow_name
- status IN (SCHEDULED, IN_PROGRESS)
- startTime >1726655978410
- startTime < 1696143600000
- workflowType = your_workflow_name AND status = SCHEDULED
- workflowId IN (3434546, 45365767, 20984885) AND workflowType = test_workflow
|
+| skipCache | Whether to skip caching. Default value: false |
+
## API Endpoint
```
From b9127ca8770f0105dc5bcc52d8deb8c17262dbe4 Mon Sep 17 00:00:00 2001
From: liivw <164842155+liivw@users.noreply.github.com>
Date: Wed, 25 Sep 2024 22:28:51 +0800
Subject: [PATCH 2/2] Update search-task-list.md
---
docs/reference-docs/api/human-tasks/search-task-list.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/reference-docs/api/human-tasks/search-task-list.md b/docs/reference-docs/api/human-tasks/search-task-list.md
index 9ce8dc65..9bc8e376 100644
--- a/docs/reference-docs/api/human-tasks/search-task-list.md
+++ b/docs/reference-docs/api/human-tasks/search-task-list.md
@@ -19,7 +19,7 @@ The invoking user should be a task owner, an ADMIN, or an assignee to the tasks
|--------------------|----------------------------------------------------------------------------------------------------|
| start | The start of the search results list, which is used for pagination. |
| size | The number of search results that should be returned from the specified start. |
-| searchType | The user making the search. Supported values: ADMIN |
+| searchType | The user making the search. Supported values: |
| definitionNames | An array of Human task definition names. |
| displayNames | An array of Human task display names. |
| taskRefNames | An array of Human task reference names. |