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": 25, "skip": 50, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "expand": "laborum officia mollit sunt exercitation", "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", "items": { "type": "string", "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": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "exercitation sit dolore Ut", "description": "in esse Ut", "app": "in", "variables": { "error": "" }, "groups": [ "7b39393ae942b824d4a7c6e4", "18dbc70a2c6f83071e7e89fe" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "failure" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "66d0dd43103957720327630e", "7ed1e8f2047925219d8bc115", "561fd0538b87e924e4c013c3", "2b404578a24d5ef8a0cfba27", "0a10a6c466134ab024846fb3" ], "_id": "4321abcdef694aa79dae47ad", "description": "tempor", "preAutomationTime": 250000, "font_size": 12, "created": "1946-10-29T02:18:07.007Z", "created_by": "d03ee6b64c1097b8ba176658", "last_updated": "1966-08-25T02:36:19.168Z", "last_updated_by": "e4b844e2dc58aa3264dc8bee", "lastUpdatedVersion": "labore exercitation Duis id", "tags": [], "canvasVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "est", "description": "Lorem eiusmod", "app": "do Lorem aliqua", "variables": { "error": "" }, "groups": [ "92ba29d84beb5cc15ec09944", "5c3ef2236abe9ef5de5d3a69", "0fbbde94c406b9f1b601b6a3", "8a57e6677fd5fe845eeb6683", "649306250a56bb923358ea5a" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "failure" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "48ded01809b1042a7bf74bd4", "b686ab26a07ce2909566e0b3", "90a873a656a82af2fe67c98b" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1980-08-21T04:44:50.211Z", "created_by": "b2a0da3bfffef5612be47947", "last_updated": "2020-01-01T08:29:00.915Z", "last_updated_by": "acafd4752eee0860a2406778", "lastUpdatedVersion": "minim aliquip Excepteur esse deserunt", "tags": [], "canvasVersion": 2 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "sit cupidatat ex sint", "description": "occaecat dolor do labore", "app": "cupidatat culpa Ut", "variables": { "error": "" }, "groups": [ "79b506e8830e316925282ed6", "37e2f8641cf0fe1bde8f66aa" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "failure", "error" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "28ad2f03586dd9fc7dea5b11" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "2012-07-30T18:10:05.504Z", "created_by": "63fb4032de6af7a3c0171bf7", "last_updated": "2008-08-15T05:30:37.178Z", "last_updated_by": "a8b06809d8afd5a030c5beaa", "lastUpdatedVersion": "exercitation Ut", "tags": [], "canvasVersion": 2 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "consequat eu non", "description": "dolor ut", "app": "consectetur sit", "variables": { "error": "" }, "groups": [ "375b45345553d054828bceec", "b2fa7203432348dbcb2c476e", "1d2c30993b536cefbe864bb2", "cc45eee356c7fcee376b1ad7" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error", "failure", "success", "success" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "2d0961b6c9a4c59b82c2d30f", "0b268d73f7df3bbf3d3f8750", "fd1be25f787f9b17e85d251f", "97fc8a6f92f82828aec529c6", "c7bfbc224aa042df24645c8c" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "Ut Duis in ipsum esse", "preAutomationTime": 5000, "font_size": 12, "created": "1949-01-04T19:02:37.831Z", "created_by": "b4411f2eba1e990d8d6565aa", "last_updated": "1977-03-18T15:13:30.591Z", "last_updated_by": "f6dcd1f812762ce428f1f360", "lastUpdatedVersion": "dolore mollit sit nostrud", "tags": [], "canvasVersion": 2 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "quis esse sunt sit", "description": "officia", "app": "eu enim", "variables": { "error": "" }, "groups": [ "c9042df1fc4ffaefe71502cd", "837916fbf78d0511a5f602e5", "58220be8558a83ec8a656af2", "046473f92f91be37480ea085", "a7c9b69cbd30f5796e5b48c6" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "f984d32910199d46e09eb202" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "pariatur est sint anim", "preAutomationTime": 250000, "font_size": 12, "created": "1995-03-07T04:13:08.937Z", "created_by": "61390bee5ed0553e96026da6", "last_updated": "1980-11-16T02:01:32.7Z", "last_updated_by": "0514adcfc1315fda49ace434", "lastUpdatedVersion": "Duis incididunt in", "tags": [], "canvasVersion": 2 } ], "total": 86537213, "start": -95875043, "end": -83581114, "count": -44377796, "next": null, "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." }, "next": { "type": [ "string", "null" ], "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results." }, "previous": { "type": [ "string", "null" ], "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results." } } }