Summary
Search Workflows
Description
Search Workflows with Options
Route
POST /workflow_engine/workflows/search
Roles
admin
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
options |
object |
yes |
expand, fields, query, limit, skip, sort |
Copied to Clipboard
{
"options": {
"expand": [
"owner",
"user",
"created_by",
"owner",
"user"
],
"fields": {
"name": 1
},
"query": {
"name": "abcd"
},
"limit": 50,
"local": false,
"skip": 0,
"sort": {
"name": -1
}
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
workflows |
object |
Search Results |
Copied to Clipboard
{
"results": [
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
}
},
"transitions": {},
"groups": [
"31c6296596a6737dba640c2b",
"8714dcb305b476cde524c3af",
"f91b2a43220c052d94340c95",
"bf9b30a435e62f6ffc9c8b3b"
],
"_id": "ef766131-dfb1-29a7-9bf6-16a0a45ad57f",
"description": null,
"font_size": 12,
"created": "1978-05-13T01:14:23.356Z",
"created_by": "d97d53db38acef3033be29c1",
"last_updated": "1977-12-25T06:11:41.682Z",
"last_updated_by": "7d6635786e180f6a2180c902",
"tags": []
},
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
}
},
"transitions": {},
"groups": [
"aff6d3629318f52e07c86edf",
"b32419cb9c21f1cfe2adb072",
"897f8b1f1c24f3a946ef2477"
],
"_id": "ccc40689-4af0-5210-d6bc-f52936583ef8",
"description": null,
"font_size": 12,
"created": "2019-08-31T06:15:15.342Z",
"created_by": "b0633ff6b2d5ef8f920cdf65",
"last_updated": "1998-09-13T15:06:09.066Z",
"last_updated_by": "f10551065ee8a5f72fe5dd1e",
"tags": []
}
],
"skip": 0,
"limit": 50,
"total": 100
}