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": 0, "order": 1, "sort": "name", "include": "name", "exclude": "description", "expand": "consectetur mollit ad", "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": "est laborum nisi", "description": "sed fugiat", "app": "aute veniam reprehenderit do", "variables": { "error": "" }, "groups": [ "f158797e80f88a3a3df4ab76" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "419dc5c16d5ae352a32e2916" ], "_id": "4321abcdef694aa79dae47ad", "description": "esse cillum dolor reprehenderit", "preAutomationTime": 5000, "font_size": 12, "created": "1952-11-29T15:14:28.226Z", "created_by": "807460a881474d9777cd6bb0", "last_updated": "2006-03-27T04:57:35.637Z", "last_updated_by": "878ea293a76f191268378a50", "lastUpdatedVersion": "veniam et proident sit", "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": "anim deserunt ea exercitation irure", "description": "anim irure enim", "app": "velit proident Excepteur", "variables": { "error": "" }, "groups": [ "f8f16fe41cca859352cd8edf", "9560831e56942dd12e3cce03" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "c5a63bb7a9623a4874d339a0", "51a7029ebef34ca509f46bf7", "328d9a2b55e6b91e03851e03", "806ab73a1da426f6ccce0dbe", "48fe57697973f8bd263d7b3e" ], "_id": "4321abcdef694aa79dae47ad", "description": "incididunt consectetur quis esse Ut", "preAutomationTime": 250000, "font_size": 12, "created": "2017-08-29T10:03:37.519Z", "created_by": "171e6e72e844383272cf1e68", "last_updated": "2008-07-27T22:29:01.762Z", "last_updated_by": "cdab6495a5aa777be76fc365", "lastUpdatedVersion": "anim ipsum proident dolore", "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": "incididunt enim consequat", "app": "eu", "variables": { "error": "" }, "groups": [ "fb5bd86e4805ea4ad471a399" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "9d1aaaf35b295528e8324232", "6d16cc1b61cf7da108ffa531" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "2008-12-23T05:11:27.367Z", "created_by": "c9da49b47843c58111f82d4d", "last_updated": "1977-04-29T13:35:51.861Z", "last_updated_by": "ec093456549fb0a38fd34f40", "lastUpdatedVersion": "id dolor amet", "tags": [], "canvasVersion": 2 } ], "total": -98215779, "start": -47188049, "end": 82434074, "count": -64640033, "next": null, "previous": "consequat" }
{ "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." } } }