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": 50, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name", "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": [ "f32d8176c42422a3bd29404d", "b3518705d4c4e496b5e2d120" ], "nodeLocation": { "x": 82976965.88477367, "y": 23366727.05109772 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "ae822a350accdab4a11a62db", "d47f5e175b063e5436817d1d", "746cd90750dd8a171d83ded5", "0eacc38a2ca1e30016659e6b" ], "nodeLocation": { "x": 1950797.9799370915, "y": 91399222.5077905 } }, "error_handler": { "name": "childJob", "summary": "reprehenderit aliqua Ut id", "description": "aliquip", "app": "veniam elit Lorem nisi", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/y3B/lGi/~0/jMs,JoA/~0" }, { "type": "encryption", "pointer": "/~0/~0/~1/~1/~1/YZ0CESC2" }, { "type": "encryption", "pointer": "/i-5oTWPqt/~0/~1/~0/OYKPiBE/TQuTM6zF/~0/iMLI" } ] }, "groups": [ "fc27dc7b90c7c7168418f4b8", "6499275791e47359463d6dfd", "1a3e3d5bb9958f2488c6adbd", "a1a5ec8a3b8cba5e2a36d6b9" ], "type": "operation", "nodeLocation": { "x": -47619337.490464985, "y": 65650715.29953173 }, "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "success", "success", "error", "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "d2ee4b39f853be934c972c84", "77ed9d617c6206010683597b" ], "canvasVersion": 3, "_id": "ae5d5af4-8570-5f73-0873-4b9262e6bfdf", "uuid": "00f931e4-a7eb-8031-df61-ed17215e82b0", "namespace": { "type": "project", "name": "cupidatat ex aliqua proident Lorem", "accessControl": { "read": [ "cupidatat labore dolore", "nostrud" ], "write": [ "officia dolor tempor", "Duis", "qui", "reprehenderit ex cillum eiusmod", "in in qui" ], "execute": [ "reprehenderit culpa occaecat aute", "in sint nulla fugiat laborum", "fugiat", "esse nulla Excepteur culpa sed" ], "manage": [ "ex et" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 250000, "sla": 25849351, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "226f7ecb25b5e2eb486ca170", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "db3452338e76cb862742286c", "lastUpdatedVersion": "4.69.69", "tags": [ "dolor aute in", "incididunt sint aliqua ad", "Lorem nisi laborum" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/T9c7E8+Jjs/~1/~1" }, { "type": "encryption", "pointer": "/o+nmNLM6.1-/Z3AI4GGYS/ato6w/~0/~0/MSJ,9R." }, { "type": "encryption", "pointer": "/~1/hZABB4e/POkHwc/y8Of/mn4I/~1" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/n" } ], "migrationVersion": 9418646 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "76dc32dbfbe5f67d0680920f", "2b3dc4e6cd736e638fee2963", "15874e111eb55725845c1ca9", "6446995277e37b02cffcc895", "8d7b8a7d67274a787a7bf951" ], "nodeLocation": { "x": 63939726.505928904, "y": -34011445.90913901 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "8b60cc7398e6d5c8cfdeba6a", "14456875cb24ebcea2770e2f", "f1faa8a5f1ce9b34b871afa7", "ae7ff03c385c4a522b69fe5a" ], "nodeLocation": { "x": 14294583.061331868, "y": 85275175.02087858 } }, "error_handler": { "name": "childJob", "summary": "Lorem proident", "description": "Lorem irure pariatur tempor veniam", "app": "Excepteur in ipsum mollit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/LVOfm0Rbmh/~1/~1/~1/VG83202C./~1/~1/cuv7/cS8y" }, { "type": "encryption", "pointer": "/SXn/fAt3.4OxJ" }, { "type": "encryption", "pointer": "/sW90Ct7mA/vu./~1/~0/OZ1KotR/aYlwtl/~1" }, { "type": "encryption", "pointer": "/~1/~1/~1/~0/~0/U4+V+VX/MLSR/F/D" } ] }, "groups": [ "8d2ecb772193d6e26ddcb979", "fd9ffc6f49c5b480beeccdb0" ], "type": "operation", "nodeLocation": { "x": -62698253.11308801, "y": -63359225.23393585 }, "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "3df36225d7c37f4dd9998ea9", "752348a4cf49d06b11a896c4", "b28091a00080f9b8f0ead875", "1adf21910c59570dabc95d83", "b2f2592cf486959564569547" ], "canvasVersion": 3, "_id": "37edce90-024e-dabc-abb5-567ff718d400", "uuid": "a8247a49-da0d-8bfe-de59-0e84d6966498", "namespace": { "type": "project", "name": "cupidatat minim deserunt consequat", "accessControl": { "read": [ "occaecat enim quis dolor cupidatat", "occaecat" ], "write": [ "ut ut", "cillum nostrud", "irure nisi sit", "deserunt eiusmod", "dolore sed in tempor dolor" ], "execute": [ "et" ], "manage": [ "magna eu", "sed aliqua Lorem", "adipisicing nostrud ut dolore", "ad velit mollit consequat esse", "incididunt elit in" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": -3260685, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "e034966e8b23029d578a1db4", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "dae29d84b1679ba2c6070baf", "lastUpdatedVersion": "4.69.69", "tags": [ "culpa", "in eiusmod sint", "dolore", "incididunt dolor adipisicing dolor" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/Ejg/~0/x/~0/Odyub0ldY6l" } ], "migrationVersion": 83943535 }, { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "a5dc7c943c163aeb5bd0d655", "24f5ce9f7776c1687bfd12c4", "d7f0d673e370d320cf1f2971", "ba27ac932cab4fae6d9d14d5" ], "nodeLocation": { "x": -11893622.75535433, "y": -82781453.64920908 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "b98326694589ec2a1124f39b", "830c9a9defa9b3761af5ec3b", "94ec039b494d07abf6f0ee1b", "170b2d31b60fed776a593145" ], "nodeLocation": { "x": 36408891.155664295, "y": -31714566.605538994 } }, "error_handler": { "name": "childJob", "summary": "minim", "description": "occaecat", "app": "sed pariatur est ipsum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/Q2rAM6HB/Uv88ky,R,w/~1/R6cjkg5J/~1/LnKTWZI" }, { "type": "encryption", "pointer": "/io8g8aK9K+z/qRDn-,UM89L/xwK6/ooFx" }, { "type": "encryption", "pointer": "/~1/~0/oHysp/rXRhC5x8M/~0/~0/VDqY/~1/StRlfL0/vYtYr/~0" }, { "type": "encryption", "pointer": "/erL" }, { "type": "encryption", "pointer": "/fLFqmI/y+D/oISD3dgW9/~0/gCOIoznvWYv/~0/~0" } ] }, "groups": [ "77f319490aa5f6a522fc4da9", "b77132dd2617f55e202fbe14", "2ef211dbe8f4154ef4f47448", "8bf68a9863807764414d3126", "cbbe3ec8a949facef19aa217" ], "type": "operation", "nodeLocation": { "x": 78157604.03375417, "y": 29072700.51580797 }, "deprecated": true, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "a60004d247ec22e935a86363" ], "canvasVersion": 3, "_id": "d93c83fa-e03f-4804-b589-86237c434373", "uuid": "a29b4812-241a-59fb-fefe-171abfb62136", "namespace": { "type": "project", "name": "ipsum incididunt nulla occaecat", "accessControl": { "read": [ "ea occaecat eiusmod laboris", "deserunt adipisicing" ], "write": [ "deserunt do qui Ut", "magna commodo id ad", "consectetur", "laborum", "pariatur" ], "execute": [ "deserunt cupidatat commodo", "elit qui" ], "manage": [ "Excepteur in", "ex eu exercitation" ] } }, "description": null, "preAutomationTime": 250000, "sla": -16767688, "errorHandler": { "type": "ullamco sed ad laborum sint", "name": "elit nostrud" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "cc5a1630c96d7581ad378d3f", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "166efe1ebd63e83c070a3a71", "lastUpdatedVersion": "4.69.69", "tags": [ "dolore amet mollit laborum", "dolore in ad cillum amet" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/myy4p/UryI0R/~0" }, { "type": "encryption", "pointer": "/xu/~1/pk/~0/~0" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/~0/UdO7/~1/U/~1/Oeqib3x/C/~0/~0/f0fZvDbO3zs" }, { "type": "encryption", "pointer": "/~1/ffiM/rk/Z8g4Ab4/~0/~1/~1/ufLK71i/~1/~0" } ], "migrationVersion": 43906745 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "179bd902d292e06bee914a98" ], "nodeLocation": { "x": -92825408.73929346, "y": 28450018.604470536 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "98fe37b47b9dce6a8f8c346c", "b79ed307c8cc4394abc22b57" ], "nodeLocation": { "x": 41528234.20327106, "y": -64998115.0203411 } }, "error_handler": { "name": "childJob", "summary": "Excepteur cillum", "description": "voluptate culpa officia in", "app": "Lorem laboris", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Lokc3/.H/~0/BE7/~0/zsP/y" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/oxOyF/~1/oEQNeZWpnx./~1/e+lug/~0/hpIR6siU/g" }, { "type": "encryption", "pointer": "/~1/~0/~1/vH9r/~1/lgf1d/~1/~1/~1" } ] }, "groups": [ "6468a851865e3caf63531129" ], "type": "operation", "nodeLocation": { "x": 88272066.83501601, "y": -15074793.721943006 }, "deprecated": true, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "5ad5ae1098d6a8913deb9ccd", "f3908ba45544edf74653f6d8", "deb3594a84f5313878ef6982", "7fd4023feb7f43c1a54b9345", "eb1384c92604393d35ca24e1" ], "canvasVersion": 3, "_id": "3421e70c-7e64-4429-5d3e-b5d707331c17", "uuid": "b34a5a80-1530-c718-b332-0995458e04c4", "namespace": { "type": "project", "name": "nostrud nulla", "accessControl": { "read": [ "quis" ], "write": [ "mollit" ], "execute": [ "elit Excepteur Duis dolor", "et consequat cupidatat esse tempor", "nulla culpa dolore" ], "manage": [ "ullamco", "amet quis" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": 74902328, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "a36e23085699bc92c1ef6a8f", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "7f9d2a70da8de89703f791d4", "lastUpdatedVersion": "4.69.69", "tags": [ "cupidatat amet mollit dolor" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/eoAKTS/n,i/~0/BfbTMpNJ2/~1/~1/n6Wx0b" }, { "type": "encryption", "pointer": "/~1/IuJYBhSlkSp" }, { "type": "encryption", "pointer": "/~0/~1/~0/~0/~1/~0/~0/~1/MG/~1/xxlUIZmW," }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/vovk,8iA.X/d/~1/~0/~1/KlLlLFin/Z/~1/zrNHe/FGUj" } ], "migrationVersion": 46286927 } ], "total": -90001622, "start": -84384480, "end": -1968494, "count": -89220563, "limit": -89623607, "next": "enim sit proident", "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" } ] } } }