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": 1, "skip": 0, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name,description", "exclude": "_id", "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": [ "b28b6832f9959cad8cb7b8fb" ], "nodeLocation": { "x": 36681712.46671113, "y": -78628964.77840441 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "8fb7646ef910ffb08ea549d6", "97041eb3bce9c3b7a9afb986", "d25e5b4acd0f4981c80e3be1", "02998f3bfcc70294c63bb8ea", "3c3b4cba7d326b6d6caaaa43" ], "nodeLocation": { "x": -90256380.21403255, "y": -95638016.20258312 } }, "error_handler": { "name": "childJob", "summary": "proident sunt dolore", "description": "commodo", "app": "laboris eu mollit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/NVF+S" }, { "type": "encryption", "pointer": "/~0/~0/~1/~0" }, { "type": "encryption", "pointer": "/~1/~0/~0/~1/~1/JO1txuIw/j/~0/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1/~1/~0/~0" }, { "type": "encryption", "pointer": "/Vx8sW/O/~1/Otn-oPjIDOW/~1/CwU9gj42/~1" } ] }, "groups": [ "3edb1c727ded9f2a05d7d500", "5312e4586929120fe63a1232" ], "type": "operation", "nodeLocation": { "x": -89321306.47682746, "y": -79057690.02155085 }, "deprecated": false, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "4a29a33fa20d811521ebc89d", "50e57d6f121c5a68a2266e3e", "f4d5870ea60b433b51de4a02", "33e394c1fa2c7e60e1dbd5e8", "b007fbaade6fe1f53621ae52" ], "canvasVersion": 3, "_id": "fb2887a6-3786-97de-ba4c-83fb86e5d3dc", "uuid": "855adf5f-7af0-1e3f-d719-bf1560630286", "namespace": { "type": "project", "name": "ut laboris in dolor enim", "accessControl": { "read": [ "et tempor non ut Lorem", "qui nostrud dolore occaecat nisi" ], "write": [ "veniam ipsum in qui laboris" ], "execute": [ "esse aute ipsum eiusmod", "elit proident cupidatat", "anim ad laboris eu amet" ], "manage": [ "Ut ea nisi anim", "amet sunt ullamco id aliqua", "culpa dolore commodo magna" ] } }, "description": "Push Config to Device", "preAutomationTime": 250000, "sla": -49823750, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "496a06dcb89df4869e7f630a", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "47b7436efe2bcdb5ce812fac", "lastUpdatedVersion": "4.69.69", "tags": [ "dolor labore ullamco laborum laboris", "incididunt enim", "consectetur aute sint reprehenderit dolor" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/Vv5HRYU/zr.tm92f/I/..C7W.Fhy" }, { "type": "encryption", "pointer": "/~0/wv,t3m,/gU" }, { "type": "encryption", "pointer": "/cnZ44f/~0/Jt6Hu6-Pa/v/perA0ZWUI/~0/~1" } ], "migrationVersion": 18401472 }, { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "7f2fc0042d83b429f550a0b9", "17ed1b3a6088b634e2b8fd06", "f30f859e7e92c8cfaad31a41", "4d0880a436ef8a869a902da4", "df66da094f22c794a9c6de59" ], "nodeLocation": { "x": -98602736.46597251, "y": 59835105.53669444 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "1bd3f1b3230152ee16a1f1b3", "b125bacb0460f0172cb5c1e2", "489f8e0e64aff8181f7d60f0", "0aa8cce0c39b7038464616e2" ], "nodeLocation": { "x": -60003228.262017496, "y": 5245578.01576595 } }, "error_handler": { "name": "childJob", "summary": "sunt sed", "description": "pariatur cupidatat laboris deserunt", "app": "fugiat mollit dolore in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~0/o27NEy/~1/~1/PcRJqnZjeh/~0/~1/bybmelPOG/b-di2c2A" }, { "type": "encryption", "pointer": "/~1/cIBS8UtXeR/~0/C/vtDC3MOxh9/v" }, { "type": "encryption", "pointer": "/~1/~0/~0/~0/iRmc-hg915a/~1/~0/g65S/jxBqX/~0" } ] }, "groups": [ "8871735b2cfec51f7d389365", "037dd3c02f0d8ec80f62380c", "c4d21aa776d8d54b848ce436", "2e81f83ad80a92804fcaf9a5" ], "type": "operation", "nodeLocation": { "x": 35039142.6057488, "y": 33003386.818197817 }, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "success" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "a82215ec9597cb5260bcf6c4", "eb3009fbf4fedead35961380", "4c0bc11f156c1308bdeb8935", "3c9fb63cba506eb2ff82ccd7", "5ef5f8c0c9d54493852e6b88" ], "canvasVersion": 3, "_id": "2c51f80b-2a32-3192-05bd-3b3b25b7f071", "uuid": "100fe9a0-4832-4bf9-1264-176436fd1c9f", "namespace": { "type": "project", "name": "sit id", "accessControl": { "read": [ "tempor occaecat dolor aliqua fugiat", "cupidatat", "ea", "dolor pariatur", "eu sit" ], "write": [ "est fugiat elit" ], "execute": [ "eu in", "nulla voluptate enim Duis reprehenderit", "fugiat eu" ], "manage": [ "magna ipsum minim dolor", "aute tempor occaecat laboris", "Duis amet" ] } }, "description": null, "preAutomationTime": 250000, "sla": 5053663, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "0fbf2a1fd90cda03cc790579", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "e28eede56fd1f38aa860e8a0", "lastUpdatedVersion": "4.69.69", "tags": [ "ut", "magna cillum", "Duis fugiat laborum enim irure" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/lY/~1/cxF4zS7vm/1/~0/G,ca5/rj/LzVY-iOs//" }, { "type": "encryption", "pointer": "/QIqZm9zDX" }, { "type": "encryption", "pointer": "/~0/~0/Hy/GIE/~1/YKL5w42K/VlHtBZ7f/~1" }, { "type": "encryption", "pointer": "/~1" } ], "migrationVersion": 54105304 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "45a812a80cdd3541db6ed8b9", "42697b43f5fbc6baea12e692", "61394182e282a453e1f626c4" ], "nodeLocation": { "x": 59041888.27548823, "y": -83690204.7291483 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "ee117de3fe66381bf6b6f1ef", "5a346142ea5519fba9a251d9", "0b5ad6001332a38b528c15fe", "722028c63dd60081bbb86e0a" ], "nodeLocation": { "x": 97239892.43685412, "y": -87043519.8490489 } }, "error_handler": { "name": "childJob", "summary": "laboris cupidatat occaecat sit Ut", "description": "ut velit laboris Lorem aliqua", "app": "deserunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Zt/vKD/O0/~0" }, { "type": "encryption", "pointer": "/SacyUr28/vI/~1/b+/~1/P/Hlp6/G/spAik9V/~1/Hs1HY.ht/~0" }, { "type": "encryption", "pointer": "/~1/~1/~0/JK1ZLLIA/P7Hg/~0" } ] }, "groups": [ "c3ced2bb1080a9cb2363f9fb", "e3a0b721e99feddd3cc04a97", "8472f803f6e6bf87c1d2b64b", "f5c3558a06e38a7680aa9148", "a5ae4c8da7430008948a48e9" ], "type": "operation", "nodeLocation": { "x": 20541243.005166084, "y": 22608941.542504817 }, "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "success", "failure", "success", "error" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "cb4498a177f91862667f022d", "86866dd07f116a5f13e2eed6", "5f61e4242cb5f0800b54aec1" ], "canvasVersion": 3, "_id": "f105383f-0776-1714-445a-199ee736e2e3", "uuid": "9473b1da-7714-a712-7116-03189e80b352", "namespace": { "type": "project", "name": "anim esse in eiusmod in", "accessControl": { "read": [ "sint deserunt minim enim", "id minim", "nostrud" ], "write": [ "laboris ad", "proident" ], "execute": [ "cupidatat" ], "manage": [ "occaecat mollit", "commodo consequat labore" ] } }, "description": null, "preAutomationTime": 5000, "sla": 13077649, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "99bf3f24611e36d1bdc0d2a6", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "4edcc9c07a8a325d0928cce9", "lastUpdatedVersion": "4.69.69", "tags": [ "voluptate dolor", "dolore sunt minim magna" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/~0" }, { "type": "encryption", "pointer": "/~1/fOfn1youQ/~1/YR,.T.fNy/~0/Fe/~1/WplpjUpE/~1/qe/~0" } ], "migrationVersion": 11730238 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "1064b9b8f4c01ba2932df966" ], "nodeLocation": { "x": -27937911.73645225, "y": -69935630.73977289 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "99b52a86e33bd199331cad6f", "a1377c783199503998031c8b" ], "nodeLocation": { "x": 50233635.7133362, "y": 81768045.27468184 } }, "error_handler": { "name": "childJob", "summary": "sunt", "description": "esse", "app": "exercitation sit minim culpa", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/~0/~0/tGzP/~0" }, { "type": "encryption", "pointer": "/X8AwZuAUK/~1/~0" }, { "type": "encryption", "pointer": "/M6U+qsEoo/~0/~1/HlVMzQ/2xF/~0/~0/~1/~0/OJUZr8/KcGaS4gzb/dU41" }, { "type": "encryption", "pointer": "/L/it/v.+Q8SgZ70V/~1/dcQimSINq/~1/~0/kexq+,.0d/~1/rU/+0aY/~0" }, { "type": "encryption", "pointer": "/HGv/XQkzD0yMu/jNw5BKO6/~1/~1/xNMD7.J/e/MZy/V4IwM/CPrX/~0/~1" } ] }, "groups": [ "3ecd7249ed7928d929b9345b", "102e190fb6d9e2ec000d616f", "5355756e88fff5d15a006e70", "25ccac70870b1d6ecab486c6", "7ec9e373c89e2bac54529456" ], "type": "operation", "nodeLocation": { "x": 83315511.99955887, "y": -7752792.3271877915 }, "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "0f0e010eb5298638c2af4fef", "954c634ae6d9d0a5547a2d8c" ], "canvasVersion": 3, "_id": "ca75e7db-33f7-3b12-2de7-2f2dab17b270", "uuid": "8bc53359-1d1a-0e87-b153-ff491afb1d41", "namespace": { "type": "project", "name": "aute fugiat", "accessControl": { "read": [ "ea veniam" ], "write": [ "et veniam occaecat", "exercitation", "commodo cillum elit", "aute dolor officia" ], "execute": [ "magna in labore adipisicing in" ], "manage": [ "commodo deserunt tempor sint", "id fugiat esse adipisicing laboris" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": -79284313, "errorHandler": { "type": "Duis cillum", "name": "eu ipsum" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "f892d8621ed4de4a14101861", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "e1833be021666d11308a0056", "lastUpdatedVersion": "4.69.69", "tags": [ "sint qui do aliquip voluptate", "anim tempor", "cillum" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1" }, { "type": "encryption", "pointer": "/NfL+GP/FtU/H/~0/xmk3b/VMl/z+q/~0/~1/~1" }, { "type": "encryption", "pointer": "/~0/X1/~0" }, { "type": "encryption", "pointer": "/~0/Ey0hipIj4+e/ZZ/UK/aJDVo46c97B/We5Qq/~1/~1" } ], "migrationVersion": 14024617 }, { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "6182926ee386669b2510b742", "4712bf59fa4f43e978914f44" ], "nodeLocation": { "x": -30524018.594555676, "y": -38845644.166301474 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "c8b93a03dc1a7d2970e2c63c", "f676703fb3fe8614d7118611", "6982993fe333a7d6d0ba8d03" ], "nodeLocation": { "x": -43518802.29449887, "y": 44192865.782045215 } }, "error_handler": { "name": "childJob", "summary": "sunt minim ut commodo", "description": "dolor ea Ut", "app": "occaecat dolore aute mollit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Sd7/q/~0/~0/OtA/~1/l7Jicihr1W/~1" }, { "type": "encryption", "pointer": "/~1/Rf9NNqp/~1" }, { "type": "encryption", "pointer": "/c/1xxlCd/~0/~1/~1" } ] }, "groups": [ "007676dee329f297511db4f9" ], "type": "operation", "nodeLocation": { "x": -16813017.682411686, "y": -13222681.839989021 }, "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "failure", "failure", "failure", "failure" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "ec7cefed90d7c0f370123cde", "2805b8152319c74e537523fa", "deb52a63c3a8e7cfd69dc64f", "ab4d03f80ef1bde47515edb7", "2f3149ca8103c2fdad1b1182" ], "canvasVersion": 3, "_id": "a417913a-0f58-18e2-d49c-a7d686ec85e9", "uuid": "05da251e-c460-b407-d740-0a434ea9424c", "namespace": { "type": "project", "name": "ad quis elit", "accessControl": { "read": [ "commodo amet", "eu non sint", "deserunt aute irure eu", "officia et ullamco", "culpa minim qui pariatur mollit" ], "write": [ "exercitation", "laboris culpa ad", "minim amet adipisicing qui", "anim in Ut", "enim non eiusmod ad" ], "execute": [ "proident cillum Excepteur aliquip", "aliquip ipsum", "quis non sed", "sit ex ut do dolor" ], "manage": [ "Duis dolor", "tempor nulla aliquip anim in", "cupidatat eu sunt in" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 5000, "sla": 4951949, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "1a2259b7d652b196716997c1", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "05a12c1393e2260dea976b73", "lastUpdatedVersion": "4.69.69", "tags": [ "officia", "anim nulla", "elit culpa enim exercitation esse" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/hdE09QgF/~0/~0/xQS/P+Cj/F" }, { "type": "encryption", "pointer": "/fEZXQ/g-V/LN/~1" } ], "migrationVersion": 66704043 } ], "total": 15798305, "start": 87772842, "end": 95223966, "count": 73837015, "limit": -73048305, "next": null, "previous": "proident sint nisi" }
{ "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" } ] } } }