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": 25, "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": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "7e7eeb0accbdda9c07e256cc", "8bb50fcc963f8ec81e02702c", "8927fdd0ce09a1ba59402a79", "0ff996ae3fbd0ad4a95ee365", "c7260462de440273d28ee284" ], "nodeLocation": { "x": -66052854.77242191, "y": -53612071.85348347 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "90e2445820dda696117f2f82" ], "nodeLocation": { "x": 10282079.390421733, "y": 5524668.336476341 } }, "error_handler": { "name": "childJob", "summary": "est voluptate", "description": "consequat fugiat", "app": "incididunt deserunt tempor in consequat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/ormtPO/qvJ56yXUL9X/qln07oj0A/DrT" }, { "type": "encryption", "pointer": "/jW5/~1/i28M2Y9RrR/LP1-ZeakV6Y/Xg/~1/A6nPahy/ACEVBjAox" }, { "type": "encryption", "pointer": "/TASY/p/~1/Jc6TDSu/~1" }, { "type": "encryption", "pointer": "/~0/uvmZ7//SgO/~0/Yw+u9VbEN17/MVng/~1/~0/~1/YNYgux" } ] }, "groups": [ "59b816dd235ed69588bc842d", "1dc69bd26db4ea24ec31c143", "0d788c3c9eb7bbe10e2bec90", "9f75331297b5639a98354f02", "7e894b1cf9b03b8e317c6e97" ], "type": "operation", "nodeLocation": { "x": 19131983.430748403, "y": 45461397.20515782 }, "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "failure", "failure", "failure", "success" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "a1dcb03082828a5b35785217" ], "canvasVersion": 3, "_id": "813a2119-30f0-607d-2953-b385cd6058d2", "uuid": "b732c101-53d8-1e95-6b67-5dae32ab741f", "namespace": { "type": "project", "name": "ullamco dolor labore qui officia", "accessControl": { "read": [ "deserunt esse", "incididunt", "quis Excepteur", "ad elit est", "Ut" ], "write": [ "magna ut in aute", "dolore ut reprehenderit minim aliqua", "amet cillum culpa in sint" ], "execute": [ "nulla amet ut", "velit", "aliquip reprehenderit anim amet", "tempor laboris Excepteur Ut eu" ], "manage": [ "in in aliquip fugiat", "qui", "ex mollit et", "ad consectetur et sunt mollit" ] } }, "description": null, "preAutomationTime": 5000, "sla": -19639588, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "2976bd4e1b7bc431aa26986f", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "3585a0fbd110b8b1ffe5fc96", "lastUpdatedVersion": "4.69.69", "tags": [ "exercitation sint", "ex nulla labore sit", "in Ut", "irure", "elit mollit" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/~1/~1/~1/~1/~0/vZ1nEzvGD" }, { "type": "encryption", "pointer": "/~0/GtPFb,I,rs/~1/f7D2fj/i6e/i/V3Vd/~1/oo2QOi/ti6I1.L/GTZlT" }, { "type": "encryption", "pointer": "/qN35wwc/gCqSNi,k0/~0/vWL2uRdM/SLhpata/~1/~1/r/yy2h-E7aTbO/sY/~0" }, { "type": "encryption", "pointer": "/J/vtiw3dQ" }, { "type": "encryption", "pointer": "/~0/~0/~1/~1/u/~1/n/~0" } ], "migrationVersion": 70427757 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "3e20201add807f49dcd891a4", "d315d21b0604064313520680" ], "nodeLocation": { "x": 6918390.50432694, "y": 22590581.7722262 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "fd691064fd4d4ea866da7e4e", "228e27b0b932312cfaab5439", "25022f55a45905fc3c6a7c6b", "f03c8c397118337c3660a024", "61ae0c68cbbd35f672d58bbf" ], "nodeLocation": { "x": 49306067.53577185, "y": 21238843.181498364 } }, "error_handler": { "name": "childJob", "summary": "do", "description": "ut", "app": "sit incididunt eiusmod occaecat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/gpn,brhZnhu/~1/~1/~1/~1/~0/~0/~0" }, { "type": "encryption", "pointer": "/~1/~1/K98b7/t+/D1cxWyAsv/Vfi" }, { "type": "encryption", "pointer": "/zrp1CeSia/~0/X/~1/~1/~0/~0/~0" }, { "type": "encryption", "pointer": "/MuBK" } ] }, "groups": [ "67232629901edc71b6f9bd1d" ], "type": "operation", "nodeLocation": { "x": -39785046.66666529, "y": 46419736.02955368 }, "deprecated": true, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "a50377b6366298c316d70778", "3c5027aa21b9bc6ef2cdc079", "4f1b6b6958efe7a2bbf83398", "b0c0edce02c87b39be08a166" ], "canvasVersion": 3, "_id": "c9ce22ad-c15e-c7e3-8855-3776d2bf23e8", "uuid": "1a37ab15-4919-98ed-da3d-89a2b517a080", "namespace": { "type": "project", "name": "deserunt ipsum cupidatat officia eiusmod", "accessControl": { "read": [ "labore Ut consectetur nulla mollit", "laboris Excepteur ex in", "dolor quis", "velit adipisicing aliquip voluptate officia", "dolore adipisicing aute" ], "write": [ "est exercitation", "Lorem cillum commodo labore", "amet enim adipisicing eu sed", "culpa" ], "execute": [ "esse do occaecat reprehenderit", "ex exercitation in amet Duis", "mollit Lorem dolore", "eiusmod incididunt anim enim id" ], "manage": [ "in mollit deserunt est" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 250000, "sla": 45689753, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "b6afaabaa2ed2c1cce8e7d46", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "4ac86eadf00a6dbc50267c58", "lastUpdatedVersion": "4.69.69", "tags": [ "magna Duis", "ullamco dolor" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/zR7/gJDHxzI/~0/~0/~0/F/~0/~1" }, { "type": "encryption", "pointer": "/~1/~0/~1/hCJSD/~0/~1/rslmmB" }, { "type": "encryption", "pointer": "/~1/~1" }, { "type": "encryption", "pointer": "/xMiJ7/fyda6U/~1/~1" } ], "migrationVersion": 5530322 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "3ab2352cd9869553ffdda966", "a67e81eafd55d80fba9c61f5", "a42dbe4a5d9cb387caf89a5e", "f6260956a146c881a0c0a060", "e534010ca14d4a56ce2c19fe" ], "nodeLocation": { "x": -76199400.22785011, "y": -56300982.42809512 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "db51a7339599249f53c3f1a5" ], "nodeLocation": { "x": 4589914.703903511, "y": 14631123.133873507 } }, "error_handler": { "name": "childJob", "summary": "qui tempor", "description": "in", "app": "dolore elit non", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/M+A-ykhx/MUXV7Vt,G/t8tpFHDn,z/~0/Z,FS3" }, { "type": "encryption", "pointer": "/uSt,XJGwV/TYuOFL5aLaq/~1/mu" }, { "type": "encryption", "pointer": "/~0/~0/EvegWlQr" }, { "type": "encryption", "pointer": "/~0/~0/gKb-L/~1/S5NstKS/~0/~1/V49P/DwpB" }, { "type": "encryption", "pointer": "/~0/OWaG/~1/~0/~0/~1/wbm-k//Yvo/fTu8/~0" } ] }, "groups": [ "202f25cf59ce96d9c9ba810d", "71150183ba2e8b50c4a5dcf0", "0abdde7857894e943ce261e4", "66058ca387dea71a56ec7a31", "3afb3fd443ea2b5525183508" ], "type": "operation", "nodeLocation": { "x": 6555496.627154604, "y": 72472550.4390381 }, "deprecated": false, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "282ebdc4f233e914cb85b2aa", "17cdf129cdfc2d911f988a4d", "9faa12f234065f9cc89cb602", "a66d5db3ff3283437861ab1f" ], "canvasVersion": 3, "_id": "a4718c67-6c73-6f1c-e27a-72a48901f477", "uuid": "1706d84f-368f-6a45-af72-3f8cd3389d50", "namespace": { "type": "project", "name": "cupidatat exercitation reprehenderit", "accessControl": { "read": [ "sit reprehenderit adipisicing", "cillum ut aliquip culpa reprehenderit" ], "write": [ "laborum", "aute ex consectetur culpa amet" ], "execute": [ "ut", "ipsum elit", "esse aute commodo", "enim elit consectetur ullamco", "labore" ], "manage": [ "anim ut et", "sunt" ] } }, "description": null, "preAutomationTime": 250000, "sla": -88677828, "errorHandler": { "type": "proident id magna do", "name": "ad" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "8bd77a787ae92391396375cf", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "30ad3fbf1e162534e9e224c1", "lastUpdatedVersion": "4.69.69", "tags": [ "non velit commodo adipisicing sed", "aliqua eiusmod", "voluptate nostrud est ut" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/M/Lc4Xi7Ef9n/NY1/~1" }, { "type": "encryption", "pointer": "/~0/abh" }, { "type": "encryption", "pointer": "/kp380ITHHm/WtN9fzmvh/~0/~1" }, { "type": "encryption", "pointer": "/W6smn/~1/~0/nFg7tjR/6f" } ], "migrationVersion": 1615057 } ], "total": 17994106, "start": -88683519, "end": 98903261, "count": 65655879, "limit": 26465000, "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" } ] } } }