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": 25, "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": [ "70ab613b2d555ce228ffe9f1", "e44e383d4a24ff93553c8a1e", "b8902a8d11829be1d25c2424", "d41d7bb2ca90e5a5a9aae6a0" ], "nodeLocation": { "x": -33434668.6357323, "y": 83818139.153483 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "9309d1151a8ab99ec352568e" ], "x": 61269394.03453907, "y": 80712789.82283944 }, "error_handler": { "name": "childJob", "summary": "in enim", "description": "mollit commodo quis aliquip", "app": "irure ipsum", "variables": { "error": "" }, "groups": [ "38583c3e50cb9d9d7e1bb59e", "4f15e573ae77baf0dd5bd23e", "b692e744267d44770686d7b8" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "success", "failure", "error", "failure" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "25eee1e628c4f09fcada02fd" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1958-02-15T00:55:15.026Z", "created_by": "6853a861e0745b6445ab312c", "last_updated": "1994-12-07T12:37:19.443Z", "last_updated_by": "1f74a7c8fdd0c1e3ded36b81", "lastUpdatedVersion": "adipisicing", "tags": [ "cupidatat fugiat sunt", "Duis officia", "nulla qui ut", "fugiat do in dolore" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "7f04a65b49887cf3e7f57f6c", "ac421a52a45ff771e70b2576", "20f25878e4b5137a9071cdd1" ], "nodeLocation": { "x": 20213507.664889947, "y": 86225699.74725682 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "1e309075ad1791c253c4da67", "bebf7d2f5c14407b2a774789", "6fdebee589a9f6d445f33797", "3cb009717b26e2af71399a08", "7576a96e3acd9857c9d88f88" ], "x": -90738009.34018771, "y": -47892598.82409911 }, "error_handler": { "name": "childJob", "summary": "minim laboris", "description": "laboris cillum ex pariatur", "app": "ut", "variables": { "error": "" }, "groups": [ "dc79f8f863d16b212dfc0e98", "6d5817982e4e62b1434cab91", "7b5380edb44ebd2158195706" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "error", "success", "failure" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "c6abea84d8ed858c2a5a5ad1" ], "_id": "4321abcdef694aa79dae47ad", "description": "non laboris laborum ad nostrud", "preAutomationTime": 250000, "font_size": 12, "created": "1994-08-24T18:52:13.939Z", "created_by": "c9fc9a4e22d8636e0df819f1", "last_updated": "1963-07-22T09:43:49.661Z", "last_updated_by": "31d234688c85df1ceed9e1b1", "lastUpdatedVersion": "est aliquip dolor velit", "tags": [ "consectetur eu quis" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "4153baa37d97547f53de3612" ], "nodeLocation": { "x": -92872475.07983603, "y": 17869235.980839714 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "6c06ddde27ab26a36b5b92c7", "505293f29ba9c3764f5cef05", "fb648496e9815efdacc9987c", "fec506093f29ce45cc667547" ], "x": -79730769.39535768, "y": -58099142.615160204 }, "error_handler": { "name": "childJob", "summary": "veniam elit dolor irure sit", "description": "nostrud commodo dolore", "app": "veniam", "variables": { "error": "" }, "groups": [ "deac368147e9526d3b12dd17", "567af2b58aab45cb47120394", "2038e238f9e37a7ac4e6f2a7", "7abb5274bdba370b9237941f", "876c8e731cab8b9ceb7e7dbf" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "success", "success", "success", "success" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "b38294b0e0a7913ad0382db6", "31fb55d7cdb013d243b53ee4", "bc11288a360a120d7b147cdc" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1951-09-22T13:44:57.36Z", "created_by": "563533a6b45d19ce5e51fca9", "last_updated": "1992-08-30T21:59:58.518Z", "last_updated_by": "d0e6fb7649123d6d90fb468d", "lastUpdatedVersion": "ipsum dolore Lorem", "tags": [ "in in", "deserunt cillum anim dolore eu", "dolore consequat aliqua", "non dolor nostrud" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "f215fd05d9ed24c403f2fed2", "387477bbd218904f8852c21e", "75fbd00f139b3ab1305fe60c" ], "nodeLocation": { "x": -75196928.82426368, "y": 53916121.69706029 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "5110e9915d718c5b5f2d3b84", "9677f7b1baaeb2998eb94cd1" ], "x": -98015432.98320979, "y": 47707716.72147232 }, "error_handler": { "name": "childJob", "summary": "labore deserunt", "description": "non ullamco sed sit", "app": "Duis esse anim commodo", "variables": { "error": "" }, "groups": [ "8edd07be59adf6ae0ce8b5f2", "88b01067fd6507a90b0b2898", "b966d41ee678428356d5fc10", "7cfa6d3fd5cccf56d9508a86", "3e4faf8f3ddc3a2c32dd1ea0" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure", "error", "error", "success" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "f35ff6782fab9e37caf0578d", "49b7c87db372fabb8473e6a0", "770abc3220eec59b64f57f25", "78deb3e3b6dab2540294e93a" ], "_id": "4321abcdef694aa79dae47ad", "description": "irure", "preAutomationTime": 5000, "font_size": 12, "created": "1962-12-23T14:17:53.744Z", "created_by": "2207258259c78795e613f553", "last_updated": "1955-05-16T18:30:44.067Z", "last_updated_by": "578dd72551a2ba6c77387b5c", "lastUpdatedVersion": "amet eu", "tags": [ "ex sunt non sit", "ut sit anim sed cupidatat", "aliquip velit" ], "canvasVersion": 1, "encodingVersion": 1 } ], "total": 18286279, "start": -99313712, "end": 37416869, "count": -95365843, "limit": -47869494, "next": "mollit", "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" } ] } } }