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": 50, "skip": 50, "order": 1, "sort": "name", "include": "name,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": [ "fd90223465e78656950c0e31", "4dc02e92afa175968ed93d66", "bd981e22d9206b10cfb9f7cf", "bd2d8b8307bb79947718fb96", "53333b1592cb13b4a3974490" ], "nodeLocation": { "x": 60908868.73518756, "y": 99339805.97294551 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "e0479df207fd1d6e1191ba94" ], "x": -14349801.690845922, "y": -45888366.14929366 }, "error_handler": { "name": "childJob", "summary": "reprehenderit", "description": "ex tempor veniam Lorem", "app": "officia est nisi esse", "variables": { "error": "" }, "groups": [ "1e5f637edba5dc0b9bb2bc36", "573465bddf513412dc4d4f3c" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "failure", "failure" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "c0d658148407d2f78eea66ff", "3bc8e79d6ade02374dd2b903", "553e9862f3ba58b6f1eb5e75", "abf9de293524e448d804976e", "506238cfbee360bd56a23753" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1989-08-04T05:17:46.245Z", "created_by": "c26a73e39c43d7a22361b083", "last_updated": "2012-09-26T14:26:30.477Z", "last_updated_by": "0fbbce453170c7d866ae97aa", "lastUpdatedVersion": "Ut", "tags": [ "sit aliqua sunt ut amet" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "66c76a7ea9f2611c80d1f738", "22c17bcfeba54fd772a793de", "d71b1f69c271ce27e3ed7b14" ], "nodeLocation": { "x": 50071210.29654166, "y": 40573132.995149136 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "6645a1cbd2fdc633f58f32fe", "1d6a74a4b05eaea3bcb6222f", "fa5e76aef056364cb2aca3d8" ], "x": 34650897.11812213, "y": -14127366.810479373 }, "error_handler": { "name": "childJob", "summary": "non", "description": "enim", "app": "sit adipisicing", "variables": { "error": "" }, "groups": [ "ceef85a7e6ada838fee5ed07", "5f5a8f4c1e563748c7d9305b", "7d34bba32105dfb10cafea5e", "7244783ad4f973603fdc314a", "06519a2f598f8cac4d435348" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "failure", "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "154c70bbb84c399e9bfc4da9", "3caf1ec03cd35b0fd2f35303", "b44c737d0aa80aa95b3197f5" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1997-07-30T11:15:42.271Z", "created_by": "4d9792977d61d874f1f2bf62", "last_updated": "2011-09-11T14:28:30.03Z", "last_updated_by": "fb025ff73eb5a5d816d4daae", "lastUpdatedVersion": "culpa sint", "tags": [ "id nisi in quis" ], "canvasVersion": 1, "encodingVersion": 1 } ], "total": 74217546, "start": 33323015, "end": -72034828, "count": 17401603, "limit": -7274538, "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" } ] } } }