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": true, "include": "description", "exclude": "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": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "57381f5c4f881dc77b16ba48", "f07fafb54fcb5758d8e4dad0", "c40db8f815b7987b7f408c8c" ], "nodeLocation": { "x": -27824054.22307019, "y": 75184715.4944072 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "66c1e1ed213d54642b5c6b23", "19875834238de301a77f362f" ], "nodeLocation": { "x": -74571095.55604541, "y": -60172884.12814152 } }, "error_handler": { "name": "childJob", "summary": "cupidatat deserunt laboris", "description": "enim consectetur do", "app": "sit sunt nostrud", "variables": { "error": "" }, "groups": [ "f8774e387a3c3c7925206329", "abf020d007152e660238d7a9", "06bfe083fa934d5dfbb28119", "9d3231e7e07aafecfb70fa4d", "271e1852ae09a79591ab1c5d" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "0e555d8e6ddc0b7e9846e09b", "5e79b2c5539c947ec154b166", "ca2b01bd45388d4d0e728867", "bd956be59c19aeb1d61dcc2a" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "do adipisicing officia enim", "accessControl": { "read": [ "Ut esse", "laborum", "cupidatat proident" ], "write": [ "voluptate adipisicing tempor irure reprehenderit", "laborum", "dolore sunt aliqua", "dolore laborum officia dolore", "ut ex Ut magna" ], "execute": [ "et ullamco officia", "magna irure officia reprehenderit qui" ], "manage": [ "tempor laboris et est enim", "dolor", "dolor consequat commodo Ut", "deserunt labore" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2024-04-15T02:21:21.475Z", "created_by": "c965437eede08d171cb30663", "last_updated": "1954-08-21T13:26:07.417Z", "last_updated_by": "63cf3495db7f063d0a3f7b37", "lastUpdatedVersion": "minim", "tags": [ "consectetur aute", "ut", "aliqua", "commodo dolor magna tempor nisi", "esse in in est occaecat" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "68ad12e4b293a978f9bba338", "2c75505190c3a862f27f783d", "f4ffb534f405242c5188a525" ], "nodeLocation": { "x": -64147047.2965946, "y": -55826144.37488007 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "ebbf5ad7199a17695b8f4fa5", "c25fa85aac53b9a59d0f99d6", "a22d5dc27c889a4ae754f14a", "c9debd8694e93fa881aaf2f0", "608c0931a616f7fb23169b24" ], "nodeLocation": { "x": 13765168.710488543, "y": 34953840.492812574 } }, "error_handler": { "name": "childJob", "summary": "quis occaecat", "description": "proident", "app": "cupidatat sunt eiusmod", "variables": { "error": "" }, "groups": [ "91e1a3e457cd4bec38b9a4c3", "34578511f02b359888972877" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "0b01f6d5423a69c7ade66e17", "cf08ecffb5fe90021ca2cb7d", "f73de3292893272957968623", "e533c5c30b79e2affcb92ef4" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "laborum", "accessControl": { "read": [ "veniam aliquip et consequat", "enim elit ut et dolore", "ullamco exercitation laborum ut", "irure aute ipsum", "do aliqua aliquip Excepteur laboris" ], "write": [ "veniam incididunt sint proident", "sint dolor ipsum Excepteur in" ], "execute": [ "esse", "ex et tempor fugiat do", "velit fugiat ea voluptate", "voluptate" ], "manage": [ "voluptate" ] } }, "description": "dolor reprehenderit commodo ad occaecat", "preAutomationTime": 250000, "font_size": 12, "created": "2020-07-10T02:12:10.529Z", "created_by": "9bbcde16533fd092583be4d8", "last_updated": "1978-01-07T01:42:20.571Z", "last_updated_by": "b91f3aa9a26d0574601719d5", "lastUpdatedVersion": "ullamco esse", "tags": [ "sed reprehenderit amet anim irure", "aute ex ullamco consequat" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "ded1ce27e0868932f01a7744" ], "nodeLocation": { "x": -26869358.38712597, "y": 76869626.99568954 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "38d5b329d2c86aefb513dde1", "41d16bf1553eb6e9983e59f2", "c6894f439a956d4f4080e9c7", "2a71ffdcc3bf27a32a6a8544" ], "nodeLocation": { "x": 91592822.38305971, "y": -99117857.6192277 } }, "error_handler": { "name": "childJob", "summary": "cupidatat amet reprehenderit labore nulla", "description": "in irure aliquip quis exercitation", "app": "ut enim", "variables": { "error": "" }, "groups": [ "f550b51577da49cbe7243800", "b532b8031f73ff9baebc9f3c", "3f4dd3996675ddd33f932a91" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "success", "error", "success", "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "bcf5898e399257627fa1d3b3", "2b800417b256a1430c296db4", "a37c4d45f131aae22527642a", "172363f5ac08018ed4a41940", "949a47ee321cb65dd768be58" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "Duis voluptate", "accessControl": { "read": [ "nulla veniam ad Excepteur eu", "anim eu cupidatat", "ut" ], "write": [ "nostrud non ea", "et Ut" ], "execute": [ "ipsum cillum", "laborum nostrud dolore Ut", "non", "ut labore cupidatat laboris", "dolore" ], "manage": [ "laboris", "pariatur ullamco velit aute", "magna", "non qui id ut officia" ] } }, "description": "Lorem ea", "preAutomationTime": 5000, "font_size": 12, "created": "1998-10-01T03:23:27.616Z", "created_by": "9a8527160be8da7bd843f585", "last_updated": "2003-03-16T08:15:27.696Z", "last_updated_by": "d980e5176fbee88467dffedb", "lastUpdatedVersion": "tempor esse sit ut laboris", "tags": [ "tempor minim aliquip ut", "veniam", "cupidatat sint" ], "encodingVersion": 1 } ], "total": 68821620, "start": -35111263, "end": -99706305, "count": -57556332, "limit": 14139946, "next": "reprehenderit amet aute elit nostrud", "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" } ] } } }