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": "_id", "expand": "aute nostrud pariatur dolore nisi", "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": "Excepteur incididunt quis reprehenderit", "description": "pariatur consectetur", "app": "dolor cillum", "variables": { "error": "" }, "groups": [ "5aeece699968ea3eb27f79ee" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure", "failure" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "04c65ff80a4da0fc44a8edb1", "16617f2a2fcec172dcd678ee", "a9bbbb966fb5a0619264cadb" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "2001-10-13T16:47:25.064Z", "created_by": "f659e25cda453e9b71693c98", "last_updated": "1983-08-06T07:14:33.427Z", "last_updated_by": "62dcddcf7ca76600c0439e57", "lastUpdatedVersion": "aliquip", "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": "ex", "description": "consectetur occaecat ipsum elit aute", "app": "elit", "variables": { "error": "" }, "groups": [ "ad647096a633c5ab8deac637", "7a98b9d0a4df12e10d49df29" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "701512982cdfb67e9f199204", "3cde00840ddd2650caa92f5e", "7fcf38ffd85253965f084e85" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1983-03-23T21:32:05.062Z", "created_by": "35d7b9da230aef1efc8b5af0", "last_updated": "2016-08-26T05:22:47.498Z", "last_updated_by": "35d15b5f22d35e38dbead9a2", "lastUpdatedVersion": "minim in elit ea ut", "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": "deserunt eu", "description": "minim sint veniam laboris", "app": "Ut", "variables": { "error": "" }, "groups": [ "6f4c1aae09a9ba65e5853354", "98033f0af432d137ad1c9f56", "e0db788c866a8ee5079454b9", "63cc3f2235f3c2ac1429143f" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "beeb64b215139914352dcec9", "17f1a5dedc0d39624b96670e" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1992-01-20T11:42:02.717Z", "created_by": "b46143c9a3ef4d5cbf62d636", "last_updated": "2011-06-03T18:17:12.897Z", "last_updated_by": "89cb8c2b78e582333f2637b7", "lastUpdatedVersion": "sit", "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": "cupidatat laborum minim magna id", "description": "sit esse elit", "app": "nostrud culpa laborum", "variables": { "error": "" }, "groups": [ "e60f0bb5fdb711c55c0865b7", "0fb9b5e5efa3291001ad21c5", "46d9b9999417f3b5ee6dae33" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "error", "success" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "09f4fe8a5e3cc12e7399eebd" ], "_id": "4321abcdef694aa79dae47ad", "description": "Ut Excepteur minim consequat cillum", "preAutomationTime": 250000, "font_size": 12, "created": "1993-10-18T08:20:25.461Z", "created_by": "3b002dcd9946a22ecedae126", "last_updated": "1960-10-09T04:39:31.773Z", "last_updated_by": "e74613d7be91deaba87e15ef", "lastUpdatedVersion": "id anim quis enim", "tags": [], "canvasVersion": 1 } ], "total": -71726922, "start": -32296626, "end": -52700619, "count": 29880876, "next": null, "previous": "irure" }
{ "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." } } }