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", "include": "description", "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" } }
{ "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" ] }, "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" ] } } } }, "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": [ "25df87033a83a2aa60ff9a26", "564f584ca650c4bd2e135830", "167da0b04b110ac8b7fb67bb", "3f2f0818d8c4bfd204444d49" ], "x": -69092251.18917379, "y": -61205779.752864674 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "b86adc9bfc9952731793107a" ], "x": -6872757.540065199, "y": 77341300.20588765 }, "error_handler": { "name": "childJob", "summary": "ad", "description": "voluptate non anim exercitation dolore", "app": "officia eiusmod nisi voluptate", "variables": { "error": "" }, "groups": [ "48560107567ad75e38a4e0a8" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error", "error", "error", "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "b6fb18b352c5f07242deb83c" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "aliquip dolore quis nostrud non", "preAutomationTime": 5000, "font_size": 12, "created": "1984-10-14T12:16:47.675Z", "created_by": "b7cc8d05dfc52d5f81bd9e05", "last_updated": "1950-03-29T05:12:44.558Z", "last_updated_by": "894a65a92b0695a70adae76c", "lastUpdatedVersion": "laborum", "tags": [ "Duis", "incididunt cillum officia", "tempor", "commodo tempor sunt cillum" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "f1df9838b9725c1986b3b247" ], "x": -99814862.07591623, "y": -91794908.62057236 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "993f4a044f8791aac2204ed5", "37cd8375320e75a90290f28d", "ed868fc3a5378a85d3fb0444" ], "x": 39799969.775487155, "y": 55561309.54994303 }, "error_handler": { "name": "childJob", "summary": "exercitation", "description": "aute occaecat ut ipsum amet", "app": "voluptate", "variables": { "error": "" }, "groups": [ "d6a1b41f3341fa7ef3b31b60", "10f51aabd90ce37a873d5c64" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "791162dee99368c9b6609e06", "7d26b5c855d0218834d01724" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "fugiat reprehenderit eiusmod in", "preAutomationTime": 5000, "font_size": 12, "created": "1953-02-21T21:28:49.85Z", "created_by": "ec0824985a4dd07fb9a6c514", "last_updated": "1962-06-15T15:56:03.474Z", "last_updated_by": "550b3170fbaec5932e8b587b", "lastUpdatedVersion": "voluptate consectetur aliquip nulla", "tags": [ "ut ad reprehenderit pariatur", "velit", "veniam Duis laborum magna cupidatat", "in", "deserunt Lorem" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "948fe87f80210db312e8abe8" ], "x": -96164073.32601358, "y": -83234010.4919437 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "fe4cdbd550297d426a7c4a82", "6f5e6f862a8065a3d96f0572", "0d440f5adc61b4c10a47019e", "288de4cb7ad37716db2c3c80" ], "x": 5831480.752911761, "y": 57005579.54675177 }, "error_handler": { "name": "childJob", "summary": "proident adipisicing", "description": "aliqua irure", "app": "irure et", "variables": { "error": "" }, "groups": [ "8fcb1d5f285f3833b1a74f2d", "9d7270b30b977203a3897cdc" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "failure", "error", "success" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "a82832e3a64bb78420fea426", "2c9cfe6da6268cec676e663d" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1952-07-18T03:05:06.499Z", "created_by": "cac3b6a5ba86db15b08a4595", "last_updated": "1975-04-19T16:46:00.748Z", "last_updated_by": "2cd66bbc03428276b315fffb", "lastUpdatedVersion": "ea sed pariatur", "tags": [ "sed consectetur tempor nulla", "nostrud in" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "6f9a33da15169c3909a293ea", "d31a7ec0aa43f1afd797edc4" ], "x": 34797624.542723894, "y": -3714141.675675586 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "c7bad75e6affbb6a3438a35d", "e2711afedaf63d359e7a294c", "1cf612083e95c74a048af47b", "92dfaf625637bbb879acffbe", "f2ec00edef92788510ef1a18" ], "x": -46912006.12605329, "y": -71973063.1295869 }, "error_handler": { "name": "childJob", "summary": "qui", "description": "qui fugiat", "app": "sint consectetur in qui", "variables": { "error": "" }, "groups": [ "db68247ff9e842d8a04f4713", "ae6e90a83956102d8ae60888", "6a60ed49e108a3735775329c", "b3696a4f0a4922aede7a69a4", "80f324a4710bcbbb9e6abda3" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "failure", "error" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "1b487dc7ae2212d4eb653671", "f23fffd4d3318ca3cf6a1b6a", "44180e0f74f4f65341f625a0", "e4807a6624399424ba684ffe", "811dbb1cf2258d3d62af7b9a" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1981-08-26T21:40:10.211Z", "created_by": "72caf1b74fa4f62127ec54ed", "last_updated": "2014-04-05T10:31:36.295Z", "last_updated_by": "a5b6cc55d84830b4f8038cb8", "lastUpdatedVersion": "reprehenderit", "tags": [ "reprehenderit" ], "canvasVersion": 2, "encodingVersion": 1 } ], "total": 78897626, "start": 61302164, "end": 63200712, "count": -32675331, "limit": -56624730, "next": "ad deserunt enim in nisi", "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" } ] } } }