Summary
Search Workflows
Description
Search Workflows with Options
Route
POST /workflow_engine/workflows/search
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | object | yes | expand, fields, query, limit, skip, sort |
{ "options": { "expand": [ "owner", "created_by" ], "fields": { "name": 1 }, "query": { "name": "abcd" }, "limit": 50, "local": true, "skip": 0, "sort": { "name": -1 } } }
{ "type": "object", "properties": { "options": { "$ref": "wfEngineCommon#/definitions/expandedSearchOptions" } }, "required": [ "options" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| workflows | object | Search Results |
{ "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 }, "error_handler": { "name": "childJob", "summary": "aliquip sunt voluptate", "description": "tempor ullamco sint", "app": "ipsum", "variables": { "error": "" }, "groups": [ "3c8079ae10ffdc0412c1deb6" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error", "failure", "failure", "failure", "error" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "6ad0352035bbb8186b105ed7" ], "_id": "4321abcdef694aa79dae47ad", "description": "est officia", "preAutomationTime": 5000, "font_size": 12, "created": "2024-11-05T11:28:44.47Z", "created_by": "3fcebf587a68ee63ff2f750a", "last_updated": "1958-08-13T19:03:13.009Z", "last_updated_by": "1615229d8efb36402a5e16f6", "lastUpdatedVersion": "quis ullamco esse", "tags": [], "canvasVersion": 2 }, { "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 }, "error_handler": { "name": "childJob", "summary": "consequat esse", "description": "cupidatat officia pariatur nulla", "app": "officia id esse Excepteur", "variables": { "error": "" }, "groups": [ "a708dccc3cb6bff1c37db637", "d3ddc21f8289f4dc1f9dd7cc" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "error", "success" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "10f0806105b8efcd4ca8e14f", "7ded76bf474124cf121fabe7", "92ef58d77caa129c775ad0e1", "5dc3852e0ed0847a4439ee63", "322cb8883595fc36c02085c6" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "irure labore", "preAutomationTime": 250000, "font_size": 12, "created": "2009-09-23T02:39:54.346Z", "created_by": "e2b3bd0b08b8309a786ae8b8", "last_updated": "1985-08-18T07:27:54.537Z", "last_updated_by": "b21c9f35383655728976538d", "lastUpdatedVersion": "qui", "tags": [], "canvasVersion": 2 }, { "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 }, "error_handler": { "name": "childJob", "summary": "ullamco", "description": "ullamco sit non dolor", "app": "sint aliquip id eu sit", "variables": { "error": "" }, "groups": [ "7114050cde174f1bff06d6b1", "efc0033b3089c0627ed8cb22", "8c6725075e5d2f3d97c4123d", "9f8449f7485f5e32f03c8846", "04a94afe650a0f854727edbd" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "failure", "success", "error", "failure" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "8b443dc8088f38faec020170", "c87ef11f9682b672f56bbf07", "2b745bb049879130bce9e5ca", "e6038766386c7a4e19485285" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1994-03-06T09:27:19.107Z", "created_by": "64e76dc8c8d7e5c0205c8edf", "last_updated": "1977-08-28T19:39:48.357Z", "last_updated_by": "6eb6682fcc2d0f70926f0af9", "lastUpdatedVersion": "proident laborum", "tags": [], "canvasVersion": 2 }, { "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 }, "error_handler": { "name": "childJob", "summary": "eiusmod in laboris consectetur", "description": "proident", "app": "et qui nisi deserunt amet", "variables": { "error": "" }, "groups": [ "94f37c1399019b98478b4f68", "c8f99a5e151917256dccb9e7", "c96dfbff6a5bbfca1ef02977" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "failure", "failure" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "7bfa95787f571539007306b7" ], "_id": "4321abcdef694aa79dae47ad", "description": "officia in culpa deserunt", "preAutomationTime": 250000, "font_size": 12, "created": "1969-07-25T01:01:00.53Z", "created_by": "aeb4d265099e773781a79176", "last_updated": "1947-10-29T22:01:03.286Z", "last_updated_by": "d4b73de6c16d2af205987c16", "lastUpdatedVersion": "anim veniam", "tags": [], "canvasVersion": 1 }, { "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 }, "error_handler": { "name": "childJob", "summary": "exercitation enim ut quis", "description": "id minim dolore laboris in", "app": "est aliqua anim do", "variables": { "error": "" }, "groups": [ "e725799ab5e112e5273359b5", "c64973d94233dd78960eb64e", "a2138d79f75fc92602f94c50", "6b9c29740c3cee5b00a5b322" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "f04fc5af606ea5b677cec06e", "98eafb31bd11806e4fe611f5", "36dc860d7efc29fc86e54654", "30ffe7010d4cbbc055630610" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "in fugiat in", "preAutomationTime": 250000, "font_size": 12, "created": "2016-11-10T09:14:39.968Z", "created_by": "141c06eade45fa1214c27b08", "last_updated": "2018-06-14T17:52:40.36Z", "last_updated_by": "40ad14dcd345ac54a5c5f620", "lastUpdatedVersion": "commodo occaecat ad", "tags": [], "canvasVersion": 1 } ], "skip": 0, "limit": 50, "total": 100 }
{ "title": "workflows", "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "workflowDocument" } }, "skip": { "$ref": "wfEngineCommon#/definitions/skip" }, "limit": { "$ref": "wfEngineCommon#/definitions/limit" }, "total": { "$ref": "wfEngineCommon#/definitions/total" } } }