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": 10, "skip": 10, "order": 1, "sort": "name", "exclude-project-members": false, "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": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "4d8199ce615163685320bdff", "afdbe6529aca84bf90822e6a", "4ff75c81351a0f868e4c6584", "e78a83b25ae5aaad95d2d4a6" ], "nodeLocation": { "x": -89002519.53807907, "y": 30259264.47089629 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "2b6ccc72b815cedd24c927b0" ], "nodeLocation": { "x": 43939468.64512017, "y": -60884317.133954056 } }, "error_handler": { "name": "childJob", "summary": "cillum sed", "description": "do pariatur", "app": "sunt veniam aute laboris in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/vBQ3DNFrf-/dNi/~0/cW+ew/~1/~1" }, { "type": "encryption", "pointer": "/l1cns/p/K4/~0/Uw/~0/MSG.4jjIHGk/cnV" }, { "type": "encryption", "pointer": "/x-NO18s/uvUaHF8kz.2/wX5/~1/~0/~0/pijaR/~0/~1/ZgsMFEUW" }, { "type": "encryption", "pointer": "/~0" } ] }, "groups": [ "b6e733ff4f143ac044bee287" ], "type": "operation", "nodeLocation": { "x": -36346292.884146966, "y": -60444537.74115866 }, "deprecated": false, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "31b208c362a87ce611b202bd", "ebf7aa6ad464f524900fd767", "1bf11c69c0d3185911de40d5" ], "canvasVersion": 3, "_id": "7d9efd10-3216-d543-1a17-9440f2204c3b", "uuid": "0ca54a12-0be9-5857-2a9d-3050ecac1b4a", "namespace": { "type": "project", "name": "nisi incididunt", "accessControl": { "read": [ "nulla dolore culpa sit", "culpa esse", "veniam ad sint" ], "write": [ "in tempor", "cillum ullamco ut dolore", "Duis", "minim in ea", "fugiat amet sunt" ], "execute": [ "deserunt sit proident amet aliqua", "qui", "sit ea commodo dolor ullamco", "aliquip aute nostrud minim" ], "manage": [ "labore qui", "magna dolor nisi", "culpa in et", "Lorem" ] } }, "description": null, "preAutomationTime": 5000, "sla": -69544969, "errorHandler": { "type": "in", "name": "pariatur cupidatat nulla in" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "b84b2d6335b0df0a0927ce77", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "05748c314eb2aaa2add0b40c", "lastUpdatedVersion": "4.69.69", "tags": [ "ex non", "do elit", "consectetur ipsum non elit", "in labore", "Ut aliqua" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/Pyd/~1/~0/~1/~0/~1/Ji5/w./l2zUtr/~0/t8nuCPy" }, { "type": "encryption", "pointer": "/~0/~0/gxMFdstjEh/~1/~0/~0/WsjFxvfNj2/nL/s-TU.s-fxo/KdUmY-C" }, { "type": "encryption", "pointer": "/Wlpe1q/kpIDUx-7Tg3" }, { "type": "encryption", "pointer": "/J4b0XtSxjfL/L1n-/K/~1" }, { "type": "encryption", "pointer": "/d/U-s//~0/uistj5eEEN" } ], "migrationVersion": 12091195 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "09a256d03e39bcfad80d5072", "bcc4f735963ba9208c865886", "82601b81d2bc6c5ae67c8c7f", "1470f26e8e48bb44475d25bb" ], "nodeLocation": { "x": -26734433.74192685, "y": -94048075.96273951 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "9ace1d760bd7cad68d490938", "05ab1dac63c2316eca5f0295", "b47e7aae9318560187fd2556" ], "nodeLocation": { "x": 65212371.04285267, "y": 82630158.38749772 } }, "error_handler": { "name": "childJob", "summary": "Lorem", "description": "et in fugiat Lorem aute", "app": "minim Duis", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/sugucLGvP/Tl+a.5" }, { "type": "encryption", "pointer": "/~1/Ew/eh6i.padRu/~0/~1" }, { "type": "encryption", "pointer": "/UqpNzSk2/nJDj/~0/sk/~1/~1/~0/gX/~1" } ] }, "groups": [ "94f784dc982489507efd881b", "114dd6a76cc44f952c768ab3", "bea9a102575e1409e21df893", "b9c009bb6e6bf28b14cd9a1e" ], "type": "operation", "nodeLocation": { "x": 80589933.54484013, "y": 74130145.88049194 }, "deprecated": true, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "8be9e8348994de82e60d9c6f", "02e51e89cc964c6870ab0afc" ], "canvasVersion": 3, "_id": "f665a5c8-3356-1d3f-4839-ea2a386547df", "uuid": "ae0e089b-0398-7948-62e2-479788c72dfe", "namespace": { "type": "project", "name": "veniam Duis fugiat laboris do", "accessControl": { "read": [ "non ipsum dolor", "mollit veniam voluptate tempor Duis" ], "write": [ "tempor sunt culpa", "officia eiusmod do", "aute" ], "execute": [ "reprehenderit", "id", "amet incididunt eu consequat in", "nulla Ut consectetur Duis" ], "manage": [ "labore", "laborum enim nulla", "magna fugiat cillum commodo sint" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 5000, "sla": -50418080, "errorHandler": { "type": "consectetur enim", "name": "est ipsum sit" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "945ac23b1df43fb52f24909f", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "c34834f24c7f813898c3e280", "lastUpdatedVersion": "4.69.69", "tags": [ "nulla laborum amet voluptate", "occaecat commodo", "elit dolore fugiat dolor", "dolor ipsum fugiat Lorem dolor", "ut veniam" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/k8uL5ftkRI/O6rXdqK/EWsoj72NRLG/~0/R0v/cwd+y02Vq/~1/~1/~1/iPG" }, { "type": "encryption", "pointer": "/~0/Dnd0sp-aH,X/jx9bU.5/~0/scOxSP8bz/Im9s,/~0/~1/~0" }, { "type": "encryption", "pointer": "/~0/~1/AA/mCqVxqIdT/IUrn/~0/~0" } ], "migrationVersion": 57507935 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "ec2118be1195108dd536086a", "2b72476930a1cc90cc6c9822", "8d1144bfb3af0448ff3a27b4", "df240886eb0b0e7586327023" ], "nodeLocation": { "x": -48844729.06932595, "y": 38871305.29350835 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "d9e0986ecc28d3956789d644", "eb5b15ec26b95e898454d7e0" ], "nodeLocation": { "x": -81301372.5066356, "y": 39229561.22409937 } }, "error_handler": { "name": "childJob", "summary": "fugiat ad est", "description": "amet", "app": "do anim cupidatat ut velit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/m/~0/t3l" }, { "type": "encryption", "pointer": "/~0/coP8K/~1" }, { "type": "encryption", "pointer": "/whuCm1,KX/bt/A.u19ewXE/~0/~1/x8kx/~0/r0/~1/~0/~1" } ] }, "groups": [ "58fae305baafee46941bf862", "6e5d76deb3b6677f22c71a37", "5a0243debc3a761dc08994af", "619fa71919b331408f5b1300", "21836b631e8dd02decb44b14" ], "type": "operation", "nodeLocation": { "x": -69081424.80609097, "y": 86998402.39654738 }, "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "error" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "cfb0dbe5f92d93c1ae294bfa", "6ad8b3449338272c01a55351", "da2464f76355f8a7a2a98b43", "83b71ac16fb783dc09cfb5ba", "29fdcbc3730d702f0ac7edd3" ], "canvasVersion": 3, "_id": "6524ff57-928b-3281-d0b4-a403015d11c2", "uuid": "38eb885e-bdf8-a6d3-c8e0-866c5457cd87", "namespace": { "type": "project", "name": "sint pariatur commodo dolor", "accessControl": { "read": [ "aliquip nisi sed", "nostrud in nulla", "quis consequat occaecat ex", "aliquip laboris adipisicing in", "culpa" ], "write": [ "in officia est commodo quis", "proident sed id Lorem mollit", "non mollit", "sunt ad labore incididunt Duis" ], "execute": [ "ut reprehenderit" ], "manage": [ "in ut", "fugiat quis", "laborum non", "commodo dolor qui laboris" ] } }, "description": null, "preAutomationTime": 5000, "sla": -27269943, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "0cd05f4d764a42489366e2cf", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "caeaaeebe93d26b2e3acd586", "lastUpdatedVersion": "4.69.69", "tags": [ "sed eiusmod", "veniam anim", "officia ex fugiat irure dolor" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/xhshzYM0ezf/ipbNCGqJ1J,/~1/OW.D+/OJn0T-E/Nen3vR/fgwb6Q/c8c/~0/~0/~0" }, { "type": "encryption", "pointer": "/~1/bJtJMMUin/VlWkvbQSvUg/zZEIxhC9/c6PW/rmSP9" }, { "type": "encryption", "pointer": "/gE0OF2X/p5EV/~1/iJLcA57l-Tj" }, { "type": "encryption", "pointer": "/~0/ZIjZA3wN/~0" } ], "migrationVersion": 42026828 } ], "total": -79615020, "start": -15435049, "end": -9429669, "count": -79065108, "limit": 57601324, "next": "enim", "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" } ] } } }