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, and sorting workflow documents. For ‘limit’, ‘skip’, ‘order’, ‘sort’, ‘include’, ‘exclude’, and ‘expand’: Example usage in getWorkflows task -- ‘{ ‘limit’: 10 }’ Example usage in HTTP query -- ‘?limit=10' For ‘in’, ‘not-in’, ‘equals’, ‘contains’, ‘starts-with’, ‘ends-with’, and ‘task-equals’: Example usage in getWorkflows task -- ‘{ ‘in’: { ‘name’: ‘my-workflow’ } }’ Example usage in HTTP query -- ‘?in[name]=my-workflow' |
{ "options": { "limit": 50, "skip": 50, "order": 1, "sort": "name", "exclude-project-members": false, "include": "description", "exclude": "_id,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", "task-equals": "task-equals[app]=WorkFlowEngine" } }
{ "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" ] }, "exclude-project-members": { "type": "boolean", "description": "Flag which removes workflows from the results which are members of a project" }, "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" ] }, "task-equals": { "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", "type": "string", "examples": [ "task-equals[app]=WorkFlowEngine" ] } } } }, "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": [ "5c591dce3b06ae3158e44531", "67e7fb2f9c9ec9437c6342ee", "e408b7381c61e681c0231898", "02827ea4406b5123dc22f314", "b7d90a226bb19dce10190fb2" ], "nodeLocation": { "x": 1362347.5602529794, "y": -40539919.56797045 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "e0a9c46493fe9f4ba757b89c", "0d5db11c127314d3ddfeb609", "187a71fcadbc3658c3f2e3ce" ], "nodeLocation": { "x": 28701470.62217842, "y": 98951677.94945735 } }, "error_handler": { "name": "childJob", "summary": "enim velit commodo consequat nulla", "description": "Lorem occaecat mollit", "app": "id est sed ut in", "variables": { "error": "" }, "groups": [ "3c39eeae665d5a17eb2692d9", "59fc026b46b085fbbfd047b4" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "error", "success" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "696bc28d1669f0afa057945d", "d8cccea2d1de799a47de3471", "7da2c61571291231275fff97", "1be0e0981e10c27b5123091c", "a7a252a525f7e175cfc66ae1" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "laborum minim esse officia", "accessControl": { "read": [ "mollit", "sit commodo minim magna", "dolor Duis laborum Lorem" ], "write": [ "in dolore tempor anim proident", "culpa ex", "cillum consequat voluptate", "id", "elit" ], "execute": [ "et Duis", "sed nulla qui" ], "manage": [ "reprehenderit", "commodo aliqua laborum voluptate officia" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2020-07-09T04:49:15.277Z", "created_by": "5bff6335d797ae21187acae0", "last_updated": "1975-08-23T22:43:25.405Z", "last_updated_by": "4733c241ad7b042ae69d487c", "lastUpdatedVersion": "incididunt eiusmod eu", "tags": [ "velit occaecat dolore consequat non", "qui dolor", "enim consectetur" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "83ccfff5ac378134320593bf", "8660717d5489cd07d19db4b8", "137474d553bf58cd9f00b4a9" ], "nodeLocation": { "x": -75164939.30408266, "y": -75462294.52926756 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "dd7959803dcbb20387697aa7", "ea0c5f47162fbf37e0dc1167", "e6c52d5e2cc60a71236be0e5", "b9b6632ff8178f316f136be3", "3edbf7826020b3e5b6353b41" ], "nodeLocation": { "x": -57684702.715728745, "y": 92163266.03466824 } }, "error_handler": { "name": "childJob", "summary": "dolor Ut dolor Excepteur", "description": "nostrud sit magna sed tempor", "app": "cillum Ut non", "variables": { "error": "" }, "groups": [ "6edc0da0351c0cf3fa24f211", "7b65a46f75c353534bc74f72", "0f6ab2f800169cd8e3fe60c2", "d70dcc38b00b72803b0686bd" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "failure", "error", "success", "error" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "b092172a87d1304298147e02", "cb3e76a1ccf0822979ee0e0a", "5610119a385ba82849586adb", "15a5980f599d3203178219d7" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "amet laborum", "accessControl": { "read": [ "ut irure nostrud minim", "commodo eiusmod" ], "write": [ "in aute", "do" ], "execute": [ "occaecat exercitation fugiat", "culpa", "ut est cupidatat non", "ea sunt laborum voluptate" ], "manage": [ "ipsum incididunt mollit", "dolor Duis ut dolore reprehenderit" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1967-08-07T07:38:51.981Z", "created_by": "b9a6e502efe8904898f3af46", "last_updated": "2005-06-03T15:10:28.551Z", "last_updated_by": "8fc68f8993e249cb425073a5", "lastUpdatedVersion": "commodo aliquip ex irure laboris", "tags": [ "sed labore laborum" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "aaf9dd2128c7b3d6fdb83788", "b30f94d34659cc8694729114", "1f33f1051dd46d466ccab6b3" ], "nodeLocation": { "x": 25610660.254278764, "y": -68673958.50657338 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "d9bbf22f3bda1aa19580eacc" ], "nodeLocation": { "x": 5979570.750179559, "y": -34759425.69477284 } }, "error_handler": { "name": "childJob", "summary": "aliqua eu cupidatat aliquip laboris", "description": "dolor", "app": "consectetur Lorem do ipsum sint", "variables": { "error": "" }, "groups": [ "a5c59c7c45e97b5a22c15fa2", "bfc89cf1922a8cdfc91548c2", "2895e9c7460d2f827223acb0" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "failure", "failure", "error" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "9d6fbbc952f8f891cfd16a1c", "0cff7f75eaa168c0eea61d79", "1ea3aa4e385631dc1adbc358" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "officia occaecat in deserunt", "accessControl": { "read": [ "dolor", "et proident eu", "nulla labore" ], "write": [ "Excepteur enim deserunt", "veniam et mollit ullamco", "amet quis ut eiusmod sed", "consectetur sit aute do laborum", "mollit" ], "execute": [ "incididunt eu dolore", "occaecat elit in fugiat", "occaecat", "anim deserunt", "ipsum mollit" ], "manage": [ "in", "sunt Duis dolor" ] } }, "description": "laboris laborum officia Duis", "preAutomationTime": 250000, "font_size": 12, "created": "1996-11-11T22:04:56.261Z", "created_by": "dc5c7041ab8c0e46abdf749f", "last_updated": "1980-09-16T20:55:34.476Z", "last_updated_by": "27120fa490872d62f6680df1", "lastUpdatedVersion": "ex consectetur Ut minim", "tags": [ "ex reprehenderit", "Duis dolore incididunt nostrud cillum", "nostrud veniam officia" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "3d6ac5dccb3af37c35aa831a", "9614a547683bbad2d3fd00df", "62583d92843d94f292e553a3" ], "nodeLocation": { "x": 74546008.55341399, "y": -87200985.40229167 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "592a066904c1b2fbb8c1fc33", "01ec64f3642417c0e5c1ee86", "b2533fea3bc38cbd10968cd3" ], "nodeLocation": { "x": 38353057.837462366, "y": 89786355.8091375 } }, "error_handler": { "name": "childJob", "summary": "minim aliqua cillum in", "description": "sit ullamco culpa", "app": "reprehenderit ullamco adipisicing dolore", "variables": { "error": "" }, "groups": [ "f55b35d4f313788b2a535bb2", "11eaadfb08951ebc80ee9d36" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "success", "error", "failure" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "f76c765f56e7ead8b762f1d3", "8c3d2b90726e343b70d2fb8a" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "nulla laborum sunt", "accessControl": { "read": [ "aute exercitation Lorem dolore Duis", "nostrud aute" ], "write": [ "fugiat", "non Lorem veniam enim ea", "exercitation dolore non elit" ], "execute": [ "qui in elit tempor id", "sit magna id esse", "Duis", "eu sit", "eu voluptate" ], "manage": [ "sint" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1960-09-16T11:38:15.375Z", "created_by": "edc4025e1d85c18a5c241ccd", "last_updated": "1999-02-03T07:39:50.354Z", "last_updated_by": "b296424c78a744de69c29e2e", "lastUpdatedVersion": "ad", "tags": [ "officia" ], "encodingVersion": 1 } ], "total": 45902617, "start": 90093256, "end": 84773931, "count": 42254239, "limit": 63692136, "next": "occaecat", "previous": "sit" }
{ "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" } ] } } }