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": 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": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "4c1399ab71259cb8c05a428a", "6325e60e69340621a740d01d", "560c15b8bc0e0bc5aba56ada", "41fcbebea21a101a44246471" ], "nodeLocation": { "x": 89684236.5179599, "y": -34836390.39153461 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "7736a9b9ad96ca2163c4886b", "767f73e22407566ef64d26eb", "efe510a40503de92898256f9", "fd6e81865841098806b8da4e" ], "nodeLocation": { "x": -62558621.291239634, "y": 60088243.19227582 } }, "error_handler": { "name": "childJob", "summary": "ex dolor aute aliqua", "description": "labore sit dolor ea in", "app": "nisi ad ut culpa", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/BSbn7/sTH1xLv/BEe8zuO/T/PC/F+HTvqO8/OhZ1HxEhVR/VFANroUtnPK/~1/uAS,y6lC" }, { "type": "encryption", "pointer": "/~0/~0/~1/cbNP53-uH,+" }, { "type": "encryption", "pointer": "/~1/~1" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/Gk2J.XRo/PmW/p.c/~0/hKDTRmgDf" } ] }, "groups": [ "9849a485b8c74b71f60ed7d0", "afc962c21fb6ae1e63dc287b", "7d53440c8f00ed6d0f0aefa7" ], "type": "operation", "nodeLocation": { "x": 30520853.745225012, "y": -87546022.8728389 }, "deprecated": false, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "7b841d84175b708a85560324" ], "canvasVersion": 3, "_id": "1b0454b6-4193-3f9d-678e-3c6675f54988", "uuid": "ea0a8fac-edf6-c417-68fd-bc1b11a21ebe", "namespace": { "type": "project", "name": "aliqua fugiat est", "accessControl": { "read": [ "do irure velit occaecat tempor", "reprehenderit esse", "id consequat" ], "write": [ "laboris et consectetur dolore", "aute", "id" ], "execute": [ "nisi mollit voluptate ut", "nisi cupidatat id qui culpa", "dolor nulla", "mollit dolore", "magna id laborum" ], "manage": [ "deserunt reprehenderit" ] } }, "description": null, "preAutomationTime": 5000, "sla": 575432, "errorHandler": { "type": "mollit et ea", "name": "elit aute" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "348bcf6d8d35b591910da15f", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "374ad2a2f4f1d356c7ce7e6a", "lastUpdatedVersion": "4.69.69", "tags": [ "cupidatat consequat dolor eiusmod aliqua", "ea", "culpa deserunt magna ad est" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/W1Ihn/xcv+" }, { "type": "encryption", "pointer": "/~0/KPBj/~0" }, { "type": "encryption", "pointer": "/~1/Pjgb/Dv/kD/~0/b/~0/yz1lb." } ], "migrationVersion": 11211869 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "f3937d42951be249a7d954a7", "4200c41ab8b391faf7a09981", "4c80c4f097e9fdf19fc96779" ], "nodeLocation": { "x": -38683323.42782295, "y": 99627955.55979112 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "8ae432924b0939592bcae124", "d8700bb4be7bd1ea6a1d809f", "819d60677aaf383461d05080" ], "nodeLocation": { "x": -57547878.040246524, "y": -45560534.151558496 } }, "error_handler": { "name": "childJob", "summary": "laborum", "description": "voluptate veniam consequat cupidatat ut", "app": "laboris elit ad in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/rsDb4cBft/~1/m/~0/X./BaH1/t/i/~1" } ] }, "groups": [ "d56e889c29c935b7c83c179a", "5aa46bf6b48fc1a273182c01" ], "type": "operation", "nodeLocation": { "x": -66774208.424525484, "y": -83383397.95841673 }, "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "error", "success", "error" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "698e599b2898a2019fc79ff8", "d60f7ded46adbb5090e2afaf", "fbbc27062d0c8361be6c79c6", "84f6cbd4dda58a56d553c781", "9aae22baef5a2f42251cfdcc" ], "canvasVersion": 3, "_id": "1c39861b-1069-1f14-5287-0f1715f054fa", "uuid": "98aba217-6d9f-c02d-0819-440106c385e5", "namespace": { "type": "project", "name": "quis ad do", "accessControl": { "read": [ "nisi minim aute ex", "sint", "nulla ullamco", "ut" ], "write": [ "non cillum", "dolore dolore magna" ], "execute": [ "tempor enim mollit Lorem", "nostrud", "nisi ea in irure culpa", "incididunt eiusmod", "cillum" ], "manage": [ "deserunt Excepteur" ] } }, "description": null, "preAutomationTime": 250000, "sla": -26984714, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "b875eb3c3a1e4952aaba9921", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "5d52ca10433bc05521fff02a", "lastUpdatedVersion": "4.69.69", "tags": [ "non", "amet minim aliqua" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/JUAOTiB/YEFQnN.BShY/~0/~0/Pxs/K/GxUDj-E/P8Y/~0" }, { "type": "encryption", "pointer": "/io/-UE/qLaibFuo/aVz.+xjK8/~0/~0/~0" } ], "migrationVersion": 95456556 }, { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "54f7f90c9bbe515946498a31", "af2a21b08573dcae9311beed", "ed7aa6aec321e8318ad60151", "9bb8c62e8e984ee7aff899ff", "4c80832a569b01ae7e8c4c0a" ], "nodeLocation": { "x": -37694000.55388412, "y": -85983785.67352808 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "4b4672492125e38db2cb881a", "e7aca7b5333d6de95ea17508", "d0074a13db8d9514e0fe6d0c" ], "nodeLocation": { "x": 1595095.2335228622, "y": 23201886.227402106 } }, "error_handler": { "name": "childJob", "summary": "elit fugiat in", "description": "nulla in ullamco enim dolore", "app": "magna cupidatat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/Nrnt/kpHy/BKW2u+nR/Kdy7fWyJn" }, { "type": "encryption", "pointer": "/LUj2Bagsngv" }, { "type": "encryption", "pointer": "/pex41C+p+fq/pc2Dpe/~0/~1/cKDfhx8p/Y/~1" }, { "type": "encryption", "pointer": "/L.l6d" } ] }, "groups": [ "c2219162cb5e7a1cc2610bf0", "d2e2f2d4d26390692a3f89fc", "1d98db7402a867b7595c72c9", "cccefadcda65cd8c8fc6ef4c" ], "type": "operation", "nodeLocation": { "x": -47006390.729632266, "y": -27675045.341920957 }, "deprecated": false, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "f64ab0fbded55d62ecc92230", "d9faa46807cfb8f5d1a29c96", "778ac10daed1e05e0d32a118" ], "canvasVersion": 3, "_id": "c0ee14b5-24bb-72b3-ed2d-310100e43329", "uuid": "332371ed-652c-dd96-449a-99d225e33e81", "namespace": { "type": "project", "name": "laboris aute enim", "accessControl": { "read": [ "elit irure do" ], "write": [ "ut", "veniam", "magna sunt minim" ], "execute": [ "Excepteur sunt", "exercitation do" ], "manage": [ "dolore aliquip consectetur reprehenderit" ] } }, "description": null, "preAutomationTime": 250000, "sla": -47389982, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "9387d614763e936582df0224", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "0050eb51a3aeaf09d2259a91", "lastUpdatedVersion": "4.69.69", "tags": [ "sint", "aliqua eiusmod Excepteur do", "ut" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/mHSMhA/IoMeN/Ks7YTzG/Ik9x2A/~0/p,F36tY/~0/~0/~0" }, { "type": "encryption", "pointer": "/fYfD3q5,hMO" } ], "migrationVersion": 23997881 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "40304226e3dc9b172a712a21", "fad4b8adfae71431667fd5b5" ], "nodeLocation": { "x": 43733564.78164342, "y": -91844952.18819615 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "c81b3908fd02aeaceeabda7c", "8970823f05d6e4e327ab8d60", "e36d4f583e1e1148571e6886", "b8d51ce8a064bcf82124d56d" ], "nodeLocation": { "x": 85557780.03952122, "y": -66767324.9408689 } }, "error_handler": { "name": "childJob", "summary": "ea voluptate in amet velit", "description": "id nulla sint", "app": "veniam adipisicing ea consectetur in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Oi1wOmKOT/~1/XE/TiuRUgFnt./~1/~1/~0" }, { "type": "encryption", "pointer": "/Zbb+Q7yCafX/~0/hNo/~0/m-Q/tnyck/XmxZBC/j9VW/~0/gyj" }, { "type": "encryption", "pointer": "/S,al8HI2eV/THSx7E/~1/~1/Vu5hrKT/GzHG7/wnxqjG8dgV//bxn/mKMs738Ap/bw6,T/3lTxx" } ] }, "groups": [ "accd1b72594b97d7891807f6" ], "type": "operation", "nodeLocation": { "x": 14688152.503676161, "y": 4449623.391981244 }, "deprecated": true, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "18de232887a92607eda184fc" ], "canvasVersion": 3, "_id": "df307842-528a-55c4-2029-3db40a8b0730", "uuid": "b606df59-9559-c330-af63-3cf637719dfc", "namespace": { "type": "project", "name": "Excepteur", "accessControl": { "read": [ "laboris esse sint dolore", "amet" ], "write": [ "amet consequat anim magna do", "irure sint in sed", "ut et fugiat ullamco anim" ], "execute": [ "pariatur nisi dolore est Lorem", "sint dolore sunt nulla", "exercitation in anim nulla", "consectetur ea ullamco do veniam" ], "manage": [ "dolor esse incididunt", "exercitation labore et", "do laborum laboris", "et Duis consequat", "eu aliquip" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": 95432627, "errorHandler": { "type": "nulla non qui in adipisicing", "name": "est elit" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "b352fbcc6f2614d0e51e2ddc", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "426ee90d3ae653a981ee9186", "lastUpdatedVersion": "4.69.69", "tags": [ "aliqua consequat" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/bmD.TGqp0d/IY.//~1" }, { "type": "encryption", "pointer": "/L2PZ8T/Mq5HT/C" } ], "migrationVersion": 81065897 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "de507494bd690a23ad8d8ee1", "eae7ab0c46fe638f8e5b36d2" ], "nodeLocation": { "x": 5267963.26683034, "y": 72155500.98782986 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "70fb2b0e41ed9e930dd1871f", "1efd8096e30bb2e98d9b80d8", "98a9a007a6d6b3ae4d0dfa81" ], "nodeLocation": { "x": 96423260.40226313, "y": -94290234.00553964 } }, "error_handler": { "name": "childJob", "summary": "esse eu", "description": "irure do", "app": "sint Excepteur dolore in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/BxpJu/jy-ABYS3Ax/~0/~0/HEr26r/~1/~1" }, { "type": "encryption", "pointer": "/~1/~1/oJUM+By+hN/fbd7-IS-/HASy6U/u.z/~1/k1qsSR" } ] }, "groups": [ "33536ed9dbdcfaa346975dee" ], "type": "operation", "nodeLocation": { "x": -90728689.83894563, "y": -29238140.547257707 }, "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "2723cc20238efc6a0ecf3a51" ], "canvasVersion": 3, "_id": "fe97c858-35e6-a071-2992-bb4e363a5045", "uuid": "7d728b78-4126-41b1-1a7a-34d4984b2267", "namespace": { "type": "project", "name": "officia dolor commodo", "accessControl": { "read": [ "do ut", "laboris", "ut", "in Ut irure ut commodo" ], "write": [ "sed commodo voluptate", "sed proident irure id", "culpa velit sunt esse nostrud" ], "execute": [ "cillum consequat Ut voluptate", "cillum ad adipisicing et" ], "manage": [ "Lorem", "id dolor est", "cupidatat qui", "id esse culpa aute deserunt" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": 90128190, "errorHandler": { "type": "incididunt Excepteur ea dolore enim", "name": "Ut eiusmod consequat ex" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "184b94aa0f0f630bfe9af2ad", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "31b7a802d061b455ff6fc7ee", "lastUpdatedVersion": "4.69.69", "tags": [ "amet", "ut commodo est consectetur do", "ut quis exercitation ad", "Duis Lorem irure ipsum incididunt", "id" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~0" }, { "type": "encryption", "pointer": "/pu/NWCsCkPTQpe/nK,wcxUxF" }, { "type": "encryption", "pointer": "/s6/q3Y/~1/wn7.2xjz/~0/y/~1/n45GH5t6Q/~1" }, { "type": "encryption", "pointer": "/~0/CGzTZGT/~1/I3WTFq4./~0/~0/~1" } ], "migrationVersion": 28857698 } ], "total": -53100618, "start": -62503068, "end": 28826206, "count": -61925489, "limit": 13953305, "next": "cillum et", "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" } ] } } }