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": 10, "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": [ "52ed12c5579c4c8457a0bb47", "7ad2e8280d5ae8a8c3d27a8e", "688ce5ee894ae1c43803dace", "6d8438ed11e712dc90576d48" ], "x": -94589870.70082769, "y": -52909773.51111312 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "7a6a1d2034c3b21fdd436728", "63f8643a562eab45654196d7" ], "gridCoordinate": { "x": -59898841.81472385, "y": 20709732.559298784 } }, "error_handler": { "name": "childJob", "summary": "labore pariatur", "description": "nostrud Ut dolore minim", "app": "exercitation nulla", "variables": { "error": "" }, "groups": [ "6b45293a32fbeec5b913461a" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "failure" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "73b6e69c604c0c7724b28fea", "9cbf62a183f264398154fff3", "bfa7ae547ab73075bbe4dee0" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "ullamco dolore", "preAutomationTime": 250000, "font_size": 12, "created": "2003-10-30T09:35:04.092Z", "created_by": "702cbb480a3102b5d8a0e794", "last_updated": "1980-04-27T20:33:23.125Z", "last_updated_by": "89c6e311287411f326cc1e74", "lastUpdatedVersion": "et", "tags": [ "ut", "amet", "dolore velit nulla", "elit" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "e12b7026e409b8fdeb2e0806", "bd7f53ea7ff10a9786dad378" ], "x": -17814652.346788093, "y": -80690151.09983942 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "495ac0528b1640c0e452dd63", "e4f41bad49befbd697e15864", "af7635443180ed5d59803bd7" ], "gridCoordinate": { "x": -74193692.74055958, "y": 94306480.45865583 } }, "error_handler": { "name": "childJob", "summary": "dolore nisi voluptate quis", "description": "sunt dolor incididunt sint culpa", "app": "ea laborum", "variables": { "error": "" }, "groups": [ "8e26ff3ff810e7e08101070d", "1bf1dde3e90a06202453caf6", "cb5d8ad48087641a8cbd179f" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "failure" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "91d1c5e2b9fcb53f75d633e6", "344e1f78e64c2b71fce29a81", "7a9f8ef4de9d87f83e1d54ac" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1975-09-21T17:59:19.532Z", "created_by": "197aefa049faa7aaeb35f902", "last_updated": "1946-05-23T12:27:17.075Z", "last_updated_by": "3a87c7ece77fd54424dd2f6e", "lastUpdatedVersion": "eu nulla id", "tags": [ "dolor voluptate", "proident laboris", "proident" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "15bc55036afbc3d00ea4209b", "18a946980fdab008db8ef725", "a16c4a551d03bc5f2979fc65" ], "x": 85237070.46101266, "y": -15717842.287760898 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "1c107cc2579fffe7b295dfd2", "9768be39d25a5cd3049ab7d2", "64ea10778800e875bb849ecc", "7028dfa5d098d15e01f6dc2e", "a4f0a034d77e60c2866d8a73" ], "gridCoordinate": { "x": 90937631.17960796, "y": 79331417.34349355 } }, "error_handler": { "name": "childJob", "summary": "eiusmod deserunt eu", "description": "Duis", "app": "et nisi sunt", "variables": { "error": "" }, "groups": [ "cda480e64da66d26cde35d3c", "0ac527a344c29e061f5dbcb2", "fab0c639f8aeba835939221f", "b0e3168d6c0dfdc16dc701a8" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "error", "error" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "53f2bf8a7c1e79174f7eedbe", "b82e8162c5908552ee068bf3", "d9e9ff4ea7cc875617fba3db", "7f39684e3ba8d84a42776887" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "anim commodo elit minim", "preAutomationTime": 5000, "font_size": 12, "created": "2000-09-14T08:23:23.299Z", "created_by": "984496872325b5c048160dc8", "last_updated": "2013-12-27T23:59:31.895Z", "last_updated_by": "57741408d4ea8d2f75044194", "lastUpdatedVersion": "est in Excepteur esse magna", "tags": [ "in pariatur", "voluptate" ], "canvasVersion": 2, "encodingVersion": 1 } ], "total": 39567264, "start": -74675016, "end": 56908105, "count": -76880850, "limit": -70449866, "next": "Lorem nisi", "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" } ] } } }