Skip to content

Commit

Permalink
Update API docs
Browse files Browse the repository at this point in the history 
- search Human task
- search workflow executions
  • Loading branch information
@liivw
liivw committed Sep 25, 2024
1 parent 242d2c9 commit 819d9a9
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 16 deletions.
33 changes: 23 additions & 10 deletions docs/reference-docs/api/human-tasks/search-task-list.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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: <ul><li>PENDING</li> <li>ASSIGNED</li> <li>IN_PROGRESS</li> <li>COMPLETED</li> <li>TIMED_OUT</li> <li>DELETED</li></ul> |
| 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: <ul><li>Conductor User</li> <li>Conductor Group</li> <li>External User</li> <li>External Group</li></ul> |
| claimants | An array of claimants. |
| claimants. user | The claimant’s user ID. |
| claimants. userType | The claimant's user type. Supported values: <ul><li>Conductor User</li> <li>Conductor Group</li> <li>External User</li> <li>External Group</li></ul> |


:::tip
Expand All @@ -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
Expand Down Expand Up @@ -81,4 +94,4 @@ TODO: Coming soon to the SDKs
```

</TabItem>
</Tabs>
</Tabs>
15 changes: 9 additions & 6 deletions docs/reference-docs/api/workflow/search-workflow-executions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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: * <br/> **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: <ul><li>workflowId</li> <li>correlationId</li> <li>workflowType</li> <li>status</li> <li>startTime</li> <li>modifiedTime</li></ul> Only AND operations are supported. <br/><br/> Example queries: <ul><li>workflowType = your_workflow_name</li> <li>status IN (SCHEDULED, IN_PROGRESS)</li> <li>startTime >1726655978410</li> <li>startTime < 1696143600000</li> <li>workflowType = your_workflow_name AND status = SCHEDULED</li> <li>workflowId IN (3434546, 45365767, 20984885) AND workflowType = test_workflow</li></ul> |
| skipCache | Whether to skip caching. Default value: false |


## API Endpoint
```
Expand Down

0 comments on commit 819d9a9

Please sign in to comment.