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": 0, "order": 1, "sort": "name", "include": "name", "exclude": "_id", "expand": "sunt labore", "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 laborum mollit officia amet", "description": "enim Duis anim Ut", "app": "veniam", "variables": { "error": "" }, "groups": [ "952f11796328c444b480f571", "08502d45b75ff531e890d2e3" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "error" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "a1d5e6dfb6bfb13190ebc7d7" ], "_id": "4321abcdef694aa79dae47ad", "description": "eiusmod", "preAutomationTime": 5000, "font_size": 12, "created": "1960-09-26T21:57:56.829Z", "created_by": "e95c247c7b3be854f623f82b", "last_updated": "1963-07-09T13:14:15.114Z", "last_updated_by": "a334e4a22c86cf56263b1254", "lastUpdatedVersion": "ad nostrud consectetur incididunt", "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": "ipsum in sint do", "description": "nulla Duis sit mollit aute", "app": "enim nulla ipsum est eu", "variables": { "error": "" }, "groups": [ "e607483a63fb8af2a30874bd", "b17014e46f33a6aaab7b1d88" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "failure", "error" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "305c32ca4e60487e9620184f", "5f17a3d68af01127aa9d0866", "bc4d62a61421049dd92ff5a8", "46ee1d721f125e84679b57b3", "2e2ae69d889afc78a4ac4dfc" ], "_id": "4321abcdef694aa79dae47ad", "description": "dolor incididunt ipsum eu ad", "preAutomationTime": 5000, "font_size": 12, "created": "1993-08-12T15:17:41.066Z", "created_by": "ff426b9b8f8259424e4bef5d", "last_updated": "2009-09-02T21:47:25.993Z", "last_updated_by": "0631958efe479ab2838658e2", "lastUpdatedVersion": "ut veniam fugiat reprehenderit id", "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": "enim deserunt cillum nostrud", "description": "ut in", "app": "adipisicing amet sed", "variables": { "error": "" }, "groups": [ "f30e4a474d1bab7af28125e4", "2d2be0fcdcf845ee00ba4689", "6c4fb4987e6974cfa2c1818e" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "success" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "e9949deb283d622064535130" ], "_id": "4321abcdef694aa79dae47ad", "description": "nisi nostrud ea", "preAutomationTime": 250000, "font_size": 12, "created": "2013-04-01T20:57:12.212Z", "created_by": "a26e7023af7d8c7b40b39fcd", "last_updated": "1955-09-13T22:49:55.031Z", "last_updated_by": "77ad0541d1aa0fe1b349b61d", "lastUpdatedVersion": "occaecat ad exercitation", "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": "sint cupidatat irure sit consectetur", "description": "dolor", "app": "adipisicing", "variables": { "error": "" }, "groups": [ "1948286c4295f480ae27258b" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure", "failure", "failure", "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "6e52b771f1be6925a285dc8b", "9f4450ee9d60393b88989349", "c038bfdcf81ff12454c56bd6", "f24bc09174976509565b0167" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2006-05-04T00:42:24.997Z", "created_by": "d4b09254dc5883cdd9c860d2", "last_updated": "2004-06-06T01:22:39.669Z", "last_updated_by": "77fdf8cf4bd984c72d1bf42b", "lastUpdatedVersion": "cillum adipisicing non esse mollit", "tags": [], "canvasVersion": 1 } ], "total": -21216134, "start": -87786406, "end": -83125497, "count": 79405353, "next": "ut in aute", "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." } } }