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, projecting, and sorting workflow documents. HTTP queries for the parameter 'in' take the form of '?in[name]=my-workflow'. However, the equivalent task query would be '{ `in`: { `name`: `my-workflow` } }'. Same thing applies for the parameters 'not-in', 'equals', 'contains', 'starts-with', 'ends-with', and 'task-equals'. |
{ "options": { "limit": 50, "skip": 10, "order": 1, "sort": "name", "exclude-project-members": false, "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": [ "54502ac686c6ce617c4dd6e5" ], "nodeLocation": { "x": 52149460.67811215, "y": -33737349.407048754 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "0eb5dd67db2d2387f416b1be", "8e495f469f18ce468850ce77" ], "nodeLocation": { "x": 3194743.075686097, "y": 83012308.40465558 } }, "error_handler": { "name": "childJob", "summary": "et Excepteur labore in", "description": "labore fugiat ut aliquip sed", "app": "anim fugiat consectetur", "variables": { "error": "" }, "groups": [ "6c44290a02d3af4884512195", "7b0ea14717f02b95707c32d1", "306d0acddbc47f182287037b", "53cfe3bd5ca10aceb70f2155", "d1c5041d24178103269004f8" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "success", "success", "failure", "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "25c7e414c6831b304fc4cb59" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "minim deserunt anim pariatur ullamco", "accessControl": { "read": [ "laboris nostrud occaecat consequat", "cupidatat sunt aute", "qui eiusmod" ], "write": [ "nostrud in in anim mollit", "consequat magna in" ], "execute": [ "in" ], "manage": [ "aliqua elit ut nostrud", "occaecat aute mollit" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2009-01-09T03:21:38.922Z", "created_by": "50ce220e066bde53a2c2bf93", "last_updated": "1984-11-12T19:34:36.419Z", "last_updated_by": "a5c22e903c1a1eb45dd7f09a", "lastUpdatedVersion": "cupidatat mollit laborum est non", "tags": [ "exercitation minim in Duis", "anim elit", "commodo quis dolor", "eiusmod dolore tempor" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "6b51ab502245b603ac95bd36", "7be411e25fd26f7be628d67d" ], "nodeLocation": { "x": 16582113.47230117, "y": 13663052.16537103 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "ae5dfa9b91e5d13364cd5533", "3ab89e66fdb5519552d26578", "ed1c4b188bb098c4424a4273", "506b05100b2c629a9a7e8a07" ], "nodeLocation": { "x": 59911588.05714017, "y": 2344151.9564395547 } }, "error_handler": { "name": "childJob", "summary": "exercitation laboris ipsum ea reprehenderit", "description": "sed enim", "app": "consequat irure et dolore commodo", "variables": { "error": "" }, "groups": [ "a8e93024df3939a04ce9d9ce" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "failure" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "f15e9a42fac5f4da38c99968", "552d62586663e8d6edb2bd2e", "fce68c99d158217f14503fa5" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "officia laborum ad", "accessControl": { "read": [ "ut nostrud tempor", "amet nisi quis mollit", "dolor id voluptate" ], "write": [ "aliquip nisi exercitation aute tempor", "in Excepteur reprehenderit tempor dolor", "reprehenderit eiusmod", "adipisicing nulla", "velit" ], "execute": [ "non aliqua dolor qui" ], "manage": [ "minim magna occaecat quis ad", "sed non aliquip exercitation" ] } }, "description": "elit Lorem", "preAutomationTime": 250000, "font_size": 12, "created": "1957-03-31T14:58:46.588Z", "created_by": "cd1fa7d2e3b08b32e6d177d1", "last_updated": "1959-05-06T06:40:20.514Z", "last_updated_by": "c847c7239f58588b3557d4a9", "lastUpdatedVersion": "minim", "tags": [ "ad sint est ea" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "0f23829006b1f884450f365d", "7087d5d7da43bdc37639f373", "e8a2ea48cd117ad94d6220d9" ], "nodeLocation": { "x": 83292134.73883522, "y": 24904235.587018684 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "8f6b628f2118301a455cf038", "8bdc7da6a87684ac3e349817", "1231b6d2b5063bcbdc979e8f", "600652fd04d24227fbd93c52", "8bfa6affe33d64e8d3f8c328" ], "nodeLocation": { "x": 10714620.322131023, "y": -46998581.1544297 } }, "error_handler": { "name": "childJob", "summary": "esse", "description": "in id in velit", "app": "tempor enim", "variables": { "error": "" }, "groups": [ "1b3cc7a86441365347ca3995", "597a62bacd58f0788883d2dc", "174463f3283e974033c0821f", "69f328d3ba11abfb0414d3de" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "success" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "80b777fa4edeeb54993635e4", "aede6e96f206b2778bf9d8a5", "1a64e9ceda93740e231fbd1b", "9c0f78b5494c87a568323541" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "irure incididunt sint elit qui", "accessControl": { "read": [ "pariatur tempor do ullamco", "dolore sit do dolor", "eiusmod id ex ullamco", "aliqua fugiat minim" ], "write": [ "deserunt in aute", "ea Excepteur cupidatat consequat id" ], "execute": [ "Ut sit officia dolore", "incididunt nisi Excepteur consectetur", "cillum", "proident ut laboris fugiat", "nostrud aliquip id cupidatat officia" ], "manage": [ "fugiat quis id in", "sint ut dolore qui", "sit adipisicing tempor aliqua Duis", "aute" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1979-01-23T15:55:42.588Z", "created_by": "661e28cf39cd10ab7088dd03", "last_updated": "2003-04-16T18:01:06.762Z", "last_updated_by": "b33d2755b002b09c371b1c6e", "lastUpdatedVersion": "commodo aliquip sed cupidatat est", "tags": [ "minim", "in", "eiusmod id ut proident commodo", "dolore" ], "encodingVersion": 1 } ], "total": 32318322, "start": 28862967, "end": 27423303, "count": 87722110, "limit": -25086578, "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" } ] } } }