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', and 'ends-with'. |
{ "options": { "limit": 10, "skip": 0, "order": 1, "sort": "name", "include": "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" } }
{ "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": [ "3414f4060355b1c8bd6595e8", "37ff0eda621e06afe4e7be4e" ], "nodeLocation": { "x": -94376421.20232135, "y": 92250106.21069583 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "98e09fa85df5f318757b1bbb", "e9d3a31aa541447c3b872911" ], "nodeLocation": { "x": 57922218.40063584, "y": 82886299.71625721 } }, "error_handler": { "name": "childJob", "summary": "anim enim consectetur", "description": "ut cillum", "app": "in nostrud ea", "variables": { "error": "" }, "groups": [ "8631680ea9cc1379c882c0a6", "3b27003f2b888b2c3f54d806", "12807a9b03f1cc2bc0d4d245", "1b4178528c2dbf9c352025a6", "2d0200b56df3378d6dbe9faa" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure", "error" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "56b656b926d0d67fc0a0d4d2", "8f4b0a0a51c2c8ebd49d9997", "a677e5818b02ea313ef2bf27", "fd14ee80ceb385ea0ded4077" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "occaecat pariatur magna cupidatat", "preAutomationTime": 5000, "font_size": 12, "created": "2010-03-23T11:13:15.515Z", "created_by": "52ad37290bae2b30fe327bbb", "last_updated": "1963-05-14T03:34:24.281Z", "last_updated_by": "059968a531d795eb8947035c", "lastUpdatedVersion": "occaecat adipisicing elit proident", "tags": [ "esse irure sed dolore Ut" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "04f685aa529cd113a0b7f0af" ], "nodeLocation": { "x": -7029261.316892162, "y": -3597546.4448926896 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "a8319d561c27d6e5b0174754" ], "nodeLocation": { "x": 15589463.572902143, "y": 27195895.42181304 } }, "error_handler": { "name": "childJob", "summary": "in sunt ut aliquip velit", "description": "labore magna in sunt", "app": "Lorem aute cillum qui", "variables": { "error": "" }, "groups": [ "658478c0c5c12f00c0947e12", "3822192bc6fbf3dbfd1918e2", "f762435d33ffc89a0ca38ca7", "8ea93398c7be80e45329cfb4" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "error" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "c0589b075fce7b5ce4cd1077", "1ead501801d92daec5ea6d6d", "e7e985ff5ab58f8b205876ae", "dfeebd6a8810372425432ed0", "c02c935285669534942c861f" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "dolore", "preAutomationTime": 5000, "font_size": 12, "created": "1985-04-04T04:55:43.813Z", "created_by": "a21b8aa6c2351f61b0130286", "last_updated": "1980-07-18T13:06:40.095Z", "last_updated_by": "cc84d2afdf6fb8d30f8c355f", "lastUpdatedVersion": "adipisicing Duis id", "tags": [ "incididunt", "ex Ut do", "magna" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "1219da016a9bcc947e0f0263" ], "nodeLocation": { "x": -38414190.86654798, "y": -81504702.38464908 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "1857c7ffd1c48bcff04b04bd", "438644a2a4604034c403a6a7", "8a560490918c5f31bd544eba", "bd6701e4cab2b4479d69eacf", "efea1088753687e29a6bd7ea" ], "nodeLocation": { "x": -32853296.04508899, "y": -88792735.25383452 } }, "error_handler": { "name": "childJob", "summary": "tempor aliqua", "description": "ut id do", "app": "ea officia cillum Lorem", "variables": { "error": "" }, "groups": [ "02377b903fc8648075f0bca9", "a74e8c9e5099e82d305bde93" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "success", "error", "error", "failure" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "8b2f8a64c7e8bdd6b4a03e9c", "5e15c6992ab39069011fb3d5" ], "_id": "4321abcdef694aa79dae47ad", "description": "non", "preAutomationTime": 5000, "font_size": 12, "created": "1971-08-19T08:08:43.886Z", "created_by": "3cc5fe0a62464e6a3b34159a", "last_updated": "2011-12-27T23:01:20.096Z", "last_updated_by": "1a9ad897b9a06845a5e27b75", "lastUpdatedVersion": "nulla ullamco et", "tags": [ "pariatur consequat occaecat", "consectetur aute non adipisicing enim", "elit ut ullamco reprehenderit", "cillum eiusmod id nisi" ], "canvasVersion": 1, "encodingVersion": 1 } ], "total": -79308899, "start": 12744126, "end": -52111335, "count": -18614727, "limit": -83591288, "next": null, "previous": "veniam et minim fugiat velit" }
{ "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" } ] } } }