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", "exclude-project-members": true, "include": "name", "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": [ "87d6b6b41379dfb448b953f5", "42e66301493e5ddeeb1859ac", "f0a733e851eba97076aef415", "6f664a7dbca5b9258ae63a21" ], "nodeLocation": { "x": 26383114.27373883, "y": 61522112.19467184 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "9db0c7cd1272133b5377572a" ], "nodeLocation": { "x": 58129250.984821945, "y": -20389080.28635125 } }, "error_handler": { "name": "childJob", "summary": "proident sunt voluptate commodo quis", "description": "laborum non eu", "app": "Duis fugiat culpa mollit", "variables": { "error": "" }, "groups": [ "5a380d7b4f648aeac980d940" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "success", "failure", "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "93bf21d34d313937e6b15b75", "d3a90b2af2871b90e1d87127" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "consequat", "accessControl": { "read": [ "dolor", "Duis irure", "incididunt" ], "write": [ "in et enim ut pariatur", "ex adipisicing laborum occaecat", "Lorem proident labore Excepteur in" ], "execute": [ "incididunt laboris", "aliqua pariatur", "amet Excepteur commodo in", "Lorem laborum in", "proident sit dolor mollit dolore" ], "manage": [ "eu dolore Duis", "tempor", "minim proident ad" ] } }, "description": "eu sunt pariatur", "preAutomationTime": 250000, "font_size": 12, "created": "1978-01-22T01:18:55.727Z", "created_by": "1e687e0f9537ee5dda7e4396", "last_updated": "1996-01-17T14:12:17.097Z", "last_updated_by": "89aae5ee4ce6957975e80882", "lastUpdatedVersion": "mollit labore laboris incididunt aute", "tags": [ "Excepteur pariatur id" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "cd06185ff15bf7fd7efcc429", "86dae2d043d132210a99b5ff", "b1476ca105bf445bd946e37b", "0969ce7bd3df8e77b7629cdf", "be4df4a08ecee7bfcb0fc0ad" ], "nodeLocation": { "x": 80741139.9750947, "y": 16684479.287055299 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "9ab54ca6dfe144ed16d484f1", "d6a6afe64a1fc48da0d0e0bb", "72e01a08ed269747b5890e89" ], "nodeLocation": { "x": 4331440.627281323, "y": 84622617.95252985 } }, "error_handler": { "name": "childJob", "summary": "aliquip tempor", "description": "Duis in proident minim Ut", "app": "officia sit reprehenderit laborum sed", "variables": { "error": "" }, "groups": [ "1cc325bd3b4ba4f8d25a056a", "6bce29c7055eb731b4ed87fe", "40fcffba15dd43930a23e8fc" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "error", "error", "success" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "0f59a6cd9bfaa004af126a69", "1eb1b29fb22ddc5b05a676b3", "803a88cf556fa98e0bfbb6f5", "f440f78f7ada8b23a09175f1", "39f1df76c232a1cfbd8db969" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "dolore", "accessControl": { "read": [ "aute", "tempor ipsum ullamco minim amet", "magna officia ex", "nulla" ], "write": [ "velit eu sit tempor", "incididunt Duis cupidatat irure laboris" ], "execute": [ "dolore Lorem ut consequat", "in non sunt", "in fugiat non dolor" ], "manage": [ "consequat proident", "in" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "2023-02-15T04:46:07.67Z", "created_by": "fee232fe860cdd7dc4886a0d", "last_updated": "1980-12-10T12:10:43.369Z", "last_updated_by": "9a1985d98dd740042bd0b5b7", "lastUpdatedVersion": "cupidatat sit tempor aliqua", "tags": [ "magna Ut sed ex" ], "encodingVersion": 1 } ], "total": -30186493, "start": 25895314, "end": 1743990, "count": 27336126, "limit": -60269149, "next": "quis laboris in exercitation dolor", "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" } ] } } }