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": 0, "order": 1, "sort": "name", "exclude-project-members": true, "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": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "2fb49f95d119de6d168b6163", "2dd052d79c7fb8be1d00e8be", "8d06937ab0ad6a2883c1d63d", "5d6e99af67577ac1831ba341" ], "nodeLocation": { "x": 28440392.418149456, "y": 96175986.78074053 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "e8f0c0b6260cee9a9f66f6a7", "863cb6c1ab872c66228646c9", "9aef96f30eaff5ff67a77552", "abf71d491fedae84f0ecaa32" ], "nodeLocation": { "x": -91444713.93764472, "y": 4725749.122752324 } }, "error_handler": { "name": "childJob", "summary": "consectetur occaecat amet reprehenderit", "description": "proident deserunt enim laboris officia", "app": "nisi", "variables": { "error": "" }, "groups": [ "9ad8f428eaf743aa09ebb951" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "success", "error" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "c460e890f4e6c1f75c413d86", "71b2f5af460c431182f25821" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "tempor ea voluptate esse", "accessControl": { "read": [ "tempor quis cillum", "exercitation sed minim", "labore sit" ], "write": [ "ut adipisicing incididunt nostrud", "Duis id", "reprehenderit eiusmod tempor", "fugiat consectetur consequat" ], "execute": [ "officia ut consequat", "laborum" ], "manage": [ "in nostrud incididunt nulla" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1978-09-03T11:07:23.858Z", "created_by": "f95f27d048077882babed04d", "last_updated": "1960-02-15T02:37:27.217Z", "last_updated_by": "6efd20ab5977201c98a9dc0b", "lastUpdatedVersion": "voluptate irure", "tags": [ "proident laboris tempor", "fugiat in occaecat proident Lorem", "sit qui nostrud Lorem ea", "cupidatat qui elit laboris amet" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "32772b553db31da74247845f", "45286364b5625fd18acb3c69", "cb8e6c48026bcb3fb415bd55", "69041b7c3ea4e98ecf9ef4cf" ], "nodeLocation": { "x": -96522697.2082902, "y": -55951346.06282941 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "fa201b98d875e872f3da76ce", "b85782d98703ee293fb59ea1" ], "nodeLocation": { "x": -40702050.23086117, "y": -25067627.649910837 } }, "error_handler": { "name": "childJob", "summary": "ut est cupidatat in minim", "description": "dolor reprehenderit", "app": "dolor incididunt exercitation ex", "variables": { "error": "" }, "groups": [ "6b74614bab20c14d5b9c255d", "841ed9de97567865b4797030" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure", "error" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "e97e56b25b64f5bc742fd717" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "amet", "accessControl": { "read": [ "dolore irure laborum anim veniam", "non Duis pariatur irure adipisicing", "in" ], "write": [ "nisi", "qui enim dolore", "magna Excepteur adipisicing laborum", "in ad laboris", "aliquip commodo officia et pariatur" ], "execute": [ "tempor elit dolore", "consectetur", "elit tempor do exercitation dolor", "mollit" ], "manage": [ "non" ] } }, "description": "deserunt veniam exercitation eu aute", "preAutomationTime": 250000, "font_size": 12, "created": "1995-01-26T14:21:13.447Z", "created_by": "03bc71317dccd52119c778ca", "last_updated": "1983-04-01T12:42:25.687Z", "last_updated_by": "7d85da6274a062bc0e028054", "lastUpdatedVersion": "minim anim dolor aute", "tags": [ "in laboris" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "9f3b7d11417a4fc6b3b89f63", "25b6948fec08e1d012c3eade", "abcdd0fbe23ce8cb4409df9a", "5ab7f0d5970e6af9edf4a25b" ], "nodeLocation": { "x": -58077901.61752124, "y": 892499.192210123 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "dec37ec9a1276bacef3a1297", "10fca99bab3ae2d4466d85cd" ], "nodeLocation": { "x": -34592026.70753849, "y": -97234282.50277592 } }, "error_handler": { "name": "childJob", "summary": "proident consectetur", "description": "ex nulla culpa", "app": "in deserunt nisi laborum", "variables": { "error": "" }, "groups": [ "1661b2571e41667a06b223fc", "f1072d170d17f14c8892975a", "c6bc0d0275f08771b2b6b826", "ff06ec356a264491cb658d99", "6bea6de8b0a4921fa885ddb1" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "failure", "error", "success", "error" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "9e573b57f259bd5ad7d2aff0", "d03f2e0be853e173050148f3", "21fed887cd75a109ce3df96a" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "consectetur incididunt", "accessControl": { "read": [ "quis", "aute officia adipisicing elit", "Duis", "commodo" ], "write": [ "labore laborum incididunt et" ], "execute": [ "sint dolore do", "qui ut officia", "Duis Ut occaecat do", "adipisicing velit minim" ], "manage": [ "do ea exercitation tempor", "consectetur dolor commodo deserunt cupidatat" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1977-08-21T21:00:51.283Z", "created_by": "c02ba72db63420a27ae055d9", "last_updated": "1970-10-07T05:39:29.362Z", "last_updated_by": "8bb548adcdb548ec44a278c4", "lastUpdatedVersion": "cupidatat incididunt ut Duis", "tags": [ "in" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "7757db7a52e7f5530fd20c7c", "07c682f16c0ce3283d8f2298", "8b6851d981e4a3426dc5ef60", "75a8846f170f0e8be3a8a126", "372635ba5791b7664255347d" ], "nodeLocation": { "x": 43935717.206832826, "y": 45673094.78717938 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "679937584f7a91f4ad5a273c" ], "nodeLocation": { "x": -74593078.56097071, "y": 86186738.32834572 } }, "error_handler": { "name": "childJob", "summary": "labore minim", "description": "anim minim in veniam non", "app": "sed enim aute in ex", "variables": { "error": "" }, "groups": [ "e40795ca557df2e9c03a38df", "ce5b0f3aae89f3c718ab6865", "71aaa101204fddf603150fb3" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error", "success", "error", "success" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "83d6978e0392dd21f136bd58", "3c0c2e9cb1c8223f2f1b989b" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "Lorem exercitation do", "accessControl": { "read": [ "officia consequat occaecat ad", "in ad nostrud sint voluptate", "qui" ], "write": [ "commodo veniam proident", "ut", "nulla exercitation" ], "execute": [ "est labore proident esse velit", "minim nostrud Ut laboris quis", "amet culpa magna sit", "et", "cillum aliqua ad" ], "manage": [ "ea aute", "aliquip nostrud dolor veniam", "ipsum fugiat in consectetur in", "nostrud veniam amet proident aute" ] } }, "description": "et qui", "preAutomationTime": 5000, "font_size": 12, "created": "1964-07-03T03:22:20.306Z", "created_by": "8c8768b4f6c0c1e3270a1d12", "last_updated": "2007-04-11T08:39:37.26Z", "last_updated_by": "d265235e2caef8d6f44651ef", "lastUpdatedVersion": "do et nisi", "tags": [ "veniam commodo dolore ex", "laborum amet", "nisi aliquip in mollit", "Lorem", "culpa cillum aliquip" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "101f7238f9bf585bb20df456", "60891634dd44e3f92f100d31" ], "nodeLocation": { "x": -11449603.97756663, "y": 139760.37934608757 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "0dfe8b271ca5a9cc26b87287", "795ca72172e321321b394eec" ], "nodeLocation": { "x": 46192830.57287133, "y": -74656573.84862219 } }, "error_handler": { "name": "childJob", "summary": "eiusmod exercitation dolore", "description": "id ut tempor enim Excepteur", "app": "ea", "variables": { "error": "" }, "groups": [ "ff229f367a3ce11b6d82e6a1", "81a069ea8b88cce71a7b3776" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure", "error", "failure" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "90347f30bcde56dc8990fa2e", "bc7369c3beae9bd02428ca74", "393afb2f86959d10ae99e5b6" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "aliqua Excepteur fugiat sunt adipisicing", "accessControl": { "read": [ "fugiat", "commodo sunt et", "mollit sunt Duis qui minim", "non qui eu", "cillum laborum qui" ], "write": [ "ea", "veniam ut dolore consequat elit", "id cillum" ], "execute": [ "quis in anim", "ea nostrud", "aute ut et id do", "exercitation", "culpa adipisicing" ], "manage": [ "ut in non cupidatat", "laborum cupidatat sit mollit" ] } }, "description": "fugiat voluptate dolore nostrud", "preAutomationTime": 250000, "font_size": 12, "created": "2017-07-12T13:50:03.99Z", "created_by": "9b6ea463c5afbf6aac38bf7b", "last_updated": "1979-06-14T03:34:32.482Z", "last_updated_by": "dbf07b048c17bfb8abfaebbd", "lastUpdatedVersion": "culpa voluptate dolor", "tags": [ "et voluptate", "adipisicing" ], "encodingVersion": 1 } ], "total": -68167639, "start": -66861689, "end": -61444636, "count": 9537860, "limit": 59441767, "next": "sed", "previous": "non id velit" }
{ "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" } ] } } }