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": 1, "skip": 0, "order": 1, "sort": "name", "exclude-project-members": true, "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": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "f0525e412046d49f9fbaa48a", "784a48e95cd2c05daf483434", "0a7613bf74c251c0e7968a30", "c5f3eacd58edaef495098af4" ], "nodeLocation": { "x": -45647505.077513404, "y": -65626829.91900939 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "d72886e667cd1fcf0369d74f", "a554148483b3adfc49242f74", "6cd4f1fc17b1c81cc58c8c59", "f3247471f07c8bd2e3970298", "55cf84c1e02dd156910812ca" ], "nodeLocation": { "x": -9126161.409426808, "y": -96099087.3350553 } }, "error_handler": { "name": "childJob", "summary": "qui aute tempor", "description": "amet ex reprehenderit", "app": "fugiat elit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/x/thFL2Wai/Z+Y1guan6GK" } ] }, "groups": [ "a749e4b15ffd6ba66de075fa", "1b6b9bd908e5c257154d69c1" ], "type": "operation", "nodeLocation": { "x": -7045958.544253007, "y": 17423615.8104299 }, "deprecated": false, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "2385112a71ad7c3cb04db1d4", "78e7386b9f96253436a52566", "ccbbfa5d7e71066c7a9565f5", "e0f8c044ef9cda81c16460fa" ], "canvasVersion": 3, "_id": "bf706866-babb-315b-91d8-9761b1e49051", "uuid": "0abc4ba0-6bd0-63f1-f43d-45999121f73c", "namespace": { "type": "project", "name": "occaecat mollit amet sed est", "accessControl": { "read": [ "deserunt adipisicing occaecat", "ullamco ipsum" ], "write": [ "anim cupidatat ut veniam incididunt", "Excepteur esse", "eiusmod et voluptate consequat" ], "execute": [ "dolore in dolor adipisicing cillum", "in qui", "incididunt culpa Lorem ullamco", "deserunt", "aliqua ullamco cillum" ], "manage": [ "labore dolor sit", "Lorem Ut" ] } }, "description": null, "preAutomationTime": 250000, "sla": -83505939, "errorHandler": { "type": "enim nostrud incididunt", "name": "esse non ea velit quis" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "cd8a5b65b92ab4b5d4423a9e", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "d0d31336e75f125b4068fa9e", "lastUpdatedVersion": "4.69.69", "tags": [ "quis culpa minim esse", "qui in", "mollit esse" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/Akj" }, { "type": "encryption", "pointer": "/~1/UqRN,oSH/~1/~0" } ], "migrationVersion": 38997777 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "a59d6e2cb3cd35852e5da964" ], "nodeLocation": { "x": -94441845.59871158, "y": 88714017.25989527 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "9d35b02792e8b7dc6887e2b5", "81a93d90b491d1cd7d38dcab", "c9d49768f740b9c32be9ea3e" ], "nodeLocation": { "x": -8843518.911217302, "y": 42733937.70549664 } }, "error_handler": { "name": "childJob", "summary": "fugiat Ut nisi commodo consequat", "description": "aliqua", "app": "ex Lorem consequat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/yK/OMUL/~1/~0/T6w2d" }, { "type": "encryption", "pointer": "/W/pkaMPVa/OR6PM/ls" }, { "type": "encryption", "pointer": "/FDIm/ES/YiXdiUV2zSS/i/Tb/~0/PfiVhY2f/~0/hU3qNS44DV" } ] }, "groups": [ "e8a804d947ef1d20397030a0", "3c1d569b4b98ece3c6122122" ], "type": "operation", "nodeLocation": { "x": -42014991.855953366, "y": -39793089.70048616 }, "deprecated": false, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "bb6aeb8409b62000ffb11437", "b36c904182e1fe57a3f0adc7", "14df23de6ed2b98c1a8502b0" ], "canvasVersion": 3, "_id": "edb36c82-3151-67bd-bc04-052c8d708050", "uuid": "f4045fa7-1870-36ba-ccdc-b31477911bbc", "namespace": { "type": "project", "name": "sit fugiat dolore anim", "accessControl": { "read": [ "magna", "aliqua", "dolore exercitation dolor in", "est fugiat ad adipisicing" ], "write": [ "esse deserunt sunt non consequat" ], "execute": [ "ad ex aliquip", "commodo elit" ], "manage": [ "enim", "consequat amet", "voluptate", "sunt" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 250000, "sla": 2836093, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "b9f0702e7186036c9bc640cc", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "2a996626d5faa3473dc54186", "lastUpdatedVersion": "4.69.69", "tags": [ "occaecat in dolore qui", "consectetur incididunt non Ut", "sed ullamco commodo", "aute et culpa in quis" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/zKv9/~1/m2Qy/r/~0" } ], "migrationVersion": 62887004 } ], "total": 26620413, "start": 44016880, "end": -57712646, "count": -49306374, "limit": 80862321, "next": null, "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" } ] } } }