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": 0, "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": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "e698e48e58c71bb6225fea33", "94cb809ee828a7cdf04691ee", "2f12ce627fea31958adfdc04" ], "nodeLocation": { "x": -83207457.53368591, "y": 17032889.474871874 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "870efa778b30ea0bf7fe10f7", "29ebb461f6884337f253f245" ], "nodeLocation": { "x": 13371015.224602401, "y": 93377558.71433195 } }, "error_handler": { "name": "childJob", "summary": "ipsum", "description": "elit aliquip ex", "app": "Lorem in in ullamco veniam", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/Y+qJ18PY/hgoiFN/G4tLCJDFw6e/fWmT-yb/MGN/fq5nb-C/~1/~0" } ] }, "groups": [ "46f16536eccd91b7078ded8e", "d9c2cd966b6edc66d5864ba1" ], "type": "operation", "nodeLocation": { "x": 42288996.17471519, "y": 44269764.82931501 }, "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure", "failure", "error", "failure", "success" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "b546fda378044dcee200329a" ], "canvasVersion": 3, "_id": "992f4a86-7685-c03a-bd12-2cc8b35d9ed6", "uuid": "6dc2202b-9cc4-f7b1-5ff4-f08bed6fdfa5", "namespace": { "type": "project", "name": "Lorem", "accessControl": { "read": [ "veniam occaecat velit exercitation id", "esse sunt ex", "laborum deserunt labore", "est aute ad sunt Duis", "cillum" ], "write": [ "laborum qui sunt pariatur ex", "Excepteur nisi sunt", "adipisicing", "magna labore quis" ], "execute": [ "dolor", "ad", "non dolore sed", "dolore", "in id Ut ullamco ex" ], "manage": [ "ullamco Excepteur non" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 250000, "sla": -77350880, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "a0c677e631887ece05c84a28", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "b0b6eb173ca8a6725d9ada42", "lastUpdatedVersion": "4.69.69", "tags": [ "tempor anim nisi in ipsum", "exercitation incididunt est do", "aliquip deserunt labore sit", "cillum", "aute veniam cillum" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/SU,/23J,MU/~1/f/~0/I/Wux/~1/s,Sw95" } ], "migrationVersion": 88814354 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "8bc56a879940063ac7b68ac5", "bfe71495180a63fb15aee60d", "557fb2ac8dff242c099fd1f5", "ba6c4071982289537750187d" ], "nodeLocation": { "x": 38315216.04029083, "y": -36370921.950933255 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "909f662acc9c4fde8d6f2e7a", "38a326ef12515ce628c6b32b", "7822589ce3e31029cb2b98d8", "0da8e3badd5626923f97297a" ], "nodeLocation": { "x": 71146860.69568968, "y": 63181005.2652114 } }, "error_handler": { "name": "childJob", "summary": "laborum ea", "description": "sunt cupidatat occaecat ex in", "app": "voluptate", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/uie07.EQ/~1/~0/n/~1/~0" }, { "type": "encryption", "pointer": "/bnWLtw8/yGw6BkxHbA2/q8sq/P/CVlF0/~0" } ] }, "groups": [ "abbb8b99827e12a8ad82a498" ], "type": "operation", "nodeLocation": { "x": 70675853.60251227, "y": 38592665.351080954 }, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "0285d354dcbe6b0ca9b0cccb", "bb00722e36028d871169ad6f", "cdc02d1e56479cb53a4bb096" ], "canvasVersion": 3, "_id": "374514a1-c417-0f68-6b99-e47d8fb3a3d0", "uuid": "5c54c742-42d6-d081-5b9c-93dac97f59d1", "namespace": { "type": "project", "name": "et sit in id", "accessControl": { "read": [ "et laborum magna sunt", "velit ex do dolore", "aute qui voluptate consequat dolor", "ea officia" ], "write": [ "consequat ullamco occaecat in", "nulla exercitation minim", "veniam pariatur", "quis laboris commodo" ], "execute": [ "amet consectetur ad", "ut eiusmod nostrud ex", "et in sed", "sunt cillum laborum ad irure" ], "manage": [ "esse", "laboris enim Duis commodo", "do" ] } }, "description": null, "preAutomationTime": 250000, "sla": -17811632, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "3ff1db36305664f39fb1ba08", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "58e501666a91f2e5d158e86c", "lastUpdatedVersion": "4.69.69", "tags": [ "consequat dolore" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/clHgXpY/T0WzLDs/gtxe+TP/es." }, { "type": "encryption", "pointer": "/mec7c7JA/~1/~0/~1/NR/~0" } ], "migrationVersion": 32100843 } ], "total": 68782325, "start": 56482560, "end": 28118460, "count": -15430736, "limit": -8775241, "next": "Ut do reprehenderit Lorem", "previous": "elit anim consectetur cupidatat" }
{ "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" } ] } } }