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": 1, "skip": 1, "order": 1, "sort": "name", "include": "name", "exclude": "_id", "expand": "est eiusmod reprehenderit irure anim", "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": "velit laboris dolor", "description": "fugiat Duis et aliquip pariatur", "app": "esse nulla officia proident dolore", "variables": { "error": "" }, "groups": [ "821adebed11f0f19c9bf6741", "49163814b10e67bc55471dba", "b86a5e6a440bba30019d6a8b", "0738db52d539e1815b49d6a5", "285f9260a3d5bce30ab09b98" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "dbba63cbd70fa2402c345133", "8cdf146512d58aa25dc7dc6a", "4a5b2e0b5f450d0d93e084f1", "143adfb8c33fcb1b08075464", "61476b6d9c5f45d077e670d2" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "nulla nostrud Lorem", "preAutomationTime": 5000, "font_size": 12, "created": "1954-12-30T11:28:25.894Z", "created_by": "c96888fd3f408432e864ee2b", "last_updated": "1948-01-17T08:09:46.002Z", "last_updated_by": "7b441664e8f4e6c0821cb507", "lastUpdatedVersion": "commodo dolore", "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 dolor in", "description": "Duis dolor anim proident ea", "app": "dolore", "variables": { "error": "" }, "groups": [ "5931b27133ea60493fc7e89a", "09b1a6f6908c5959f0164019", "636c287764e7e6b8be2bc39b", "c32ea941919c13d6dad87db7", "d65d5eef4f9c82f29fa27b8e" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "error", "error" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "5de3c691da9be2458b87c1a3", "a1bedfad6dca595c25301050" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1948-12-14T01:15:53.039Z", "created_by": "5c69e4c47d026bf523672d3d", "last_updated": "1972-10-24T12:45:49.357Z", "last_updated_by": "c4a85aa257e4dedfd9b27bae", "lastUpdatedVersion": "sit ea voluptate ad nisi", "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": "eu laborum occaecat incididunt officia", "description": "do Duis Lorem magna id", "app": "aliqua Excepteur quis", "variables": { "error": "" }, "groups": [ "008c220e54cec5442e7f50af", "8f4695b012526eb3908dd53d", "ff295b15062ebe64349fa3e3" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "failure", "success", "success", "failure" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "1ad5362acfa180f689fd7da6" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "velit adipisicing in", "preAutomationTime": 5000, "font_size": 12, "created": "1985-04-25T06:44:01.158Z", "created_by": "8ab2f3144bbd57efa593d36a", "last_updated": "1980-09-02T08:57:59.122Z", "last_updated_by": "2fe6f4475620143c3d9b78a6", "lastUpdatedVersion": "non qui Ut pariatur irure", "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": "ullamco nulla magna", "description": "ut qui irure", "app": "Ut non culpa laborum labore", "variables": { "error": "" }, "groups": [ "808cfb9925e014955ecfacfd", "f910a714144a39194106c7f9" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "success", "failure", "success", "failure" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "d35b88f3d2b63748c091b4e8", "a8b5b07337ad5457b40b990a" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1998-05-11T04:43:43.157Z", "created_by": "a860a59da9521c16b52677a1", "last_updated": "1947-02-23T05:33:31.517Z", "last_updated_by": "e8edb18ddfb2edea834e748e", "lastUpdatedVersion": "in sed ea aliqua fugiat", "tags": [], "canvasVersion": 1 } ], "total": 77963587, "start": -42703419, "end": 60629807, "count": 79149876, "next": null, "previous": "consectetur minim" }
{ "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." } } }