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": 25, "skip": 0, "order": 1, "sort": "name", "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" } }
{ "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": [ "c97b85466b6c0eb970365837", "d9a1bf903956ac6f78ab4d41", "2a3654be0adaa51c47ea88ed", "5374dec7c5fac6c1cec6277d", "3ce1cb35fef4f35fb5ec1c50" ], "x": 69577958.91797596, "y": -46660221.08310796 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "b1e7c6aad2714b61a0a609ce", "1a3e6a2f82620789b6a68f48", "e202d272b57c1fe6d71a8a11" ], "gridCoordinate": { "x": 24383718.57010977, "y": 59363816.89179456 } }, "error_handler": { "name": "childJob", "summary": "ullamco", "description": "minim aute reprehenderit", "app": "enim eu", "variables": { "error": "" }, "groups": [ "91f53cbac78d3b9fe41359ba", "ad4a216c58d693f658d06138" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "error" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "aebf0c81e78d9e48ab2e39a7", "e4040dd903f2d40c27ff34f2" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "voluptate", "preAutomationTime": 5000, "font_size": 12, "created": "1977-10-26T23:08:24.069Z", "created_by": "3be3f7f7da12e8c5c8aabfe6", "last_updated": "2010-06-26T12:59:22.699Z", "last_updated_by": "116e3b261b610ab4c3e62beb", "lastUpdatedVersion": "laboris ut esse Lorem", "tags": [ "aliqua anim pariatur" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "ba2b5d7043c4d58bffc4c25f", "bdad4d80bd33857d39ef9c03", "70340a8178fa4d03b297bb15", "76556f03e858d2bf48b8c8dd" ], "x": 22706547.091325298, "y": 7871682.628281593 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "8d31ed2bb32208a5fc531d6f" ], "gridCoordinate": { "x": 42980756.89498818, "y": -78585386.15429077 } }, "error_handler": { "name": "childJob", "summary": "anim sunt sed", "description": "amet eiusmod cupidatat Ut", "app": "tempor", "variables": { "error": "" }, "groups": [ "e37ab1362e4662d77d13ec85", "0c6f3c645c98720ba7ad885e", "9dda36eaf19677ea61a78eca", "acb7a0619f2538e209f357c0", "772ff005448ce6fcba1f2297" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "4091d99104826e4b2c2033b1", "980b4d7de19e782ea6d932dc", "40045b0d7827c81c74ff2b9f" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1980-09-10T14:45:32.46Z", "created_by": "91f71ae7d5f577e1a53efe92", "last_updated": "1954-09-14T06:18:06.458Z", "last_updated_by": "bdd5d9b1c401667ed0988a8e", "lastUpdatedVersion": "id aute do magna fugiat", "tags": [ "dolore ut", "consectetur quis", "reprehenderit sed", "sed ex dolor eu", "dolor cupidatat dolore voluptate" ], "canvasVersion": 2, "encodingVersion": 1 } ], "total": 22031547, "start": -79902460, "end": -97066033, "count": 65212371, "limit": -25573837, "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" } ] } } }