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": 1, "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": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "758528ed796049ece1a24f4e", "139de710099815c9ae920621", "1bee475ac5404ec8fba1d150", "5e8d2e8b0c9facb8af6b753c" ], "nodeLocation": { "x": 89985584.61922622, "y": 33555091.867290616 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "a991dd9bedcf55d4ac6bd3d9", "1bd1b9352133c88353cc6953" ], "nodeLocation": { "x": -27539792.853899807, "y": -44652355.58258595 } }, "error_handler": { "name": "childJob", "summary": "esse quis ut amet aliqua", "description": "minim voluptate amet et", "app": "aliqua dolor quis qui", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Sdy.Duic/~0" }, { "type": "encryption", "pointer": "/~1/J5U/ZRCT6/~1/PLRVOOBa/~1/ZD/~0/vKu/" }, { "type": "encryption", "pointer": "/~1/D0TQl/~0/ke0cu5+xe/E/~0/GK0Go,I/~0/PWNj" } ] }, "groups": [ "966b6649759f4e29c9890d70", "f07b864eba0790e650fe2a93", "1c002160abf7c5f532b440b4", "95f75437a1e034e096f9d88a", "8b6f4f9f8279e080fe442aba" ], "type": "operation", "nodeLocation": { "x": -95521728.654434, "y": -27064997.293050915 }, "deprecated": true, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "6f102fa54e2d02c096956d21", "6b04c9e7585b38d65e185931", "ac0f854e45c75f7fc823991d", "e38ea3a4c3c0ad6a729190e0", "ee998d7dc7dc734c1ce47598" ], "canvasVersion": 3, "_id": "43785b89-d501-f17d-97ba-08735aff1a54", "uuid": "08efd296-6426-0385-e572-c5958c936ac2", "namespace": { "type": "project", "name": "fugiat anim", "accessControl": { "read": [ "dolore nisi esse" ], "write": [ "irure", "eu", "aute consectetur", "consectetur laboris tempor veniam", "Lorem esse sed" ], "execute": [ "sed id", "irure", "consequat eu fugiat voluptate", "elit" ], "manage": [ "sint", "est anim dolor occaecat minim" ] } }, "description": null, "preAutomationTime": 5000, "sla": 93673071, "errorHandler": { "type": "ad", "name": "elit" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "8055a4d5cb440ce38e6e8d36", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "45430704dde67c68f5377719", "lastUpdatedVersion": "4.69.69", "tags": [ "nisi irure", "eiusmod velit", "officia sed adipisicing", "consequat" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/J/GZ9FGWN8l/~1/oIvB1YxRON" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/WS/Wcr/~1/~1" }, { "type": "encryption", "pointer": "/aGhe-/~1/~1/veRU4yi4BG" }, { "type": "encryption", "pointer": "/jnxyk" } ], "migrationVersion": 83225127 }, { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "d2f31d345883b39b393ef2ec", "e47b7f361b226a8167407c4a", "cf4ceabbd1431d43c2fb4d8c" ], "nodeLocation": { "x": -16436888.62342824, "y": 41303595.15790197 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "a0934320b7f7d0a4a2ecf778", "c36e857e0e14dbab1d38c681" ], "nodeLocation": { "x": -87352303.57927755, "y": 71012985.21565878 } }, "error_handler": { "name": "childJob", "summary": "est et ea aliquip", "description": "mollit deserunt enim", "app": "culpa aliqua consectetur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1" } ] }, "groups": [ "9b96967c0ba9d1cb539c47e6", "89e5bf8d8b64744648de0a27", "191cc8922756f8f054fb5bbe", "baa3e4bcb26a72b30b33fa19", "a9eb571a0bdca7644241cae8" ], "type": "operation", "nodeLocation": { "x": -23617718.717957944, "y": 51118342.5753023 }, "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "8cf98d56f3d7c2d82c2e9cd1", "c0ab1bdd15bc76aa58bce836", "d05c0d52adf3d1b2b8c69a8b" ], "canvasVersion": 3, "_id": "a86dba71-5b6b-6308-e84f-b10ee02b858e", "uuid": "cd2bfca5-8481-e909-5cbd-64dc1f996dee", "namespace": { "type": "project", "name": "proident dolore elit et", "accessControl": { "read": [ "adipisicing ea Excepteur commodo reprehenderit", "reprehenderit eu" ], "write": [ "nisi elit aliquip", "occaecat", "in", "sit ad consequat consectetur incididunt" ], "execute": [ "culpa exercitation officia fugiat" ], "manage": [ "ut culpa Excepteur magna id", "consectetur" ] } }, "description": "Push Config to Device", "preAutomationTime": 250000, "sla": -56620734, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "c2cfdf7143d31b7608d7833d", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "b0cf7973e7226b94dc483022", "lastUpdatedVersion": "4.69.69", "tags": [ "reprehenderit", "labore", "qui officia velit id minim" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/F/M+HxBQsn/~1/~0/tv/~1/~1/~1/~1" }, { "type": "encryption", "pointer": "/~1/E1oQ/,wT/~1/~1/yow6Z/mWRX6x/~1/~0/u" }, { "type": "encryption", "pointer": "/~1/T" }, { "type": "encryption", "pointer": "/~0/~0/~0/~0/~0/~0/HdOb9CgO/fh-UqqvLj/~1" }, { "type": "encryption", "pointer": "/~1" } ], "migrationVersion": 95811600 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "1cad2e728cd70ff0a328134d", "f25d006300911c295175c521", "0bb24369b12b06fe75ea44cc", "9776b7cd397b2badf4b95286" ], "nodeLocation": { "x": -50956908.351913154, "y": -7418473.141751215 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "b91c7cc4e33bf6108f1de62d", "4c1a8ff869852c3f5564acba" ], "nodeLocation": { "x": -1106711.7869687974, "y": -96822724.40047908 } }, "error_handler": { "name": "childJob", "summary": "et in dolore nisi", "description": "cillum", "app": "minim exercitation culpa", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/yMqK1W/oaJYo7+" }, { "type": "encryption", "pointer": "/Mu+/~1" }, { "type": "encryption", "pointer": "/rQ5v1QO/~1/D/mfVYiSIB" }, { "type": "encryption", "pointer": "/oUwHIBDZMN/MFcQbFzDIh/C.pB2/xw4+q/Dz3XC/~0/~0/qqeZ4H-.aOW/~1/~1/A" } ] }, "groups": [ "1715022d1f553f3f841db7e0", "771bd28868e431790b9347c3", "f10307474f34cf2b73ec545f", "6e55c019de7ed4683f241523", "aa0a507e0824316a7b8af950" ], "type": "operation", "nodeLocation": { "x": -1417823.8359011412, "y": -21300725.321098924 }, "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error", "error", "error", "failure", "failure" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "d397798620a3c3de1be3a256", "5b64157a08475cf4cea55573", "f10a1e1d34d6e1498cc362c9" ], "canvasVersion": 3, "_id": "f07b7a21-5b21-5a1b-971f-aa63c1d00f73", "uuid": "a2eb53d4-135b-77c7-80e1-d61158b63846", "namespace": { "type": "project", "name": "pariatur est cupidatat nostrud", "accessControl": { "read": [ "esse Excepteur consequat minim incididunt" ], "write": [ "irure minim non laborum", "Duis", "nulla cillum sit", "dolor Ut", "dolore incididunt ipsum irure nostrud" ], "execute": [ "dolor", "amet", "mollit dolore qui adipisicing tempor", "id proident officia minim" ], "manage": [ "elit", "voluptate", "deserunt occaecat" ] } }, "description": null, "preAutomationTime": 5000, "sla": 56785300, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "cb8c3914377938cdebcd4a09", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "a19779e8f8a3020bf17a787f", "lastUpdatedVersion": "4.69.69", "tags": [ "est magna cillum officia", "esse incididunt voluptate pariatur" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/DSJs/E/m6j-B,8S" } ], "migrationVersion": 38123443 } ], "total": -63022950, "start": 45993709, "end": 81192218, "count": 5521127, "limit": 11806510, "next": null, "previous": "dolor" }
{ "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" } ] } } }