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": 1, "order": 1, "sort": "name", "include": "description", "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": [ "c00be860cbfd9fe1e9923cb6", "100c327d3efe938840e7147d", "f8fef2513aa0ea61dbe7232b", "5e16743961d3df721750c347" ], "gridCoordinate": { "x": -18118278.87586856, "y": 70346099.11439776 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "5accf7e99eb0f1c4c6e70a0b", "b070f17195e92d749dba8835", "92fec7b6a2dedf6628743d98" ], "x": -33818897.2913755, "y": -86441594.71649742 }, "error_handler": { "name": "childJob", "summary": "velit", "description": "incididunt dolor", "app": "Duis Excepteur", "variables": { "error": "" }, "groups": [ "6565b7d51ca9282bb4ef34ac" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "4b1917be5844efd372138568" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "elit anim enim", "preAutomationTime": 250000, "font_size": 12, "created": "1966-02-25T22:45:59.207Z", "created_by": "7816dd50953661a6af51c5d1", "last_updated": "2000-07-02T03:17:09.069Z", "last_updated_by": "11d59435ba980f7844dd4ff0", "lastUpdatedVersion": "esse mollit in", "tags": [ "deserunt", "nostrud mollit", "do" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "821a40849d6534e55e487cc2", "65eeb9b4b6daf35345ba665d" ], "gridCoordinate": { "x": -38316431.47822428, "y": 64789292.10524899 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "37cb4b840c72c46f1fe85ab3" ], "x": -8234749.360633045, "y": -19274064.300584912 }, "error_handler": { "name": "childJob", "summary": "deserunt ullamco ut magna aute", "description": "Ut", "app": "ut reprehenderit culpa", "variables": { "error": "" }, "groups": [ "f56fafbfda6e1712f63c3db7", "a5970c8ec700d89b26cb7ade", "fbf3cf4b3349bcfafbe2b53a", "564f1325a3d595a882aa6850" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "65cf95780183d74b826006fe", "908e3eade376cc8c08054422" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1948-02-01T00:14:53.842Z", "created_by": "f9cd11fcae0f3b89ae54623b", "last_updated": "1991-08-02T00:24:21.56Z", "last_updated_by": "bcb07ef561cbe194074c5668", "lastUpdatedVersion": "eiusmod quis", "tags": [ "in amet incididunt qui commodo", "occaecat cupidatat sit anim" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "28b66758e66356d2c25c0e05", "ca6850afd7e10530164c9930" ], "gridCoordinate": { "x": -27829283.44015257, "y": -44421964.47218603 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "4e17309eca478a1a10fcf9c8", "12e5342c9ef113dadfbe8538", "ac11395003d458c0163aca50", "a9ad34dd38c15967abdc1153", "5cae59f52fa070a75a082cc6" ], "x": 47516970.301053435, "y": -33489227.968598276 }, "error_handler": { "name": "childJob", "summary": "tempor est ullamco mollit sed", "description": "veniam Lorem cupidatat", "app": "eu officia", "variables": { "error": "" }, "groups": [ "0310ce07ffe36e0eba7bf1ae" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure", "success", "success", "failure", "success" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "3422e8fc92f73de5d6154c5f" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1953-06-21T19:51:46.108Z", "created_by": "5673edfbd5dde30fd439982f", "last_updated": "1987-07-23T08:23:18.538Z", "last_updated_by": "e5b124078d4c307ff0e04814", "lastUpdatedVersion": "consequat ad aliquip do", "tags": [ "veniam proident ea", "amet eiusmod dolor commodo", "dolore", "consequat officia dolore", "in" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "054bf2628504815195674a52" ], "gridCoordinate": { "x": 21937134.636888713, "y": 42824828.4733454 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "dd0049d6d815092dd93520dc", "69ea10ce4bc7131079aff75e", "61003c81a2ad819291703421" ], "x": 90315203.23711887, "y": 30593375.5914523 }, "error_handler": { "name": "childJob", "summary": "Ut adipisicing ad Excepteur", "description": "adipisicing esse", "app": "velit", "variables": { "error": "" }, "groups": [ "fcefa16eb51d594a14a76f7a", "998acaed6664b111f3b43731" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "success", "failure", "error" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "d95120033f5bea3bdeb18e57" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "incididunt consectetur fugiat ex occaecat", "preAutomationTime": 5000, "font_size": 12, "created": "1988-10-18T15:20:19.61Z", "created_by": "e6752a9a1a5e55a87f78a5f5", "last_updated": "2008-08-18T15:57:03.982Z", "last_updated_by": "12833999f1f82c8ee2e485fc", "lastUpdatedVersion": "exercitation", "tags": [ "laborum", "dolore cupidatat ea nisi", "sed labore fugiat", "dolor et" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "00f332740a109efe601ea3c5" ], "gridCoordinate": { "x": 77844326.17121872, "y": 51211317.29638475 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "9626408ef1d3fb10a6a08a7e", "590be8373de5294f88889e92", "92dae0a1ac5a02d9b9d154b7" ], "x": 56134937.231708586, "y": 53791105.67139116 }, "error_handler": { "name": "childJob", "summary": "nisi nulla sit", "description": "id", "app": "est exercitation aute sed adipisicing", "variables": { "error": "" }, "groups": [ "c5af1cb62150ff74c01a850b", "b6ea3afefde8a83e764ff752" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "34d0436960e2b0ba6b546bdb", "179409cc1e7fd749bff01979" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "2022-03-28T22:10:32.638Z", "created_by": "fad689df10d102512f02630b", "last_updated": "2011-09-17T09:47:18.291Z", "last_updated_by": "487ef857bdb3dc326468b424", "lastUpdatedVersion": "labore amet", "tags": [ "ullamco ut enim" ], "canvasVersion": 1, "encodingVersion": 1 } ], "total": -39061978, "start": 79086738, "end": -58163849, "count": 32912066, "limit": -72390505, "next": "id laboris ullamco adipisicing", "previous": "ipsum sint ut veniam occaecat" }
{ "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" } ] } } }