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": 50, "skip": 50, "order": 1, "sort": "name", "include": "description", "exclude": "_id", "expand": "Lorem magna velit adipisicing", "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", "items": { "type": "string", "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": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "sed fugiat consectetur Lorem", "description": "nostrud ut eu laborum cillum", "app": "pariatur cillum ea id", "variables": { "error": "" }, "groups": [ "18f5c75b380de202e3e4a7ca", "d1b905d9606365783fa29f0b" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "success", "failure" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "b4abd269b999cd52891cce43" ], "_id": "4321abcdef694aa79dae47ad", "description": "consequat veniam officia ad dolore", "preAutomationTime": 5000, "font_size": 12, "created": "1997-11-03T11:13:02.683Z", "created_by": "e6322450aa0b5bff992ace65", "last_updated": "1953-03-15T09:40:10.987Z", "last_updated_by": "1fd10d94c888d03b1a5c60dd", "lastUpdatedVersion": "Lorem", "tags": [], "canvasVersion": 2 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "minim", "description": "veniam ipsum labore", "app": "reprehenderit tempor qui", "variables": { "error": "" }, "groups": [ "27a7e78207a10097ec988be1" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "9a45316a58a334b360f334c0", "df03933e75dc8c0530c69443", "4dccbe6419191bc0d928e3a1" ], "_id": "4321abcdef694aa79dae47ad", "description": "mollit aliquip", "preAutomationTime": 250000, "font_size": 12, "created": "2004-06-24T03:49:11.927Z", "created_by": "9390f09fe5c54dc0288f6b4a", "last_updated": "1963-09-30T07:26:28.294Z", "last_updated_by": "edf9c060235dae184138fd49", "lastUpdatedVersion": "esse", "tags": [], "canvasVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "consequat culpa irure dolor in", "description": "dolor dolore in ea", "app": "laborum in", "variables": { "error": "" }, "groups": [ "10fe6b68ca7f1b4a1dc8cf79" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure", "success", "success", "failure", "success" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "a3d4fc5d594fd0531d0104fd", "e7d05dca826aeb9fe7daf019", "726d876b7babf78e40169d7c", "e8049c8d588987606935cb04", "a81856ddd81030b0e883d98f" ], "_id": "4321abcdef694aa79dae47ad", "description": "dolor sint", "preAutomationTime": 250000, "font_size": 12, "created": "1983-01-29T18:48:44.687Z", "created_by": "7d828a3ec115d3944151832c", "last_updated": "1974-10-12T16:23:18.206Z", "last_updated_by": "79efaf6bb0385744be3d12dc", "lastUpdatedVersion": "laboris culpa", "tags": [], "canvasVersion": 2 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "nulla officia fugiat Ut reprehenderit", "description": "magna", "app": "deserunt occaecat", "variables": { "error": "" }, "groups": [ "e7601b7fe5cc5b1b196e179c", "6b69405b4d74cc5d72e1aa16", "946651d2bc77b996e7563be4" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error", "success", "success", "error" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "a8a4cd47891bf57767cef5d2", "19a440c9d14c3b8bef1be394", "6370fb20b510e0f4c42e1220", "0550142e10aa2ae55c2e39e1", "f4f8572f4b3839bb3a0bf205" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1974-01-31T16:53:47.133Z", "created_by": "7a23dda84142f9e883f5f0ee", "last_updated": "1991-01-28T03:54:26.506Z", "last_updated_by": "08fd98fa01f319a21cd07d64", "lastUpdatedVersion": "proident non eiusmod", "tags": [], "canvasVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "dolor officia Excepteur sit", "description": "enim occaecat commodo", "app": "sit", "variables": { "error": "" }, "groups": [ "149f97961345c8a9ea4c20e9", "4d7248ee19eceb08bd96fcf9", "e8bc9f229c006d0451ffec82" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "634c77eaeb6768c82d2ff793", "f56f39be31f96be4612c3bff", "579319b334b85fa9d92907ae" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1981-06-25T04:54:59.72Z", "created_by": "1ea7fe03c339358728d1db38", "last_updated": "1972-09-15T07:19:41.766Z", "last_updated_by": "ff42ae6edc7c97898f31ffd4", "lastUpdatedVersion": "ea qui", "tags": [], "canvasVersion": 1 } ], "total": -91034232, "start": 63894343, "end": -343232, "count": -28490893, "next": "amet consectetur sint", "previous": "elit in deserunt magna dolor" }
{ "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." }, "next": { "type": [ "string", "null" ], "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results." }, "previous": { "type": [ "string", "null" ], "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results." } } }