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": 10, "skip": 1, "order": 1, "sort": "name", "include": "name,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": [ "f1b73933d86ff7e81a21f5fb", "f9e478560d1739c2d240792d" ], "x": 25179501.122961104, "y": -80660684.59647782 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "af2f275b241e59c683861d02", "bc625d7834eba71a0311e7c8", "51d80392c3a4e2e4835a9833", "06a19508dc11bafe8fe725eb" ], "nodeLocation": { "x": 73491811.26610857, "y": 54728794.074607015 } }, "error_handler": { "name": "childJob", "summary": "anim dolore nostrud ex minim", "description": "incididunt Excepteur tempor in officia", "app": "deserunt ullamco in ipsum eu", "variables": { "error": "" }, "groups": [ "81bed3784bde5256a9bdb261", "9a0f3bd38566ff68862199d9", "c0f93ea6e65961eb94205840", "f3019c87fa8921829af54a49", "ca0624dfced4c46f75668e9f" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "error" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "19b298a06c6d49ad79f433dd" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1988-06-28T18:08:26.884Z", "created_by": "eb5261175cba38628bf464eb", "last_updated": "1974-07-21T04:31:23.123Z", "last_updated_by": "5502bea17e7289c9c9d9f617", "lastUpdatedVersion": "labore exercitation laboris non voluptate", "tags": [ "aliqua et enim", "nostrud dolore", "aliqua pariatur", "sed in", "ex sunt commodo enim deserunt" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "d22f2454d83ba2055c0b1bd3", "e6833fa64d554484d8cbc852" ], "x": -55828564.264994584, "y": 61760204.18844992 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "9b8e635226d280c4f89fe27b", "d7876bc539e05fa1b7599315", "a6033494ebad72bfa93d681d", "9f5d9160b6103bc3df9ef605" ], "nodeLocation": { "x": -89041096.73530418, "y": -71382070.99422038 } }, "error_handler": { "name": "childJob", "summary": "irure id aliqua officia", "description": "laborum ipsum laboris", "app": "ut in quis ullamco consequat", "variables": { "error": "" }, "groups": [ "2f9856cb99ebbaf9e1aa0a94", "0eadd3cb5a1540c9c3d8b5b6" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error", "failure", "failure", "success" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "598d5329e8a91079a19b4024" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "anim", "preAutomationTime": 5000, "font_size": 12, "created": "2011-10-26T15:18:34.178Z", "created_by": "9d68694c972dd8c19d6302be", "last_updated": "1946-10-26T17:08:54.269Z", "last_updated_by": "774893f52cc9d648c6dcdab3", "lastUpdatedVersion": "ipsum ut sed", "tags": [ "non Excepteur enim", "aute amet eu voluptate", "ut", "aute exercitation et cupidatat" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "0fdc39425f561f17e51927aa", "3ffa608377bdc2fb844ded9a", "eea73b7fbc4b6fee2a3cd725", "7e00f08ca2f45db9af16d87d" ], "x": -30876686.31328398, "y": 6635904.336285144 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "6299817dd438cb566fbbfdef" ], "nodeLocation": { "x": 11607303.21703212, "y": -58122680.726124234 } }, "error_handler": { "name": "childJob", "summary": "culpa ut dolore", "description": "incididunt ea irure dolor", "app": "cillum dolor", "variables": { "error": "" }, "groups": [ "1eb373d1ddbdab51bdc3f119", "c7b1398a20ed35e60be48793", "f11ad5f75e2694d506482435" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "error", "failure", "success", "success" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "d9ef164519f2d11399a422d9", "aa2e981fa64b9036ac1dcf1c", "7eb7629c23c0d4b0fcc9a522" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "ullamco commodo voluptate", "preAutomationTime": 250000, "font_size": 12, "created": "2015-01-01T11:28:05.54Z", "created_by": "5d7f4c5e416158228c159678", "last_updated": "1962-01-18T16:44:38.021Z", "last_updated_by": "65e801cd9723aac3a3ba9b8d", "lastUpdatedVersion": "cillum ut eu minim", "tags": [ "Ut" ], "canvasVersion": 1, "encodingVersion": 1 } ], "total": -39279116, "start": 64510140, "end": -58978875, "count": 50282579, "limit": 87093332, "next": null, "previous": "eu dolor non exercitation ullamco" }
{ "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" } ] } } }