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": 25, "skip": 10, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name,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": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "1004a22a6c65437e28dde0ee" ], "nodeLocation": { "x": -1748993.3395219594, "y": 85207428.54320306 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "f07dd45874105be050f48be0", "df390c7aaf5faad8601ea188", "4ac2511021f2d8cb92e11f19" ], "nodeLocation": { "x": -1265305.3563382477, "y": 18197251.3015956 } }, "error_handler": { "name": "childJob", "summary": "commodo magna consectetur minim", "description": "sunt", "app": "sit proident ipsum anim laborum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/kT/~1/ldOJUQyZXLN/~1/D/~1/~1" } ] }, "groups": [ "fb12c980b07c4d08f1607c2d", "b764b04bc59fb0753db11e31", "0136b2471bfb35e18768ef70", "2cd043ba7a9cdb1f41acb450" ], "type": "operation", "nodeLocation": { "x": 30641908.60190679, "y": -65775412.59423794 }, "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "failure", "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "19dcc4722a2abb134a0f1e0f", "980061d5eeb6b4a28ff6f637", "45b55669f62ad90b5ce19ae1", "fd79a7ff6976071c5e346337" ], "canvasVersion": 3, "_id": "425208da-7b5c-c056-6355-a902aad7cd6d", "uuid": "4e18b36e-1fd1-b43e-807e-e46832b20c4d", "namespace": { "type": "project", "name": "commodo", "accessControl": { "read": [ "ut nisi sunt veniam velit" ], "write": [ "ad cupidatat pariatur in", "aliqua officia velit consectetur mollit" ], "execute": [ "reprehenderit ad", "nostrud nisi irure amet voluptate", "sit", "nisi ipsum" ], "manage": [ "Excepteur" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 250000, "sla": -12143211, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "7c739fb3da3bcbf7f897fdf3", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "eaf20465c83c3efaf044303c", "lastUpdatedVersion": "4.69.69", "tags": [ "ea do Lorem dolor veniam", "Ut" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1" }, { "type": "encryption", "pointer": "/~0/~1/uJEXzm/eDLVi9/v/~1/UkRtktpImq,/~1/j44EPl0/l5GrA2nlT" }, { "type": "encryption", "pointer": "/~1/~1/C/QY3O+7nX/HDF3D/~0/b-JBO3YpQ/~1" }, { "type": "encryption", "pointer": "/dW86QWL0/x9op/qTrtL1/~1/V+/~0/~0" } ], "migrationVersion": 40406925 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "15d9461cf36f81bfc709a030", "b49f88fe3c25ec000336a371", "73635f14970e5041639a9bd2" ], "nodeLocation": { "x": 26658142.363180205, "y": 33086320.41956629 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "54a9ba7ee215479454e7b3e7", "fecc8cf34dc9bfc6f6b6dd10" ], "nodeLocation": { "x": -19654489.032109976, "y": -84601347.75156103 } }, "error_handler": { "name": "childJob", "summary": "velit non Excepteur sunt Lorem", "description": "ipsum ex", "app": "minim aliqua ullamco", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Q4gRSbR/~0/x-qHWkcr27/j9WIP/PwWkLd//l5g+099o,/F/~1/~1/~0" }, { "type": "encryption", "pointer": "/~0/lLL,v5nsim/~1/~1" }, { "type": "encryption", "pointer": "/nsj/~0/B8w-+2O,X-e/~0/~0/DUOg/Kd/~1/d/~1" }, { "type": "encryption", "pointer": "/~1/B.klwmkZgm//FK+" } ] }, "groups": [ "5a43a59ffa41e3810632c0f8", "feadbae294d2503162a454e2", "5053d9cb2b9d0c4b7344db5d", "08d43d3001928c6e7749786c" ], "type": "operation", "nodeLocation": { "x": 71085531.5133143, "y": -10129371.944114015 }, "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "8eacf1872f588f87ea891bce", "61e876cdd08df13638fe7a3a", "ce053e2dfe65e2658b5923fc", "10cd1a5e5a3a303f14fcddf2", "c85d95dadd2b7db579125481" ], "canvasVersion": 3, "_id": "fdc67cce-ffb6-9ce5-8510-669c4da41cbc", "uuid": "0d184147-5eb4-dc72-8ecf-9a9fa9e6ac6e", "namespace": { "type": "project", "name": "anim ullamco", "accessControl": { "read": [ "cillum eiusmod ipsum sit sint" ], "write": [ "culpa cupidatat amet esse", "et mollit commodo velit", "Duis ipsum aliquip" ], "execute": [ "officia deserunt cillum ut ex", "nulla voluptate tempor", "veniam deserunt dolore est voluptate" ], "manage": [ "laboris", "aliqua cupidatat nostrud do", "enim in et labore voluptate", "sunt aliqua irure nulla nisi", "do deserunt occaecat" ] } }, "description": null, "preAutomationTime": 250000, "sla": 7522953, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "031d6a337ca56a9eb533a27e", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "a3df4c67ec11f88fb22a25ee", "lastUpdatedVersion": "4.69.69", "tags": [ "cupidatat" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~0/~0/~0/~0/~0" }, { "type": "encryption", "pointer": "/GmooAY2bGY" }, { "type": "encryption", "pointer": "/J.+ItXE/~1/~0/~0" }, { "type": "encryption", "pointer": "/~1/~0/M+PdOL7Id6o" }, { "type": "encryption", "pointer": "/Y/smXfChVz//Q-DxD2/~1/Rc4QF,kTK/GyufK/~0/Nwh/w/9rNd/~0/~1" } ], "migrationVersion": 68760354 } ], "total": -65690751, "start": 47999934, "end": -84282243, "count": -91657361, "limit": 37006204, "next": "do aliqua dolor enim amet", "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." }, "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" } ] } } }