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, projecting, and sorting workflow documents. HTTP queries for the parameter 'in' take the form of '?in[name]=my-workflow'. However, the equivalent task query would be '{ `in`: { `name`: `my-workflow` } }'. Same thing applies for the parameters 'not-in', 'equals', 'contains', 'starts-with', and 'ends-with'. |
{ "options": { "limit": 50, "skip": 10, "order": 1, "sort": "name", "include": "name", "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" } }
{ "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": [ "f85d788c487674dadfb5600d", "b94c59f4a28600b13412d40c", "1e221630d013ed0c275bf849" ] }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "4136987881483e5f85dddd66", "7737d8d09f3bb57517500e3d" ] }, "error_handler": { "name": "childJob", "summary": "ex officia", "description": "nisi amet ut ullamco dolore", "app": "anim ea", "variables": { "error": "" }, "groups": [ "b54e49bbf4e9f2a459cdea6e", "0c79827007b7b4ce05155bc8", "c170bb6e33e53ae2fec88cb3", "af9efc53537f41f1754d0c6f", "7f904a9c1e3b920742c0cf77" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "success" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "e793d9ff86306b18e40a4d9c", "ed951c9a7094448b4fbe4426", "30abee29d86c24521062e3e0", "58b62fbfd94b92f704a2542b" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "non dolore amet proident in", "preAutomationTime": 5000, "font_size": 12, "created": "2008-01-05T16:56:05.542Z", "created_by": "b16b57a3cc6115fd2cd58c04", "last_updated": "1977-01-02T07:56:02.787Z", "last_updated_by": "dc3bae0411516fec39125ddc", "lastUpdatedVersion": "dolor incididunt irure fugiat", "tags": [ "ea Duis", "ullamco ipsum eu", "culpa eiusmod commodo sunt", "est esse voluptate reprehenderit irure" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "4796246900070f92ecefcb8b", "1e4c9f478da9e13fdab39176", "a3c4e49508cedda99a3ef7ed", "84088ea94dea6a092a2f13ea" ] }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "83c687fece4ddd0ee09a7ef5", "e96622317f892077bf177bee" ] }, "error_handler": { "name": "childJob", "summary": "officia aliquip Lorem ad", "description": "est ut", "app": "magna reprehenderit et Ut", "variables": { "error": "" }, "groups": [ "abc436910e695489e29d41ea" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "9d454de6d3b7dc0d3dd65c63", "17fd5be8458b5b565ea2b1da", "efb350058d97ceff18b48281" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1973-07-13T20:29:08.087Z", "created_by": "7822dacd8ecbd03969c2f342", "last_updated": "2018-05-27T20:54:55.165Z", "last_updated_by": "9581f04e6a7d2f5338a41890", "lastUpdatedVersion": "proident fugiat exercitation", "tags": [ "pariatur", "irure deserunt Ut", "est eu nulla", "adipisicing" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "6e7ced8717ebb4acd9586082", "5b31d97f88beb9149f1a70fc" ] }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "b383c164251eececbfd8445c", "daf7d4215fc41bb3f3232fb4" ] }, "error_handler": { "name": "childJob", "summary": "elit", "description": "sed consectetur dolor", "app": "reprehenderit", "variables": { "error": "" }, "groups": [ "3638f36e81b018d68f958f81", "f6af4725e62cc7caaba502cc", "e7f73250b7d94c97cb820883", "09a9067b0be2d4110e3ac049" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "failure" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "b7f824f7f399c8e0b372e76f", "88da2f3d445df9611747bb6c", "52d31db991d19e73f3fccaa6", "470ef92c7e61eafc2a1cdc8b" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1967-03-11T13:07:25.109Z", "created_by": "4274bed5cbaf2aa50de4ffb6", "last_updated": "1955-05-22T07:29:36.343Z", "last_updated_by": "4b27d26b675078d987d85798", "lastUpdatedVersion": "reprehenderit do in tempor", "tags": [ "elit eiusmod fugiat proident laborum", "ea in incididunt veniam sed" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "6c5d8c4e7ac147c9e5bcb423", "6a99d105944288598f983288", "95ab9677ac224686e467d1b7", "ab5cf23c5933c03798137452" ] }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "7f1b640af62620205d561fe4", "7c45890ef461243ba5586de6", "c177e5ba85830f82aff50dfc" ] }, "error_handler": { "name": "childJob", "summary": "magna nisi pariatur laboris", "description": "eu velit do amet", "app": "ullamco", "variables": { "error": "" }, "groups": [ "57d42f9f39215cb42f4f7444" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "failure", "success", "error" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "a3e46b15a11f73b9c3587272", "ac0d84a994b76b448b0af6f8", "efda6587404cf2b57d803762", "288de9ea43e79a3e5b379f85" ], "_id": "4321abcdef694aa79dae47ad", "description": "cillum", "preAutomationTime": 250000, "font_size": 12, "created": "1993-04-24T23:21:42.291Z", "created_by": "fb3dd94764a72143adc1e2bd", "last_updated": "2013-05-11T18:59:36.311Z", "last_updated_by": "3b2fe2bf656a540bd7d8b34e", "lastUpdatedVersion": "est occaecat", "tags": [ "ullamco", "ipsum qui proident", "incididunt" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "51213f6bc1352ad7d2b0251a", "905cabf043bc196e01e4e5f5", "5e7ca6e247fa826558fd098e" ] }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "4ce3002a7d570aa154455580" ] }, "error_handler": { "name": "childJob", "summary": "quis", "description": "dolore ad", "app": "ullamco commodo", "variables": { "error": "" }, "groups": [ "0733c93e34d0dd0e7e17c08c", "fa3caf13dea92eccbd5cb305", "8480b307aa32f280a1db0552" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "error", "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "12d95023f0cebf8f7fdf0edd", "a7a720c543eb92815a9350a0", "06da0e9a66666f2dd63a6c40", "50c72ee8cd85422a5f9807d2", "d8570d8487d4dec8d0337481" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2015-08-31T18:05:55.244Z", "created_by": "f109edee10f575739f625baf", "last_updated": "1954-07-04T07:14:48.198Z", "last_updated_by": "e0cc8358ee1d36fd5d3419b4", "lastUpdatedVersion": "incididunt in consectetur aute exercitation", "tags": [ "culpa laborum", "eiusmod in", "enim" ], "canvasVersion": 1, "encodingVersion": 1 } ], "total": 22754650, "start": 1580497, "end": 35225087, "count": 4460415, "limit": -93634896, "next": "proident minim", "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" } ] } } }