Summary
Gets a page of workflow documents.
Description
Gets a page of workflow documents.
Route
GET /automation-studio/workflows
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
options | object | yes | Parameters for filtering, paginating, and sorting workflow documents. For ‘limit’, ‘skip’, ‘order’, ‘sort’, ‘include’, ‘exclude’, and ‘expand’: Example usage in getWorkflows task -- ‘{ ‘limit’: 10 }’ Example usage in HTTP query -- ‘?limit=10' For ‘in’, ‘not-in’, ‘equals’, ‘contains’, ‘starts-with’, ‘ends-with’, and ‘task-equals’: Example usage in getWorkflows task -- ‘{ ‘in’: { ‘name’: ‘my-workflow’ } }’ Example usage in HTTP query -- ‘?in[name]=my-workflow' |
{ "options": { "limit": 10, "skip": 10, "order": 1, "sort": "name", "exclude-project-members": true, "include": "description", "exclude": "description", "expand": "created_by,user,owner", "in": "in[name]=my-workflow,or-this-workflow&in[type]=automation", "not-in": "not-in[name]=my-workflow,not-this-workflow", "equals": "equals[name]=my-workflow", "contains": "contains[name]=workflow", "starts-with": "starts-with[name]=my-", "ends-with": "ends-with[name]=-workflow", "task-equals": "task-equals[app]=WorkFlowEngine" } }
{ "type": "object", "properties": { "options": { "title": "options", "type": "object", "properties": { "limit": { "type": "integer", "description": "Number of results to return. Used for pagination.", "default": 25, "minimum": 0, "examples": [ 1, 10, 50 ] }, "skip": { "type": "integer", "description": "Number of results to skip. Used for pagination.", "default": 0, "minimum": 0, "examples": [ 1, 10, 50 ] }, "order": { "type": "integer", "description": "Sort direction, 1 for ascending and -1 for descending.", "default": 1, "enum": [ -1, 1 ] }, "sort": { "type": "string", "description": "Field to sort by", "default": "name", "enum": [ "name" ] }, "exclude-project-members": { "type": "boolean", "description": "Flag which removes workflows from the results which are members of a project" }, "include": { "type": "string", "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", "examples": [ "name", "description", "name,description" ] }, "exclude": { "type": "string", "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", "examples": [ "_id", "description", "_id,description" ] }, "expand": { "type": "string", "title": "List of fields to get expanded data", "description": "Sets the fields to expand. Generally, these are fields like \"metrics.user\", \"metrics.owner\", \"created_by\", etc", "examples": [ "created_by,user,owner" ] }, "in": { "description": "Search for fields exactly matching one of the given list options", "type": "string", "examples": [ "in[name]=my-workflow,or-this-workflow&in[type]=automation" ] }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "type": "string", "examples": [ "not-in[name]=my-workflow,not-this-workflow" ] }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "type": "string", "examples": [ "equals[name]=my-workflow" ] }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "type": "string", "examples": [ "contains[name]=workflow" ] }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "type": "string", "examples": [ "starts-with[name]=my-" ] }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "type": "string", "examples": [ "ends-with[name]=-workflow" ] }, "task-equals": { "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", "type": "string", "examples": [ "task-equals[app]=WorkFlowEngine" ] } } } }, "required": [ "options" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
result | object | Results for the given search parameters. |
{ "items": [ { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "e2d22c4a11d318ee040fc761", "2830f7702ed087eb5a3c3474", "70e97e5efacd91c903b1b1a0", "0125572af1a118d09c46249a" ], "nodeLocation": { "x": 40585025.70647988, "y": -68060628.61353576 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "3d8f2a769ca8197c98388769", "90cd91ecc5d319c0b032a8ad", "258a97bcb9e9ccf4d5efd592", "96dc385d2ec6ec4b5f60dac7", "6677a236515f68eb2eb5ee8a" ], "nodeLocation": { "x": -44605205.59277232, "y": -10341891.602039024 } }, "error_handler": { "name": "childJob", "summary": "voluptate irure aliquip", "description": "esse", "app": "sunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/hnG/aM4FgSTc/~1/~1/~1/~1/k6+JeA" }, { "type": "encryption", "pointer": "/~0/~1/~1/~1" }, { "type": "encryption", "pointer": "/vhfC/r/eK" }, { "type": "encryption", "pointer": "/~1/~1/ti/stOZLWH" } ] }, "groups": [ "902ad105ab74b5b4803910b5", "da55ddd661545c477068bff5", "c905beb0651f21613f9e69a9", "9e650be698f919fd4a9ca275", "853e53d8b9903c4e60b28b9d" ], "type": "operation", "nodeLocation": { "x": -44750597.93416105, "y": -42745176.3769374 }, "deprecated": true, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "59bb444837053ce98b821b45", "8f3f0c5352030066b60c58d4" ], "canvasVersion": 3, "_id": "ddb8356d-2b42-c3bd-070e-d4a6b6fc1857", "uuid": "3956824f-a58e-8402-4686-6be781b8704c", "namespace": { "type": "project", "name": "laboris do", "accessControl": { "read": [ "Duis sed officia ad", "velit sit", "sunt Ut deserunt", "sit laborum elit dolor nisi" ], "write": [ "voluptate pariatur nulla aliquip cupidatat", "cupidatat enim magna", "incididunt dolore non est", "culpa ullamco deserunt", "nisi" ], "execute": [ "incididunt quis aute nulla", "Excepteur magna ea" ], "manage": [ "aliqua dolor non sed", "aute" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": 30606137, "errorHandler": { "type": "ex pariatur eu Ut", "name": "deserunt in anim" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "639c455b23fb2dbe3b46a8d3", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "4587d5948a113f5f99c1f2e4", "lastUpdatedVersion": "4.69.69", "tags": [ "laboris eiusmod", "sint in eu", "dolor", "est eu aliqua dolore pariatur", "deserunt nulla ea consectetur magna" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/l-g6R/Jq,BCY69DzD/~1/fa8IywSHW2/~0/gJVlWF.brKL/~0/~0/C" }, { "type": "encryption", "pointer": "/lF-s/Z980B/c/~0/~0/~1/~1/SOS+G1qQI3/bwS6Ws9t04" }, { "type": "encryption", "pointer": "/~1/TGU0s/~0" }, { "type": "encryption", "pointer": "/~1/~0/D7mqwOq/~0" } ], "migrationVersion": 51993697 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "adb025ae672ed3f5bc2324d2", "3e2ac29def1b6f9c1b06f73b", "ee4377e6f75e3037b4fbb814", "68548993cd99f67ada51abd7", "087ffc3fbe010ef4159859f9" ], "nodeLocation": { "x": 39741366.18074438, "y": -50045328.93636 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "1d4afab42b13de2295d3ede5", "ce7df237f1e4e2e559ed68bd", "6d5d28497bb671ff89be6a22" ], "nodeLocation": { "x": -9528781.634656847, "y": -57909227.049840204 } }, "error_handler": { "name": "childJob", "summary": "non consequat fugiat veniam", "description": "nulla adipisicing voluptate cillum aute", "app": "eu sed ad consequat amet", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/zIx,GqZn/~0/~1/BJ12mW,z/xSEw/axq/SXPlVi5/~0/GSqDNSy" } ] }, "groups": [ "9bd71d6416cc6d1dec68b3da", "524528adb67c07f27aefc6e8" ], "type": "operation", "nodeLocation": { "x": -65498.11470013857, "y": -94071084.56660925 }, "deprecated": false, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "6bab1b7f1e022f1f28e05760" ], "canvasVersion": 3, "_id": "c0a0072f-a60b-3d0d-2a8e-4bdea809191c", "uuid": "6b3e42cb-0c1c-9499-5ba3-d665fdcabace", "namespace": { "type": "project", "name": "commodo", "accessControl": { "read": [ "dolore", "anim dolor non qui", "aliquip ea est", "Excepteur quis" ], "write": [ "nostrud", "ad consectetur officia", "ad Lorem" ], "execute": [ "esse sit consectetur", "velit ullamco magna do", "ex ipsum anim dolor sint", "commodo dolor non" ], "manage": [ "nisi sunt cillum", "consequat Excepteur elit nostrud velit", "dolore", "Lorem consectetur ea", "amet aliquip reprehenderit ea" ] } }, "description": null, "preAutomationTime": 5000, "sla": 35652762, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "f9d685bf9c7e2ea9c09e73a8", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "72dec1572a2c1ada311831f9", "lastUpdatedVersion": "4.69.69", "tags": [ "Lorem amet", "quis elit Duis adipisicing in" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/sG/~1/~1/~0/eaxsNCK+hje" } ], "migrationVersion": 73971601 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "e738c54b6c02fd2fd57bf236" ], "nodeLocation": { "x": -17344133.85830918, "y": 14858078.545000538 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "3bbddf53d95e2895da199334", "b97f6cd78a12d06e4ef32021", "c216380e7ad9e6e182c33a3b" ], "nodeLocation": { "x": -1060227.9351384193, "y": 9247691.688928455 } }, "error_handler": { "name": "childJob", "summary": "non cupidatat quis et", "description": "ullamco Lorem laboris", "app": "exercitation do veniam", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1" } ] }, "groups": [ "9e93b37ef57f1bd7b1caa5ec", "d3260c29149ba2d24b333ce8", "e5b8d0fa7d7a2d6a43460039", "b3f6494db25106bec6ff6378" ], "type": "operation", "nodeLocation": { "x": -63176568.443401806, "y": -97824328.20040992 }, "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "error" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "3bb0c47ce894d9929c2cdeb8", "426e8451128c1e86a850fbf7", "af8aee6129fac4ee9f42f6da", "9cdf9d3128c73dcc2f5118bd", "a328072784056601863597d8" ], "canvasVersion": 3, "_id": "913f4780-011b-65bb-b602-80bfc32b9c93", "uuid": "ccbeb997-411d-481d-3963-1e3c49be002d", "namespace": { "type": "project", "name": "occaecat nulla minim tempor Excepteur", "accessControl": { "read": [ "cillum", "ex" ], "write": [ "anim Duis officia sint eu" ], "execute": [ "voluptate proident nulla in", "aliquip Duis occaecat" ], "manage": [ "in ut enim", "Duis deserunt ipsum sint", "reprehenderit qui dolore", "quis do magna sit Lorem" ] } }, "description": "Push Config to Device", "preAutomationTime": 250000, "sla": -5881762, "errorHandler": { "type": "Excepteur ullamco Duis veniam", "name": "deserunt ut" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "c57fb69d968e5c1c78769b8c", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "8d59121bdb200508e30f78a8", "lastUpdatedVersion": "4.69.69", "tags": [ "ut et sint dolor", "incididunt laboris id", "velit non amet", "occaecat dolor" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/CPg/~0/k/KQ" } ], "migrationVersion": 5654402 }, { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "0259994d81e71b84e8ce0593", "92746dba7b55307045689da4", "eb206728917751fe8a3750d5", "f9def99624897dbb29b195a8", "6be9a310a9a96bfde8b3dbcb" ], "nodeLocation": { "x": -66747059.1885515, "y": -29887501.697528854 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "1dfac9cb62a0e6664c877964" ], "nodeLocation": { "x": -8646556.02540192, "y": -24089360.454458356 } }, "error_handler": { "name": "childJob", "summary": "elit anim Lorem", "description": "laborum", "app": "Lorem in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/zGxs02fA/~1" }, { "type": "encryption", "pointer": "/~1/~0/h/~1/a,z0e/cw4za4JxRPK/FtqhVwj4GN/sDPMzj3" }, { "type": "encryption", "pointer": "/nj9uODujpZ" }, { "type": "encryption", "pointer": "/I8/CqAzNk/pacFJOHx/O/Dj5mawVt/~0/Ii+WGB/LGQSKpxBC/~0/~0" }, { "type": "encryption", "pointer": "/~1" } ] }, "groups": [ "8604304be93e101d1b074bfc", "0c50eab1ffb1fafeb2ac15a6", "c1c9e2de58ccdbf22f6e6484" ], "type": "operation", "nodeLocation": { "x": -28604182.52329491, "y": 672474.4050899297 }, "deprecated": true, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "62ecf781fa48eafd1d2fb32d" ], "canvasVersion": 3, "_id": "6b99ac3c-8d2e-aebc-5b6c-efc48112e59c", "uuid": "192a38b8-d1ea-dadc-c8ae-9de4ee9d4d55", "namespace": { "type": "project", "name": "in eiusmod", "accessControl": { "read": [ "minim dolore" ], "write": [ "fugiat", "ut ipsum exercitation", "commodo adipisicing anim ad", "quis enim ad", "ea" ], "execute": [ "irure deserunt id eiusmod nulla", "qui", "eu nisi labore" ], "manage": [ "mollit ut", "reprehenderit ut velit pariatur" ] } }, "description": "Push Config to Device", "preAutomationTime": 250000, "sla": -76057743, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "9b05cd3fdf8fd40e61fdecaf", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "b4cad866fa8bdee3e4c5d61e", "lastUpdatedVersion": "4.69.69", "tags": [ "aute Duis voluptate ad" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/~0/~0/~1/oWjqaB" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/yn/~0/~0/~1" }, { "type": "encryption", "pointer": "/D//~0" }, { "type": "encryption", "pointer": "/~1/gR4d/wkg/~0" } ], "migrationVersion": 83509210 } ], "total": 1394471, "start": 42729447, "end": 80863166, "count": 22781401, "limit": 96322263, "next": null, "previous": null }
{ "title": "result", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "workflowDocument" } }, "total": { "type": "integer", "description": "Total number of documents matching the given query parameters." }, "start": { "type": "integer", "description": "Search index of first document in the items array." }, "end": { "type": "integer", "description": "Search index of the last document in the items array." }, "count": { "type": "integer", "description": "Length of the items array." }, "limit": { "type": "integer", "description": "Number of results to return. Used for pagination." }, "next": { "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "previous": { "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] } } }