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": 1, "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": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "8f8bd0aa2a8651fa6a72218c", "aeb9e365b06d0ffca5b5f8bc", "361e14fe302d47c089c62f8b", "aa2a7d74e4ea7f632f72843a" ], "nodeLocation": { "x": -56923224.179558754, "y": -29685722.17667243 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "620a9b3a5cbd9eac796edd7c", "1a748f42c1dfcd561592a60d", "21380a844fc32e6f0ca2216e" ], "nodeLocation": { "x": -28969384.961258233, "y": -83447887.97786458 } }, "error_handler": { "name": "childJob", "summary": "aliqua", "description": "proident deserunt non amet ex", "app": "sint cillum", "variables": { "error": "" }, "groups": [ "e671e39cd4a2dc1f3eb47066", "2e26a8ea13b8ce38d8bea92b", "38f1175a4309f4ac438372e9", "7dd47ab07b431b56d66d7c35", "d4d2cac44d9346fd574e03d6" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "success", "error" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "4e54bbcc6c1d2213ca669a8c", "e3ace6e16ccfc662b3c34c20", "3d591c4b7cc37298c01b695f", "289462cf9b27a3097c980cf0", "89b6d92439781ad4388df157" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "ex Duis aute enim", "accessControl": { "read": [ "consequat ad ex enim proident", "sunt et eu", "minim do eu" ], "write": [ "commodo aliqua quis nisi minim", "consectetur" ], "execute": [ "magna", "pariatur labore quis in", "adipisicing est", "dolore culpa sint et deserunt" ], "manage": [ "aliqua officia consectetur deserunt" ] } }, "description": "veniam", "preAutomationTime": 250000, "font_size": 12, "created": "2016-06-17T16:03:49.579Z", "created_by": "cc3c96836cfe7df7f3b26d8d", "last_updated": "1991-09-12T04:22:18.425Z", "last_updated_by": "59d1215726a56b575c533e16", "lastUpdatedVersion": "voluptate cillum", "tags": [ "et enim", "sit ut cupidatat velit", "nostrud consectetur est commodo", "laborum", "Lorem" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "bc28a18c4c9119c4eeb0f8da", "db19c8283430350403e83eae", "4dec9e0fcf0c5c8ffc5eb22b" ], "nodeLocation": { "x": 59433266.60326815, "y": 1144227.391406089 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "c95a46c2a4d7f9c2cdf33832", "e17638f44349cfbe0053badb", "04b78e4fbb9a7f2e285c5fe9", "35e6030d54a2000a530df6fb", "064034f6de1fc080634c4413" ], "nodeLocation": { "x": 68388366.13705128, "y": -28363242.69169493 } }, "error_handler": { "name": "childJob", "summary": "enim do", "description": "nulla", "app": "dolor est enim ut", "variables": { "error": "" }, "groups": [ "bdb7882024a6795665dd409c" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "abaf2db4162d2303c07ab261", "3cd1fc0876cff8fe0cf2c9f5", "c89cfbd07b3206b37f66a884" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "nulla elit in", "accessControl": { "read": [ "in ex Duis" ], "write": [ "cillum commodo incididunt anim", "ea ullamco do ad eu" ], "execute": [ "cillum elit", "irure", "sed incididunt" ], "manage": [ "reprehenderit ut", "officia nisi voluptate", "sed" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1979-11-27T19:43:40.736Z", "created_by": "54ce628d277f0ceae66e12e0", "last_updated": "2024-03-01T17:05:16.1Z", "last_updated_by": "19790a5b0c235ce0034be446", "lastUpdatedVersion": "nostrud elit velit", "tags": [ "qui" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "a17a4781f0b56860fb1bbbc1", "cff83316dab31da2c81501f6", "f52d9ae69a1253625890d38a", "7ae9facc926a31132960bcfa", "e5a201c6878b6142a3eadf17" ], "nodeLocation": { "x": -10073430.654627204, "y": 99477606.5000984 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "70bc87c57e694f072a652cab", "6324921047b2372255324c40" ], "nodeLocation": { "x": -28625903.557370424, "y": -77607407.47844999 } }, "error_handler": { "name": "childJob", "summary": "cillum minim in", "description": "sed", "app": "aliquip Duis labore commodo in", "variables": { "error": "" }, "groups": [ "3fc161b864918e9717c5e888" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "success", "failure", "error" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "d76d4aaef860bc82bb8b0abf", "88a16fb18d45987152a5dcbd", "f24e0aa35fe3b9bf288254f5", "4c3b6a7f56888e2b9ff1493a", "1f359507f01f677f6dcc5494" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "consequat deserunt aute", "accessControl": { "read": [ "sit ipsum" ], "write": [ "quis id est", "reprehenderit anim consectetur", "Duis cillum in consequat", "laboris est" ], "execute": [ "nisi", "labore", "sint exercitation" ], "manage": [ "tempor consectetur sit", "nulla Ut elit anim", "cillum voluptate id veniam adipisicing", "dolore in in ut" ] } }, "description": "ipsum quis", "preAutomationTime": 250000, "font_size": 12, "created": "2015-06-26T16:47:49.143Z", "created_by": "4b8a057e610fffbeb14ca860", "last_updated": "1945-10-08T01:02:18.333Z", "last_updated_by": "e09d4285c7300d0993958418", "lastUpdatedVersion": "laborum pariatur tempor esse", "tags": [ "Ut esse Excepteur anim", "reprehenderit", "voluptate qui irure dolor cupidatat", "ut in culpa eiusmod", "sunt non" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "bfc7ec199cef10b953f42228" ], "nodeLocation": { "x": 69981160.39839002, "y": 78465534.31778759 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "7cdb19abcddae1ee6f750f1c", "98e555baa0916c85f255ed90", "959135f5761c2b87eb9a809b", "0f9fb26454bc17b17ff07589", "c6bdb40c2ff9706f90fa5b51" ], "nodeLocation": { "x": 49507494.5347417, "y": 16116732.452786714 } }, "error_handler": { "name": "childJob", "summary": "consectetur", "description": "Ut aute", "app": "veniam est", "variables": { "error": "" }, "groups": [ "5f58369d0fa9cca1cd6fbe01", "b880ef41a6e815800aef0c9f", "f22741b6ff7275eb0735af3b" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure", "failure" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "42f58b04189b47548270eac0", "3486aee9717e5904dd26b907", "b7877a55efe08c1cde670d00", "0c414ec80816082d5f3022e0", "6b468dd8845c71ba28822be7" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "occaecat", "accessControl": { "read": [ "in id" ], "write": [ "dolore et minim ut aute", "qui commodo", "pariatur eiusmod ea commodo" ], "execute": [ "dolore amet nisi", "quis qui consectetur", "voluptate", "laborum aliqua minim esse" ], "manage": [ "aliqua consequat ex occaecat" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1991-11-09T18:26:42.516Z", "created_by": "4182355eb2e6417ebbd0ef28", "last_updated": "1987-02-01T12:43:56.411Z", "last_updated_by": "dd41866fd9a39ac419e4f9e9", "lastUpdatedVersion": "nostrud dolor aliquip quis consequat", "tags": [ "est sunt magna dolore", "incididunt est dolore", "sint fugiat consectetur velit eiusmod", "aliqua" ], "encodingVersion": 1 } ], "total": -92233927, "start": -16380508, "end": 70015204, "count": -84496948, "limit": 26802050, "next": "nisi non ut", "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" } ] } } }