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": 25, "skip": 1, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "expand": "sint exercitation irure sit", "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": "non velit quis", "description": "dolore ex eiusmod mollit deserunt", "app": "Ut", "variables": { "error": "" }, "groups": [ "a1a2d62cbcbee142dc608970" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "success" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "3d04d9ae04a451eba29a14d8", "96a593037c67fd0d6d26bc4e" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1985-03-18T05:12:50.244Z", "created_by": "b1f95588c8936a2e6b597f34", "last_updated": "1980-06-09T07:22:28.044Z", "last_updated_by": "9b2bdea5bf8a471072355218", "lastUpdatedVersion": "proident in consectetur exercitation", "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": "consectetur ad nisi exercitation amet", "description": "officia consectetur fugiat est id", "app": "labore sunt commodo enim", "variables": { "error": "" }, "groups": [ "177f85563ef9496aec4ddb69" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "success", "success", "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "be1642789459d6d03f9b0d00", "8d54acbeeb5313d9835e8e70", "00cfc6c3c32af588d6df33b7" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "exercitation do minim", "preAutomationTime": 5000, "font_size": 12, "created": "1987-09-10T21:48:15.844Z", "created_by": "6f5b9c33ca97b9b053ed7fff", "last_updated": "1947-07-23T11:24:56.37Z", "last_updated_by": "2ab45258b382b0dad8ba0839", "lastUpdatedVersion": "Lorem ut officia tempor pariatur", "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": "aute do in ipsum", "description": "labore Lorem cillum", "app": "velit anim in", "variables": { "error": "" }, "groups": [ "9e1cc1c225002d341e22318a", "8e7c1fed43e1aa7a7a69f20e" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "failure" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "753f4762131ae73f479920ce", "a5b1326066fce1d0a9d8101b", "6baacbcfbfdd79260f5e5c99", "efa07c790a12ef5408ab08a8", "f22dfe65ee9b022b68ea7beb" ], "_id": "4321abcdef694aa79dae47ad", "description": "eu esse nulla aliquip Lorem", "preAutomationTime": 5000, "font_size": 12, "created": "1956-04-08T04:01:21.51Z", "created_by": "37ca8cb0a5eaa31d38b75b16", "last_updated": "2000-03-15T23:00:38.477Z", "last_updated_by": "19212c30344a6538a91446ad", "lastUpdatedVersion": "velit", "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": "non Excepteur", "description": "Excepteur sint consequat", "app": "dolore commodo elit", "variables": { "error": "" }, "groups": [ "df97c71422c43413faf66f24", "1c8409df8196c04f23bf1d30", "c4dbdcae64d4592baf07c651", "4a7136e349b566adbfc43119" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "error", "error", "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "bf7849cea4d7ce4d89aaee66", "318547898137c3e0d10c4b6e" ], "_id": "4321abcdef694aa79dae47ad", "description": "sed", "preAutomationTime": 5000, "font_size": 12, "created": "2016-08-26T17:16:45.848Z", "created_by": "a65ffc6debf5387bac84585e", "last_updated": "1997-04-16T22:01:11.26Z", "last_updated_by": "d7c9585492b89db994696170", "lastUpdatedVersion": "Duis exercitation culpa", "tags": [], "canvasVersion": 1 } ], "total": 464739, "start": 59367424, "end": 33713839, "count": 48478720, "next": "occaecat esse Excepteur fugiat", "previous": "ea ullamco eu" }
{ "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." } } }