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": 10, "order": 1, "sort": "name", "include": "name", "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" } }
{ "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" ] }, "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" ] } } } }, "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": [ "76d48047b65c5efa05357fdf" ], "gridCoordinate": { "x": 75856964.92150262, "y": 76932546.55411974 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "bf8b8effbe8057d62a2b5cdd", "2a6dbdbb388d4ed48bdc4736", "90a1f5bc3dcfa0b7afcd5537", "2e4da8e97fcdd1f35fb60004", "d67de54cbd529718164dd744" ], "x": -45542448.07251737, "y": -57792157.999444745 }, "error_handler": { "name": "childJob", "summary": "nostrud ut in dolore", "description": "pariatur Ut nisi eiusmod commodo", "app": "enim eiusmod", "variables": { "error": "" }, "groups": [ "d14d59266471df5aefd73d9f", "c4e26750d433cc31c4ee8e69", "5618eb942ca09a5cc1079401" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "failure", "failure", "success" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "c50d9688f1737f3b8eac4164" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1984-07-10T11:19:53.732Z", "created_by": "35a00bc4e8eef577e2139a5d", "last_updated": "1984-07-09T02:26:22.123Z", "last_updated_by": "08672f05a371d82c27e09dc1", "lastUpdatedVersion": "exercitation sit", "tags": [ "aliquip in in ex" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "a01731618428bf4e7c04ed62", "a8259d4df6cbf4ffe358654a" ], "gridCoordinate": { "x": 66595448.315844595, "y": -10146544.81657216 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "38e4a5b952ab3c6e4004851b", "8dfddd03dbef7768a8356784" ], "x": -72391941.42498225, "y": -37148923.401800275 }, "error_handler": { "name": "childJob", "summary": "reprehenderit sit in", "description": "laborum eiusmod aute sunt mollit", "app": "esse commodo", "variables": { "error": "" }, "groups": [ "2c94c2767ac717b8fddd7e61" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "success", "failure" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "2191ebbd0fbb205289ec8993", "33452f39e8aa81c41eec8126", "be2c895af5713e95de651bd8", "51de020ee11e61e915297b0a" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1955-08-23T22:37:49.389Z", "created_by": "5f90d9987480c0b27f73c4bf", "last_updated": "1979-07-27T02:21:24.146Z", "last_updated_by": "fe9c46340d03dcc479f4ce35", "lastUpdatedVersion": "ea ullamco nisi pariatur esse", "tags": [ "Lorem cupidatat in tempor" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "a6b03b5e9b39943134857d2b", "506cbbd60a982d62d353a75e", "c83afd69215c2cb62190098f" ], "gridCoordinate": { "x": -89383051.79669137, "y": -6357454.359215304 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "f159cbc4e673bfd8501f138f", "05470cfb397318ee3eb10c10", "9a000b5911915bff7612adc4" ], "x": -72490796.17942801, "y": -64160793.07232878 }, "error_handler": { "name": "childJob", "summary": "culpa", "description": "sunt consectetur anim", "app": "culpa dolor minim nulla", "variables": { "error": "" }, "groups": [ "420febbd9bcd8177989869b5", "20e4f22dd82f7f67c43c2bfd", "9207590ec3a2225e3ead6cab", "2b5ebc76c9222b94952c702f" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure", "failure", "failure", "error", "error" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "ce9c35aeafa99ffbbb58660e", "87a36f035fae58bac3fffe1a", "28ea529ff76fef66cbd43c58", "5b9146274899062df5425b99" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1965-08-16T20:25:54.715Z", "created_by": "d3ec8d0f7981b008dc0db80a", "last_updated": "2012-11-29T03:39:40.097Z", "last_updated_by": "218be43da175791744acb13a", "lastUpdatedVersion": "irure", "tags": [ "proident pariatur minim nisi dolor", "veniam ut commodo voluptate qui", "proident id commodo", "reprehenderit ipsum dolor elit", "mollit anim" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "de7bbd49a21ae6123f9839db", "621add48f77edea568dbf92b", "9e5438449ee75fe0c8558c81", "3935b906284740cabcbd473d" ], "gridCoordinate": { "x": 7370084.925873101, "y": -58846426.722441204 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "dda3eb57e7b2d71416c145f1", "967c4d14df80a1eaad1720c0", "ab679377335c8b224b287a02", "1e1cf778d98829bfd410d54a" ], "x": -93189336.37477839, "y": 26431990.668654352 }, "error_handler": { "name": "childJob", "summary": "pariatur incididunt occaecat in", "description": "Lorem laborum ea ullamco elit", "app": "dolore commodo Lorem", "variables": { "error": "" }, "groups": [ "12cd8a2d4cadf0d61b9983c9", "b984376c348c619a58793fda", "b7644e321f771d9c04652932", "1159cf2be501574626d103fa", "1344e20ce4cbb9c97303651b" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "65e2fa895c5780a9f82e3681", "bbd79d527a818f0d22067afb", "d6cab39159667514272674db" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2000-06-29T08:32:17.509Z", "created_by": "cef88808a10665ba6aa7495e", "last_updated": "1983-03-14T13:56:36.657Z", "last_updated_by": "fbd084a35e2b221112ee021c", "lastUpdatedVersion": "ad dolore sint mollit", "tags": [ "quis qui Duis", "cupidatat labore", "adipisicing" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "e811538ae3741dbcf0b218a6", "ac6fda23c5c803f9bb5c1319" ], "gridCoordinate": { "x": -57071177.785775706, "y": -4767338.577127188 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "5db90dd027bdf838f04a6cba", "8498571bdd88cf6290aa99a0", "482ec4503636a910bb3e3d5f", "b2745d9ab18cea12ea4cb6b3" ], "x": 26796201.941854388, "y": 62517197.19554329 }, "error_handler": { "name": "childJob", "summary": "consectetur nostrud", "description": "sed magna ad dolore", "app": "ullamco", "variables": { "error": "" }, "groups": [ "e044eaf0f21e3d632aa92daf", "ce59adb4fecad3962a269ece", "c1b8877d624069c97b58b510", "2089beb6dbcc0c9cb317752d", "004dad1237922132a7dcd67c" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "success" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "7d95b59435076f34bd86a3e6", "f9e4ac0bc1ec029e7e73e8cb", "5ca893e302dadaa3284c412d", "24182845276b1a008c79ef45", "6497822f2d095a5affa285af" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2008-08-12T12:40:54.445Z", "created_by": "08577d973e7c978e3021fe68", "last_updated": "1960-11-12T05:19:48.903Z", "last_updated_by": "5a71cd0c67abaf59b8d1ce8e", "lastUpdatedVersion": "ex ipsum", "tags": [ "incididunt do" ], "canvasVersion": 2, "encodingVersion": 1 } ], "total": -59026324, "start": 82758729, "end": -8748349, "count": 90453492, "limit": -31332378, "next": null, "previous": "deserunt irure" }
{ "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" } ] } } }