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": 50, "skip": 1, "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": [ "b5ba271282d77731c8641d56", "0df2367c9da0efb7afa6e70e", "f957f4e5d6ef8a6a9cabb9d5", "f1a7567e7bb207b6d53afc81" ], "gridCoordinate": { "x": -4871689.13548395, "y": 37111570.94532487 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "489379f44ad901ad4d21a921" ], "gridCoordinate": { "x": -35244848.20796214, "y": -49673727.666529864 } }, "error_handler": { "name": "childJob", "summary": "nostrud velit fugiat Duis ut", "description": "in ullamco consequat", "app": "commodo cillum", "variables": { "error": "" }, "groups": [ "4b5fe5ff454e15761d03d59d", "6636f47a80cb80ed7fdda111", "b3aed55563164053cdcd1e7c" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "success", "failure", "success" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "dd9a01a23904d20442794fbc", "f8353e43996b20cce62e3741" ], "_id": "4321abcdef694aa79dae47ad", "description": "consectetur id", "preAutomationTime": 5000, "font_size": 12, "created": "2012-11-29T00:45:44.024Z", "created_by": "54b880bee45792853daf9340", "last_updated": "1986-03-05T17:10:13.586Z", "last_updated_by": "917a2006f4b8acb8046923de", "lastUpdatedVersion": "in exercitation irure anim non", "tags": [ "et", "labore", "eu esse" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "99326fdc4dd9b3a2c400ae04", "464808c2bb2a6ffddac8da92", "59cb18345baf84b3d9656956", "9486a242678e3820098c2f3e" ], "gridCoordinate": { "x": -26889435.984688565, "y": 56482868.47995877 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "7e57e05cca4336562f2d50c7", "f27eda2a4e0b2ff2cac0ddfc", "ea4e7f46bfe815fe33066dcb", "983132e25815fac1dda4b82c" ], "gridCoordinate": { "x": 2517963.5795446187, "y": 29672483.91861044 } }, "error_handler": { "name": "childJob", "summary": "Lorem magna Ut tempor", "description": "adipisicing", "app": "magna", "variables": { "error": "" }, "groups": [ "0cf94228e9711f7ecf313227" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "success", "failure", "failure" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "d52f4960530f4deda377117f", "1a3d0f695dd0002410cf10e7", "d05371dfb9bbdb9c1a4e9a91" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1960-07-31T20:25:37.974Z", "created_by": "d50b57384e037256232b13eb", "last_updated": "1979-04-11T00:23:01.812Z", "last_updated_by": "eccc7922652750b788e1b1ea", "lastUpdatedVersion": "in in fugiat laboris", "tags": [ "magna ut nulla reprehenderit", "anim ullamco", "proident est quis occaecat consequat" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "5762644cb216f7d9e0acfe4f", "5af6e60fd435cb2034aabd06", "4205ce87372977f1e45589c1", "4a750477f12e9358b1d3f286", "a4504259b5926d6518b21dfb" ], "gridCoordinate": { "x": 14403502.237420887, "y": -63080258.32729909 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "71976c87388cc0733fb5c98a", "1ac1e058820003a222cbb16a", "76e1b42c8ed365082e19ce0b" ], "gridCoordinate": { "x": 22375947.558175385, "y": 95487886.50646585 } }, "error_handler": { "name": "childJob", "summary": "sit incididunt Lorem", "description": "esse", "app": "occaecat", "variables": { "error": "" }, "groups": [ "614ba480d602bda2122332f4", "e73e13b47b99f8d31281d883", "80bc34ed2efcdb1ce2631c57" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "f2440568c1d7ba0e558ac47c", "b9148a2cc478123734c05254", "b36e467ff0c6afe8226050f3" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2005-01-01T04:04:05.419Z", "created_by": "d41574e2502816bdf83781e3", "last_updated": "2002-11-02T05:03:02.549Z", "last_updated_by": "d315bfc8ac7e18cf9d0c5970", "lastUpdatedVersion": "cillum elit", "tags": [ "aute velit in tempor culpa" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "246d165304f2d04673a199ca", "46cc56f78858ac2b2b12b880", "72901e5735e0e5f0bb6668d5", "396d673d18f1a73b85768d17", "fe1fbf86da27f466e8c51f98" ], "gridCoordinate": { "x": 72621633.05895522, "y": -12880972.708976835 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "1d39e834d36c9eb5eec24357", "9475b39e778924ee35fa4d6a", "7b345a807a5aade1a4632282", "15c45eb5db35364e91c6fc08" ], "gridCoordinate": { "x": -23235586.309955552, "y": -23774254.926072255 } }, "error_handler": { "name": "childJob", "summary": "cillum exercitation mollit", "description": "consequat ut incididunt", "app": "labore commodo irure aliquip officia", "variables": { "error": "" }, "groups": [ "45d9f344329d86c7ef480b37", "280da0602b7330fabf9819db", "a8d10ea51e4169cd7ec93c58", "7b735094a4f3cc57fb3e0702", "c8663a22f60557c401b158a4" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "failure" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "7b6cdf8fcef4363c0dc66018", "eca3873abd997440e41382dd" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1973-06-06T08:54:19.592Z", "created_by": "69de2fb397595b189a12ee89", "last_updated": "2001-02-21T01:33:38.25Z", "last_updated_by": "2cba91735b3168dde6950c56", "lastUpdatedVersion": "aute fugiat laborum consequat Ut", "tags": [ "veniam sit ad esse velit", "sit quis", "in tempor ullamco nostrud magna", "culpa sint" ], "canvasVersion": 2, "encodingVersion": 1 } ], "total": 78429953, "start": -29807454, "end": 35478538, "count": -91216834, "limit": 64674507, "next": null, "previous": "Lorem quis laboris consequat in" }
{ "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" } ] } } }