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": 50, "order": 1, "sort": "name", "exclude-project-members": false, "include": "description", "exclude": "_id", "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": [ "9e44eed751502e9a4b4a34b7", "b0128000198974f478ae260f", "e0289aad525177ab8ce1fd9d" ], "nodeLocation": { "x": -5859001.398132831, "y": 192004.34653514624 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "406976141ac8a42100b70349" ], "nodeLocation": { "x": -90823128.23284373, "y": -34616868.86696968 } }, "error_handler": { "name": "childJob", "summary": "sunt", "description": "velit consequat sunt", "app": "occaecat anim", "variables": { "error": "" }, "groups": [ "028875f1bc0848e6a2d18dee", "d9a37ec4b72655a47ece2578" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure", "failure", "failure" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "0405cc0aaaa6f6587c340ad8" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "velit esse commodo consectetur", "accessControl": { "read": [ "cillum in in", "tempor laboris", "consectetur aliquip exercitation" ], "write": [ "non amet adipisicing cupidatat sit", "dolor quis anim exercitation voluptate", "dolor velit magna" ], "execute": [ "esse Lorem dolor", "dolor velit", "ut in velit nulla" ], "manage": [ "veniam Excepteur eiusmod sit" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1970-06-21T06:29:45.976Z", "created_by": "060871d49aaaaa9fb80ca9c6", "last_updated": "1946-04-28T09:39:36.588Z", "last_updated_by": "8208c2e93bbc8ea0ba943037", "lastUpdatedVersion": "aliqua velit ut sunt", "tags": [ "laboris esse in officia sunt", "magna commodo irure ea eiusmod", "ullamco", "aute sit consectetur labore incididunt", "Lorem amet magna proident" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "534af9f9ce8e54a43d9b8152", "b3b712617dcb999976bb4845" ], "nodeLocation": { "x": -54383402.027563624, "y": 39115599.93650505 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "f7e6b8bee8993f91b95086a2", "fc209f5d4c7cc10bc74626d9" ], "nodeLocation": { "x": -93750026.51548527, "y": -34519397.38485166 } }, "error_handler": { "name": "childJob", "summary": "laboris incididunt ex", "description": "commodo", "app": "dolore dolor", "variables": { "error": "" }, "groups": [ "21d75e9d97fbd21a2fb22a40", "5916f84515cfb90e45e586d6", "e536a76eb21c2df84724f487", "146b705a28a6951d0ef6ce91", "5f431c00d27ce92665a404ab" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "error", "success" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "bde4f4edbac1eebb5686262c", "b74590374766955aa42d58ce", "b8e15af0a48e221f6f8c3d39", "e3c1554f5557b13db28afba1", "5410650ffdea9898a2137668" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "aute elit consequat nisi", "accessControl": { "read": [ "enim reprehenderit", "sint nostrud" ], "write": [ "consectetur", "in quis", "incididunt aute in" ], "execute": [ "dolore elit", "elit pariatur eu dolor ipsum" ], "manage": [ "cupidatat in deserunt aliqua ad", "tempor in deserunt", "ea voluptate id fugiat", "proident officia consequat velit nulla" ] } }, "description": "Lorem quis est consectetur", "preAutomationTime": 250000, "font_size": 12, "created": "1985-09-10T05:58:44.357Z", "created_by": "ed921aead1df6668bf3cb1a0", "last_updated": "1985-08-09T18:46:41.602Z", "last_updated_by": "cb087f3a650f68522d77def3", "lastUpdatedVersion": "dolore et dolor consequat", "tags": [ "tempor qui", "consectetur dolore", "minim exercitation", "Excepteur" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "1c5f48a2f30bd61c11aa2479", "c16bf9452f0433540b59f3b8", "9c98288a5b868bfe8153917c", "27f88ce06d1fd87200eb532c", "28c4dd057fe638cef285b46f" ], "nodeLocation": { "x": 25232644.21122384, "y": -79818532.65509757 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "8d0917a7af07cec8dc2c8747", "49bbe7336df637aaab69eced", "54dfe5c7662077ecf60357ad" ], "nodeLocation": { "x": -5006563.210676789, "y": -85025050.90640086 } }, "error_handler": { "name": "childJob", "summary": "ad Ut in", "description": "sed veniam est", "app": "adipisicing enim", "variables": { "error": "" }, "groups": [ "5f42dbea1e7893685c9f1e82", "bd8555f62a41a3687f7fd48f", "7a7cef81d8a1bee3b37e49f8" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "5ce2ca37abfa41ae3271f02d", "36616dca239495364209fd60", "b076daf4fd74ecf6d173fd30" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "culpa dolore ea officia consectetur", "accessControl": { "read": [ "dolor voluptate in et cillum", "quis aute veniam", "est" ], "write": [ "mollit proident aute dolore" ], "execute": [ "fugiat exercitation consequat", "incididunt est officia", "fugiat eu", "labore proident qui laborum amet", "eiusmod enim labore nisi" ], "manage": [ "commodo ea", "esse laborum dolor in", "ad enim Excepteur", "est pariatur" ] } }, "description": "ut tempor", "preAutomationTime": 5000, "font_size": 12, "created": "1988-10-26T06:36:55.963Z", "created_by": "b76dd668c02534623d9d481b", "last_updated": "1981-11-05T19:46:00.295Z", "last_updated_by": "0e70500caeb2d1f9302918f3", "lastUpdatedVersion": "aliquip", "tags": [ "culpa" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "a4603c3f0462e956bb4953ba" ], "nodeLocation": { "x": 79582293.50930572, "y": 44143240.68619177 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "dea56f3edd2231e96d0a1b6f", "ecaefeba3ea39c29a131373e" ], "nodeLocation": { "x": -31286945.832331806, "y": -10069984.685544401 } }, "error_handler": { "name": "childJob", "summary": "laboris", "description": "anim", "app": "officia consectetur", "variables": { "error": "" }, "groups": [ "107937f993c1bd3a768f7278" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "error", "success" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "95ff3005f446a7958761605a", "a0d5ef6f9b5393df702df494", "c4799b8329e25383b9dec429", "edd29c0d88c03c0655058d80", "a9f51f326cd1acec2cb71d9f" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "dolore", "accessControl": { "read": [ "aliqua ex dolore do" ], "write": [ "Excepteur laborum elit", "nisi eiusmod Excepteur pariatur nostrud", "adipisicing Lorem", "sint eu quis" ], "execute": [ "exercitation eu fugiat non", "minim aute", "laborum in sunt tempor enim", "Ut dolor ex sint consequat", "culpa" ], "manage": [ "in qui in laborum", "do", "dolore", "culpa" ] } }, "description": "sit qui exercitation", "preAutomationTime": 250000, "font_size": 12, "created": "2022-01-09T17:59:17.795Z", "created_by": "e02521ef1e82a766b052d9b0", "last_updated": "2017-05-27T04:26:30.248Z", "last_updated_by": "80966d370cf774d967e7f0ea", "lastUpdatedVersion": "fugiat", "tags": [ "dolore minim ad cupidatat et", "dolor aliqua minim" ], "encodingVersion": 1 } ], "total": 52178616, "start": 76292347, "end": -11378648, "count": -29408900, "limit": -54975810, "next": "nostrud", "previous": "minim" }
{ "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" } ] } } }