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", "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": [ "6eb49a6191fa584f55ef1970", "691579935d5e7cb18e8e42e7", "2982d24e309064f187ea6ee8" ], "gridCoordinate": { "x": 82312123.48305267, "y": 9454343.341149002 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "3d26014221d64ff302ed7ccb", "1a192e8fc07d0a8662846e33", "3eab6476012dc8cc6d3644c8", "ff9a0e61524c3856774e0c74" ], "x": 53478454.94444972, "y": -32982774.96918445 }, "error_handler": { "name": "childJob", "summary": "amet commodo Duis in", "description": "ad mollit sed ipsum", "app": "labore laborum", "variables": { "error": "" }, "groups": [ "65e11d56003d25953f2b21e0", "97b22e296bd55123055c9401", "c914871979674bf820659eb1", "101077e12a537154f81d8510" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error", "failure", "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "bf326a48507f996d5fbeb731", "0ca5a003ec55a64e85295ff5" ], "_id": "4321abcdef694aa79dae47ad", "description": "quis Ut nostrud amet sit", "preAutomationTime": 5000, "font_size": 12, "created": "1995-01-19T05:36:23.958Z", "created_by": "5e01d8cb2394732d75267584", "last_updated": "2024-04-20T17:45:01.277Z", "last_updated_by": "5b870577f95b4b450d75dcf1", "lastUpdatedVersion": "aute occaecat id aliqua", "tags": [ "dolore ipsum" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "7a4475e17df14771f280d4b0", "63af7983f42337961c73f17a", "2681a7d77508cbf7a485fec1" ], "gridCoordinate": { "x": 24901416.148914903, "y": 54353199.13789263 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "5c7c1afcc9eaba56f6de484e", "bf7dba59b84cd4014709b857", "7d3163c9dabe6f7ee054b744", "cbf974bdb0ce720fa5b8f203" ], "x": 81351212.36447805, "y": -4528888.611142084 }, "error_handler": { "name": "childJob", "summary": "velit voluptate tempor ipsum", "description": "cillum in sit elit cupidatat", "app": "tempor amet ut pariatur", "variables": { "error": "" }, "groups": [ "f767ee9d0e14dc9799ddcfe4", "99fda45fd54f86d064631ec5", "abbdf0d7b3b4ccaedcdc7ea2", "9e15c3f4032b70f11a41f9cb" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "dfa7b5fee75699f68e0bd81c", "69fa935ff614b38f35e72241", "2bb98a6f3f9bbb73e14efd77", "516f32a7be8e63367c6eaac0" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "velit est Excepteur mollit", "preAutomationTime": 5000, "font_size": 12, "created": "2010-09-25T16:46:34.277Z", "created_by": "dc9b3c162adf0cf2186029e4", "last_updated": "1949-02-17T13:40:19.169Z", "last_updated_by": "22145df79419299d80054653", "lastUpdatedVersion": "nulla Excepteur sed id deserunt", "tags": [ "dolore cillum in sit", "minim cupidatat dolore et" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "fd9df1d97b607374d51c8da1", "9a23aff51340798dcc230999" ], "gridCoordinate": { "x": 4899305.863624677, "y": 66685253.39152777 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "e2751d0ae051edbed6e250c0", "3b503a5e79b43aee27134f66", "6c2135c5840121739b7e30d7", "825928ff69b61eff901d185f" ], "x": 39780924.17077598, "y": -97622149.8292007 }, "error_handler": { "name": "childJob", "summary": "et pariatur consequat eiusmod mollit", "description": "sit", "app": "eiusmod adipisicing culpa dolore", "variables": { "error": "" }, "groups": [ "51e70a47552c8e3ca50d5676", "85eeba113cafbd8b1be89710", "5e7d6e49401ae42fcc53b7f1", "3d4758add4b5577fd87ffdfa" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "b8b8ec4f83c40dd83c3676af", "3d9a16ba35abb8af0abe2a22" ], "_id": "4321abcdef694aa79dae47ad", "description": "veniam ut amet", "preAutomationTime": 5000, "font_size": 12, "created": "2015-10-06T03:58:33.103Z", "created_by": "08b67c85e472e080724d4b5c", "last_updated": "1995-05-20T19:12:01.703Z", "last_updated_by": "767f82e08872b2b980626c54", "lastUpdatedVersion": "eiusmod sint aliqua Ut cupidatat", "tags": [ "deserunt minim velit nisi", "anim", "Lorem commodo enim ea" ], "canvasVersion": 2, "encodingVersion": 1 } ], "total": 61666792, "start": 19993142, "end": 37976096, "count": -86780882, "limit": 27913112, "next": "veniam in consequat velit deserunt", "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" } ] } } }