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": 1, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name,description", "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": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "7ccc1131ea0c0146751c3d16", "b6b1ad3785e0ed0df9a7ab0b" ], "nodeLocation": { "x": -72176772.25768177, "y": -45458918.6394804 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "ea002a587f6858791c1d203d" ], "nodeLocation": { "x": -12211221.493889868, "y": -52427697.04561518 } }, "error_handler": { "name": "childJob", "summary": "cupidatat sit in", "description": "sit proident cillum ut Ut", "app": "deserunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/MJefWb/~0" } ] }, "groups": [ "249a07fae990ca5cfcc514b8", "56b335bcf4fa4d0e98bff1d7", "3bd56194e34fbfd911e93f7c" ], "type": "operation", "nodeLocation": { "x": 22676837.902461022, "y": 24039246.158706725 }, "deprecated": true, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "aed5397107daf8ce1785ace3", "6bd6c5f6530c1ec6b2d04af5", "81e5ffb281ff130eeb2c60ea" ], "canvasVersion": 3, "_id": "1366afe7-0d84-132d-f771-600d4481715d", "uuid": "28891d34-52ff-c086-20bb-c40d8391cc5d", "namespace": { "type": "project", "name": "cupidatat mollit exercitation in", "accessControl": { "read": [ "et", "dolore non ut", "mollit ex", "laborum ea" ], "write": [ "id reprehenderit amet nulla", "qui aliquip eiusmod amet", "dolore", "ut sed proident dolore" ], "execute": [ "sunt", "incididunt aliqua nisi" ], "manage": [ "sed ex quis eiusmod Duis" ] } }, "description": null, "preAutomationTime": 250000, "sla": 93681905, "errorHandler": { "type": "velit fugiat et", "name": "ipsum quis anim" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "efdb3c988901021a1793c96a", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "3dac978b69f14f3baaf59640", "lastUpdatedVersion": "4.69.69", "tags": [ "pariatur dolor ipsum", "deserunt", "dolore ad", "Lorem" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/W9/~1/wJKK/~1/~1/lVMcdpwUjlO/~1" }, { "type": "encryption", "pointer": "/tYAL2xduDZ/~1/~1/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1/~1/Dg6pnvV/~0/sn/~1/AY/Dywu1/oTa2/~0/LQ1TRqpM" } ], "migrationVersion": 15327567 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "3d147bd3620f17f74d5c1650", "f063088bce969ebbe56f3e5e", "cea770d37341b2f64f680d5d" ], "nodeLocation": { "x": -82522685.93781075, "y": 41457476.242679864 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "715f3c6406a69b4df158ffb5", "145ebb30fabb22a399258c3f", "f3febe9660315dda31748c48", "94b1dfd147b882096bc4a38e", "c03c1850818983c2f25d0f2a" ], "nodeLocation": { "x": -59685626.16000344, "y": -57812671.67729531 } }, "error_handler": { "name": "childJob", "summary": "eiusmod", "description": "mollit reprehenderit cupidatat sint", "app": "eiusmod adipisicing sunt amet", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/ylYHLT/~1/sNNT5sbdNL/suYpvkSDM/l/~1" }, { "type": "encryption", "pointer": "/~1/DguD/Z" } ] }, "groups": [ "4409af5a1ca4ef9a05fa8e01", "fe5a483e539db1124ef00237", "23277e4ab1d8e7710ce70959", "58b889f2cb5f9987c5841cdc" ], "type": "operation", "nodeLocation": { "x": -95602749.90097094, "y": 78046917.05317625 }, "deprecated": true, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "4ca4e7f89643d61daf5b62d5", "36c36b519f72c1132e8d8993" ], "canvasVersion": 3, "_id": "114fe763-c2a2-8a80-3359-4d3b908d16dc", "uuid": "d6e2cbaa-719c-8ebd-c6cb-111240b62e85", "namespace": { "type": "project", "name": "ex", "accessControl": { "read": [ "ut laborum Lorem sit" ], "write": [ "aliqua voluptate magna anim cillum", "reprehenderit incididunt", "qui", "dolor dolor sit", "qui fugiat" ], "execute": [ "velit quis ullamco consectetur", "nostrud" ], "manage": [ "incididunt", "incididunt aliqua", "nostrud ex" ] } }, "description": "Push Config to Device", "preAutomationTime": 250000, "sla": 51079406, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "ec091975737854ace3cb272a", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "841966510ae8a772292e3957", "lastUpdatedVersion": "4.69.69", "tags": [ "in amet veniam ut Duis", "occaecat", "anim consequat mollit nostrud" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/wrQr/~1/~0/~0/KL26/~0/PJFviQ.j6S/~1/WkVnm/zfSs" }, { "type": "encryption", "pointer": "/~0/~0/FQtrgila6Y/faDj" }, { "type": "encryption", "pointer": "/~1" } ], "migrationVersion": 30314102 } ], "total": -67368134, "start": 32629128, "end": 98306954, "count": 35763239, "limit": 12631649, "next": "incididunt ut dolore", "previous": "eiusmod nulla qui veniam" }
{ "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" } ] } } }