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": 1, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name,description", "exclude": "_id,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": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "b5b33c7346132ba6272e6304", "886334b007940af71e6ffcce", "61a0e6d0c0e4584a33bf6d94", "5a42b7f315b29be2811eb82d", "8e7b3d95b50970af878b8b96" ], "nodeLocation": { "x": 31559612.78277269, "y": 48653849.43836895 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "34e4bb6adf7903d95868141d", "382d87c12039fbe71b08d4bb", "b12831336d56398ad523d7dd", "b1f1f7441702c0867b62cb54" ], "nodeLocation": { "x": 12581969.2612191, "y": -3969242.955763489 } }, "error_handler": { "name": "childJob", "summary": "magna reprehenderit", "description": "irure nulla", "app": "qui ex", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/~0/iVYmDQ6b/~0/~1" }, { "type": "encryption", "pointer": "/M" } ] }, "groups": [ "a359a7b888412fbca1a92132" ], "type": "operation", "nodeLocation": { "x": -94473047.89424944, "y": 72636935.64799097 }, "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure", "error" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "c01226e8bef45522e0094803" ], "canvasVersion": 3, "_id": "b1007110-2e6c-039a-5065-ed6d92daf18a", "uuid": "e99170dc-73d3-e4a9-b959-02b3572d3ceb", "namespace": { "type": "project", "name": "culpa qui in dolore", "accessControl": { "read": [ "anim sit", "sed nisi", "sint nulla esse", "nostrud fugiat laborum", "sunt est" ], "write": [ "laboris pariatur ea", "adipisicing qui labore" ], "execute": [ "in", "in cupidatat nisi labore occaecat", "dolore dolor culpa amet ad", "nulla minim" ], "manage": [ "nostrud labore aliquip ipsum culpa", "pariatur exercitation", "reprehenderit Excepteur incididunt" ] } }, "description": null, "preAutomationTime": 5000, "sla": 15534794, "errorHandler": { "type": "est nisi non Duis", "name": "eiusmod sint" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "c2555f08bc77856e7d9b319d", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "41dfabc844c8e46f06b6a009", "lastUpdatedVersion": "4.69.69", "tags": [ "labore in", "dolore mollit in aliqua voluptate", "in fugiat magna", "elit voluptate minim cillum commodo" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~0/O,5Lnu/~0/LnXghq//WdIEiD5xDd/r,QHRnASzow/~0/wY" } ], "migrationVersion": 3068589 }, { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "66df6412b67592b6993bb798" ], "nodeLocation": { "x": 46327962.74401766, "y": -45601616.11557927 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "1b7b400f49b36ded801f9a1b", "64d2b34e3748ca93309167cf", "28fb8fa859d3c960e576ba4e" ], "nodeLocation": { "x": -56895306.726656616, "y": -28743801.751342565 } }, "error_handler": { "name": "childJob", "summary": "aute dolor laboris voluptate sed", "description": "et", "app": "amet pariatur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/fAn.AH5TH/~1" }, { "type": "encryption", "pointer": "/~0/qcLVtI/krDC+xfi/GgaT/~0/F0/D6,/~1/wxFSN8-r/dl/Dn9tp" } ] }, "groups": [ "caaabe4cd947993cd46f5fa4", "0d3df1e3dff8e080672dbce8", "270e3d5554d6c98efaed0c1e" ], "type": "operation", "nodeLocation": { "x": -8258616.217097044, "y": 96690051.04937974 }, "deprecated": false, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "6b71446e859496e4fbf31152", "31a82960afe411ae53ab9083" ], "canvasVersion": 3, "_id": "2f2b6dbe-044c-6452-fff7-b71be511df65", "uuid": "89924aed-4c52-9b85-c97d-2cab3cfd4127", "namespace": { "type": "project", "name": "exercitation in ut tempor", "accessControl": { "read": [ "mollit id Duis commodo", "in", "exercitation non", "ea", "Duis" ], "write": [ "commodo mollit est in" ], "execute": [ "laborum veniam magna", "in dolor minim" ], "manage": [ "eiusmod nisi", "esse sint ut qui ad" ] } }, "description": "Push Config to Device", "preAutomationTime": 250000, "sla": -93816392, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "b71afe2842888f09b0d630d3", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "1a51e59816bd6d98fb8e1f1b", "lastUpdatedVersion": "4.69.69", "tags": [ "do consectetur culpa", "tempor minim pariatur", "dolor commodo Ut anim ex", "ullamco ut consectetur nostrud" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/B/DwBt/aW/BtIQk8iO/~0" }, { "type": "encryption", "pointer": "/K,WWl7vmS,/mKzCjLBr4/zV2bU-xFZT/~0/FvEboE1G6/~1/~0/~1/S-g1n26/~1" }, { "type": "encryption", "pointer": "/~0/~0/~0/zn4V/~1" } ], "migrationVersion": 55320998 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "f539a5fa0058ff98da267bdb", "a12c43651931d6d2793eb653", "aa73a0ece4b0c2996029cf25", "8939f6716630d3e61bd8bb50", "8127d9b12571c6fe559b7ef6" ], "nodeLocation": { "x": 46020569.22358525, "y": -5386188.344171345 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "887030dcff8ddd6369597eb2" ], "nodeLocation": { "x": -85969789.22677083, "y": -12447177.109371886 } }, "error_handler": { "name": "childJob", "summary": "culpa sit deserunt eiusmod anim", "description": "ullamco est Excepteur", "app": "Excepteur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/LHD+IRoien/~0/qBpB" } ] }, "groups": [ "205c738591a0ca356bf38d35" ], "type": "operation", "nodeLocation": { "x": -72861971.01513867, "y": 39195740.08075917 }, "deprecated": true, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "92de6090f2fe2d1d550cec64", "4d890ee5bbed24bfd62a490b", "94cb43c2ae5de7bfc5b9b162", "1d21dbcff07be0667608c1f1" ], "canvasVersion": 3, "_id": "c07c730c-c967-f7fe-7efe-a85f983e6c62", "uuid": "510e4dbe-ff58-8f1f-c423-63173ae0afd2", "namespace": { "type": "project", "name": "fugiat", "accessControl": { "read": [ "reprehenderit aute velit dolor quis", "fugiat deserunt", "cupidatat", "reprehenderit commodo dolor culpa ad", "elit occaecat consectetur anim" ], "write": [ "dolore aliquip", "nisi" ], "execute": [ "dolor deserunt dolore commodo", "id eiusmod ea", "dolore Excepteur", "laborum aliquip ullamco cillum", "aliquip" ], "manage": [ "magna" ] } }, "description": null, "preAutomationTime": 250000, "sla": 97418231, "errorHandler": { "type": "nisi esse", "name": "nulla" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "4ae546dce33c680b0f2a5bed", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "2b72c5cd0017115a3ea98f52", "lastUpdatedVersion": "4.69.69", "tags": [ "do pariatur ut" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/c-Qqry1TE" }, { "type": "encryption", "pointer": "/~1/~1/~1/~1/~0/i47M4tgM/~0" }, { "type": "encryption", "pointer": "/~0/Av-uHDb/~1/~0/cqSw/~0/nMd/ng5nD6OL/~1/Fu5Td,g+r/~0" }, { "type": "encryption", "pointer": "/fQs/~0/~0/~0/~1/lDY13c7xC0r/d/cioauF+MNL," } ], "migrationVersion": 617710 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "89c3a4fff0d3b7d9d565f8cf", "f86f115e78f6544f734fae50", "ff91266b301dbaa2f64f9943", "53d914ae09a612b74b4e87a7", "e629e1a6a5d6445463db85d0" ], "nodeLocation": { "x": -98369427.08748269, "y": 10777691.97056906 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "89b60365a6d6973e77c581d2", "5c7ad0da84741f8dc6e018db" ], "nodeLocation": { "x": 12896130.187686741, "y": -73002295.55410999 } }, "error_handler": { "name": "childJob", "summary": "non", "description": "labore tempor do occaecat", "app": "veniam reprehenderit voluptate officia enim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/Gn.8BmOxjo/v+/~1/l2mJPXiGTSS/~0/O0/~0/Bqh6UynT/~0" }, { "type": "encryption", "pointer": "/Iz/~0" }, { "type": "encryption", "pointer": "/~0/~1/k6I-lo5/~1/T-Gc/Va5-/U9cn/dEXhTn/nhistuNb/aeds/Bsmyolic" }, { "type": "encryption", "pointer": "/~0/HQS/~1/~0/~0/Hr3" }, { "type": "encryption", "pointer": "/~0/~1/N.bql/nzAEoLKp/~0/~0/~1" } ] }, "groups": [ "6b8e64bbf25a0db4f66b1a72" ], "type": "operation", "nodeLocation": { "x": -95132561.48039004, "y": 34448963.90950048 }, "deprecated": true, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "9a9760c93dbe0e8905d788bf" ], "canvasVersion": 3, "_id": "07510bc7-c02b-6caa-8730-21792084f8e4", "uuid": "ac15f5b9-9dbb-4224-6637-71e9f0a807dc", "namespace": { "type": "project", "name": "proident ut anim do Excepteur", "accessControl": { "read": [ "culpa fugiat eiusmod magna in", "nostrud qui", "ullamco in nulla", "est elit eiusmod commodo in", "sunt magna" ], "write": [ "mollit ea", "dolor consequat in proident pariatur", "Duis anim enim occaecat", "exercitation" ], "execute": [ "ipsum qui", "consequat nulla dolor", "ea", "esse ad tempor qui velit", "exercitation velit incididunt" ], "manage": [ "reprehenderit", "velit ex eiusmod dolor", "enim consectetur exercitation", "qui laborum minim in sit" ] } }, "description": null, "preAutomationTime": 5000, "sla": 77940165, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "e97c28b1589e24fe3a884306", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "6c36e083121ca9e4a0f85583", "lastUpdatedVersion": "4.69.69", "tags": [ "id tempor do", "enim adipisicing" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~1/pY6/D.Uxg/~0" }, { "type": "encryption", "pointer": "/iv/~0/DNRGXHF/~1/~1/~0/XJGjcs/tdJ6CcXFrc2/~1/Wh/~0" }, { "type": "encryption", "pointer": "/~0/T/WIxE+/~0/SF,,RKK2cw/a/J2W/nC3g9/-/UDjHx/BMc5RsGm3" }, { "type": "encryption", "pointer": "/~1/~0/kNThyNI/~0/~1/Z8.6kbELG/Mq,/F+dB9/~1" }, { "type": "encryption", "pointer": "/upF2LCU/Pln5Gglt7" } ], "migrationVersion": 41101156 } ], "total": 67506345, "start": 39643647, "end": -80629338, "count": 76115425, "limit": 34855851, "next": "magna qui velit nulla ex", "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" } ] } } }