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": 10, "skip": 50, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name", "exclude": "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": [ "809686faf06654e69e907cb9" ], "nodeLocation": { "x": 14508253.472131476, "y": 42842204.551062316 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "8b01e82be438942de917d410", "bea00e13e075e56d7de37b53", "dc87bbc464b2aa717f92fe9b", "1a5313c13ae1e784c12defba" ], "nodeLocation": { "x": -64798290.50737163, "y": 63342774.33788049 } }, "error_handler": { "name": "childJob", "summary": "in reprehenderit laboris ipsum commodo", "description": "eiusmod consequat eu magna elit", "app": "consequat", "variables": { "error": "" }, "groups": [ "33bb9cec9061ffd23908020d", "a842c3ecf10b25685b7b26a4" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "error", "failure", "failure", "success" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "1e3cfd0195391f60586151ea" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "ullamco dolor nisi dolor", "accessControl": { "read": [ "Lorem in", "sit esse" ], "write": [ "do qui reprehenderit", "do sunt occaecat aliqua nostrud" ], "execute": [ "exercitation", "sint ex aliquip dolore" ], "manage": [ "mollit laborum esse in dolor", "ut proident reprehenderit cillum", "esse pariatur sed", "eu pariatur deserunt id velit", "eiusmod elit velit enim Excepteur" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1967-10-18T01:04:07.748Z", "created_by": "0e25bb7e6d65cebe31426beb", "last_updated": "1977-06-18T14:23:28.081Z", "last_updated_by": "28544a6962e1af4271d7e512", "lastUpdatedVersion": "esse laborum magna deserunt dolor", "tags": [ "in incididunt eiusmod ex Ut", "sint in", "esse commodo aliquip sunt" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "a2d203110f6b947e9714371b" ], "nodeLocation": { "x": -30596286.811001867, "y": -73190567.68872768 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "59184ac1053e2c02976efe50" ], "nodeLocation": { "x": 54316298.57433796, "y": 22108063.026085615 } }, "error_handler": { "name": "childJob", "summary": "irure in Ut officia", "description": "minim adipisicing laborum Ut nisi", "app": "laborum eu in culpa deserunt", "variables": { "error": "" }, "groups": [ "26815b796e900fdba854c7eb", "e3616a005e0ea87b5e5f5bba", "239747f02b4389f64961ed7e", "4ed7037b4d3a01da94aa4faf" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "failure", "error" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "c78f1cf696eae6b1a1b9ee44", "060cffe0baf2d5911e4f8aba", "8a56b66502bfa970f7a325ae", "e1d6721ab38c6544b246ff1f", "0fdf6f0ae90f56e48fd35803" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "commodo", "accessControl": { "read": [ "culpa labore", "dolor Duis", "non dolor veniam" ], "write": [ "sed in aute occaecat ipsum" ], "execute": [ "cillum voluptate Excepteur proident veniam", "sit tempor laboris id reprehenderit", "incididunt", "labore culpa", "id non sit laborum pariatur" ], "manage": [ "non ad officia", "pariatur irure velit occaecat", "occaecat do ut ad eiusmod", "eu elit ea culpa amet", "dolore veniam consectetur sed" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "2002-06-01T11:19:32.077Z", "created_by": "8278291c986a78b771eaa0f7", "last_updated": "1978-04-17T18:08:16.041Z", "last_updated_by": "373dc715d944d72f09751ff3", "lastUpdatedVersion": "eiusmod culpa dolore", "tags": [ "id labore irure enim ex", "et elit", "eu", "proident esse" ], "encodingVersion": 1 } ], "total": -41830084, "start": -36111144, "end": -78992527, "count": 30505106, "limit": 66613991, "next": null, "previous": "dolore Lorem qui deserunt cillum" }
{ "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" } ] } } }