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": 50, "skip": 10, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name,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", "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": [ "cd2b816b2a5975951bb1ce7d", "49c8f73bf5e7b9713a6e5f38" ], "nodeLocation": { "x": 27774203.257988095, "y": -81683576.5565612 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "34c08614b7e0192324c5ae38", "2260468e1e7ac95c52c0eec8", "b9379d88108ab91c3d1eec95", "c4496f404528fb8425affd8b" ], "nodeLocation": { "x": 66926402.60563803, "y": -79000996.27998802 } }, "error_handler": { "name": "childJob", "summary": "non proident sit aliquip", "description": "sunt", "app": "magna aute cupidatat anim", "variables": { "error": "" }, "groups": [ "b8c08e3f4592535982d558a0", "ba193dc86235a19ccda3c6d0", "e6739c5d92e6e82895896b35", "9710aa60ba99db4adb2fa97d", "4b05e87bea8807e678ae252c" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "error", "failure", "failure" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "334de5b8d1408d1731f10d40", "8d61b81d1fc22a4079cca690", "c842c91e20ba7431b932a8a3" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "deserunt dolor irure amet in", "accessControl": { "read": [ "non velit dolore labore qui", "in", "aute tempor officia elit ipsum" ], "write": [ "proident nisi cupidatat ea", "consequat eiusmod Excepteur ad", "minim deserunt sint est", "qui et magna Excepteur", "Ut in magna" ], "execute": [ "in fugiat officia voluptate", "quis sint velit eu" ], "manage": [ "sit nostrud incididunt ea et", "et ex labore velit commodo", "culpa laboris nostrud", "aute sint nostrud Ut", "ut quis esse" ] } }, "description": "ut est", "preAutomationTime": 5000, "font_size": 12, "created": "2000-02-23T23:11:58.796Z", "created_by": "055fe405f34f1ba4b39ed91a", "last_updated": "1958-07-05T09:59:32.018Z", "last_updated_by": "512e2907c2127a53a506436f", "lastUpdatedVersion": "laborum dolor nisi", "tags": [ "ex tempor dolor" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "20d7f2a7f193dd037d7c5383" ], "nodeLocation": { "x": -72079110.8593839, "y": 83930111.54821149 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "d46466690ea25276d9bfc05e", "86d59ea101f9ef25655a17a8" ], "nodeLocation": { "x": 75533626.76334375, "y": -13145820.918676466 } }, "error_handler": { "name": "childJob", "summary": "reprehenderit dolore Ut", "description": "ut ipsum esse", "app": "voluptate", "variables": { "error": "" }, "groups": [ "896730c153f71664e3c8c1ae" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "failure", "error", "failure" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "b73114efb86d8e657f4fa23f", "d216d74b63af37a970754ac2", "c726c554d794b3d741b21609" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "laboris Duis magna minim", "accessControl": { "read": [ "voluptate et dolore enim", "sit ut laborum", "ut" ], "write": [ "Duis quis", "qui fugiat mollit incididunt ullamco", "non exercitation sit" ], "execute": [ "id ut", "minim", "consectetur sit sint", "laboris veniam", "ipsum qui" ], "manage": [ "quis", "adipisicing", "irure", "in cillum", "irure" ] } }, "description": "laborum Duis incididunt nulla", "preAutomationTime": 250000, "font_size": 12, "created": "1974-06-06T17:25:30.288Z", "created_by": "cc85a6b211146801f840aa6f", "last_updated": "2012-08-02T10:36:50.467Z", "last_updated_by": "caea0d46a105dd53addb95d4", "lastUpdatedVersion": "nisi", "tags": [ "adipisicing eu deserunt laborum in", "adipisicing tempor ipsum aute occaecat", "cupidatat dolore dolor aliqua", "ad laboris deserunt est", "culpa cupidatat enim" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "3ca620c814eccf60d29432d5", "50b54991e394f47c8f93aa60", "b9fb9c1fc7b48b850dabd07c", "9477a34440326314792eaa3b", "1caa0484e0d3a6f36cd77571" ], "nodeLocation": { "x": -95931584.29617806, "y": -91453182.68998794 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "7aba0659be953c8f58375829" ], "nodeLocation": { "x": 42136503.9105472, "y": -74450093.28181702 } }, "error_handler": { "name": "childJob", "summary": "laborum Ut dolore dolore", "description": "adipisicing culpa aliqua fugiat", "app": "ut", "variables": { "error": "" }, "groups": [ "ea0df74095277ae7419d33ff", "5ff9e9ced6b0757f6c75075c", "88a08432ddfd334fe1f30920", "20686bb9c16fac6c36797649" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "80d2c787554be74661579f8c", "c69994eb7f006140368ad2bc", "b01adda757cdf5fc460d18f6" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "fugiat amet nisi anim sed", "accessControl": { "read": [ "dolor ullamco sunt", "sunt elit", "ullamco" ], "write": [ "pariatur est commodo tempor dolore", "mollit laboris enim ea aliquip", "in amet incididunt dolore officia", "aliquip esse dolore enim", "sunt nostrud" ], "execute": [ "anim et", "elit ad magna" ], "manage": [ "id culpa", "incididunt in", "Excepteur commodo aute", "labore" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1960-03-18T02:04:11.227Z", "created_by": "56523bc55a9900408b5edaa9", "last_updated": "1976-10-25T19:35:49.541Z", "last_updated_by": "28af60e562d3183da47fe693", "lastUpdatedVersion": "eu", "tags": [ "adipisicing", "nostrud aliquip commodo", "dolor ut", "enim sint dolore", "dolor consectetur do dolore" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "31894784ffb7207cd860a8e3" ], "nodeLocation": { "x": 13481432.258715391, "y": -43277522.003683224 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "076eb6d8fbbce6393724bfdd", "f4aad05332491b1a47ee761c" ], "nodeLocation": { "x": -59777192.24421407, "y": -13699771.746681616 } }, "error_handler": { "name": "childJob", "summary": "anim sunt officia eu irure", "description": "ex ut in", "app": "laborum sed deserunt", "variables": { "error": "" }, "groups": [ "fc41c23b8501bf0885ea15ea", "bea3e2ad71fc2dd60f5d0481", "095c8a4c4f67dbc196123df9" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "914b20d305d8235bc17495eb" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "aute ut consequat amet adipisicing", "accessControl": { "read": [ "esse aliqua anim reprehenderit", "sed velit ad consequat voluptate", "eu", "nostrud magna nulla" ], "write": [ "magna consectetur", "anim est", "deserunt proident sint in commodo", "pariatur dolore", "incididunt irure do pariatur quis" ], "execute": [ "sunt ullamco nulla", "enim ad id" ], "manage": [ "dolor cillum", "sed minim officia", "ex est commodo nisi" ] } }, "description": "adipisicing dolor qui amet do", "preAutomationTime": 5000, "font_size": 12, "created": "1948-06-26T04:27:45.329Z", "created_by": "07d1dcfda689aa5f54103dcf", "last_updated": "2007-04-27T22:54:35.723Z", "last_updated_by": "0195565cb9c0468d8f6b65b8", "lastUpdatedVersion": "ut qui adipisicing aliqua", "tags": [ "fugiat anim ex Duis", "ea" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "9ec9e57168b8317b33e24b97", "eb6b3386a92f7b5913e6b4a3", "680d8f1294ae9a5f6088a694", "4ff6a7b922d3cc73ca5c5746" ], "nodeLocation": { "x": 65921799.86138728, "y": 93637300.87742627 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "4b79b515ede3316a344148a7", "feec8f426495c54226a4e90f", "abddcfd612ce3e28fde86487" ], "nodeLocation": { "x": -46351881.20969298, "y": -97459283.35812737 } }, "error_handler": { "name": "childJob", "summary": "ipsum ut et Lorem Ut", "description": "Duis", "app": "anim in dolore", "variables": { "error": "" }, "groups": [ "77a3cbcfb23ee7a82d24c7ef", "4edae4130c06d570fbd89937", "b247d788eb015422f8e48a16", "d483989382cd9133d3a3fac3", "0b1d049728e9ab12ca04bd23" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "failure", "failure", "error" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "0fd0d949b3ff1eb0b9f6312f", "fafc7f706660d5c8bc1bc8f7" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "occaecat in nisi", "accessControl": { "read": [ "Duis magna mollit minim", "deserunt minim aliquip ea", "ipsum do dolor" ], "write": [ "voluptate", "cupidatat pariatur", "dolor officia est ullamco Excepteur", "nulla magna", "reprehenderit in aute" ], "execute": [ "aliqua est Ut magna", "nostrud sunt mollit" ], "manage": [ "do anim deserunt", "id Excepteur anim consequat", "ex reprehenderit ut" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1987-12-03T20:54:34.063Z", "created_by": "94f596cac3bb7bf7b24f1938", "last_updated": "1982-04-20T20:54:09.345Z", "last_updated_by": "84b685a91c8f2737bc0c25d3", "lastUpdatedVersion": "esse laboris nisi aute aliqua", "tags": [ "do", "ea est", "tempor Lorem ipsum", "cillum nisi in magna velit" ], "encodingVersion": 1 } ], "total": 84270980, "start": -9414586, "end": 96366110, "count": 75219647, "limit": 46396245, "next": "mollit esse", "previous": "Excepteur qui non" }
{ "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" } ] } } }