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": 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": [ "62200c33fdabd9e53c8877ad", "b1a8956dc368c5ff0ee51d0e", "9f2fcf81cf54a26d64d3ae40", "ff6fcb58671ddb24a3afb52e" ], "gridCoordinate": { "x": 8010630.844070077, "y": 15524110.270310536 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "7dab01f54a9b0b3db233aafa", "20b98b67dc5594c9057c3437", "6a06baa79ae0c005915d380f" ], "gridCoordinate": { "x": 11486387.707519978, "y": 46482586.312147975 } }, "error_handler": { "name": "childJob", "summary": "sint quis labore", "description": "voluptate mollit enim", "app": "aute quis non", "variables": { "error": "" }, "groups": [ "1acc7939edbded218871bcbb", "bd0ddccae0498d708c6e07ae", "3ac05b0f60e2ae5f46c00465", "ab7847344fc35e204e951369", "cb0e4bb057aa878c96a063fc" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "error", "success", "failure" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "77b28d9874b593ed23c4ed6c" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "sit esse voluptate incididunt laborum", "preAutomationTime": 5000, "font_size": 12, "created": "2006-03-19T00:48:42.173Z", "created_by": "49ba3cc6a35795190358f38d", "last_updated": "1985-09-18T06:03:45.285Z", "last_updated_by": "756fd89971531d8e8e57e73a", "lastUpdatedVersion": "laborum", "tags": [ "minim Duis do amet quis" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "16620f1904bb963b288a4cd8", "b7898f0c17710d1f5ba368b3", "5c6b87c3d6a35a38a3fbadc3", "f68c2ac772acbb285a14724b", "6a342255b1eb5ed9240798ff" ], "gridCoordinate": { "x": 25105876.39133762, "y": -55221913.96215472 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "d1ae876d6763f0ade3058220", "54dba9b11e3892a3d7d297c8", "853e8f0c62adf8b0bb4e7fce", "8f3d0bd3c41d74a75349d282" ], "gridCoordinate": { "x": 67604739.44389105, "y": -73854653.30871233 } }, "error_handler": { "name": "childJob", "summary": "anim labore dolor in in", "description": "ea", "app": "ex nulla proident veniam sit", "variables": { "error": "" }, "groups": [ "7defcc5468aea7a439b6fff8", "8c58643bb9a3491ae8d709a0" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure", "failure" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "5638674a359c8f9bd336d143", "42ec2346449bb7ac922746da" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "et", "preAutomationTime": 5000, "font_size": 12, "created": "1977-06-07T21:01:19.528Z", "created_by": "580fd81210131027760737d2", "last_updated": "1997-07-21T09:54:13.916Z", "last_updated_by": "d194032623d831a243ecb088", "lastUpdatedVersion": "culpa id ea", "tags": [ "eu dolore", "est consectetur Duis sunt" ], "canvasVersion": 1, "encodingVersion": 1 } ], "total": -34229951, "start": -53932797, "end": -82640446, "count": -37060440, "limit": -6483574, "next": "ut culpa", "previous": "ipsum velit cillum" }
{ "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" } ] } } }