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 template documents. |
{ "options": { "limit": 1, "skip": 10, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id,description", "expand": "consectetur sit cupidatat magna", "in": "in[name]=my-workflow,or-this-workflow&in[type]=automation", "not-in": "in[name]=my-workflow,not-this-workflow", "equals": "in[name]=my-workflow", "contains": "in[name]=workflow", "starts-with": "in[name]=my-", "ends-with": "in[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": [ "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": [ "in[name]=my-workflow" ] }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "type": "string", "examples": [ "in[name]=workflow" ] }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "type": "string", "examples": [ "in[name]=my-" ] }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "type": "string", "examples": [ "in[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": "ex ea dolor proident fugiat", "description": "nulla in exercitation", "app": "proident veniam aliqua", "variables": { "error": "" }, "groups": [ "adb7088056fe3e09d301e0d1", "61cd1681d6646af8f5a465b2", "9cc2b2f73b248ba8c94bd066", "b908cb4c623101067b6e4726" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "b4590770a93c86d969a3b91f", "69524e7c77f923a9e9e72d36", "2854e779d879eba25b3b8e2f", "bc32cc4d3486bfe80febca43" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "ut exercitation do mollit", "preAutomationTime": 250000, "font_size": 12, "created": "2013-10-12T13:02:59.949Z", "created_by": "80341bbf2516429670b49f16", "last_updated": "1965-05-05T03:21:51.028Z", "last_updated_by": "486b959b1022e4e17d5b964e", "lastUpdatedVersion": "et adipisicing dolore sed", "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": "nisi", "description": "magna", "app": "amet laboris", "variables": { "error": "" }, "groups": [ "4b652a11107504fc714bde55" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "39947feccc2eac44def841dd" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "aliquip exercitation tempor", "preAutomationTime": 250000, "font_size": 12, "created": "1946-12-29T18:08:20.045Z", "created_by": "10568e1f1c49292b272b16fa", "last_updated": "1997-04-11T20:03:00.735Z", "last_updated_by": "e78730f2de31f399c339dee7", "lastUpdatedVersion": "sint veniam in", "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": "incididunt", "description": "consequat ea elit ex", "app": "laboris eiusmod", "variables": { "error": "" }, "groups": [ "f69ed6511573e8fa89aab8ae", "fc773af85d640788a4cd3ee2", "a305ee79dae5b09191eea0b3", "2394ad449908616a7a200f99" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "success", "error", "error" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "df0fc9d8f5a69169482fe2c8", "ffd3fca4241e42e827674ae6" ], "_id": "4321abcdef694aa79dae47ad", "description": "sunt", "preAutomationTime": 5000, "font_size": 12, "created": "2020-05-10T21:55:14.832Z", "created_by": "9619d43ff6833f988e7717a6", "last_updated": "1957-11-03T00:07:12.522Z", "last_updated_by": "94ee971ce814bb5e1dd62e83", "lastUpdatedVersion": "ut dolor", "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": "commodo laborum labore voluptate non", "description": "in", "app": "incididunt dolore labore nulla voluptate", "variables": { "error": "" }, "groups": [ "17c42be5274c1c2442c1e2a1", "e7654c84d7f67e4c6eefe187", "30517ff9237edb15a73fae75" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "error", "success", "success" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "66b02674c04acbef677ba073", "d4608e0c80fede4624e40f02", "e14e3adfc661fbf27aa204ec", "2993a381dacc26846c414a8c", "1f24840eeca1631762834ad5" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2001-12-26T19:51:52.977Z", "created_by": "706868080eaf9ae823b6cfe6", "last_updated": "2004-03-17T19:00:18.798Z", "last_updated_by": "bf299370489e11c31c8e775b", "lastUpdatedVersion": "minim elit ullamco", "tags": [], "canvasVersion": 2 } ], "total": 78984413, "start": 27051148, "end": 22010776, "count": 77258511, "next": "in", "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." } } }