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', 'ends-with', and 'task-equals'. |
{ "options": { "limit": 50, "skip": 50, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name", "exclude": "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", "task-equals": "task-equals[app]=WorkFlowEngine" } }
{ "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" ] }, "exclude-project-members": { "type": "boolean", "description": "Flag which removes workflows from the results which are members of a project" }, "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" ] }, "task-equals": { "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", "type": "string", "examples": [ "task-equals[app]=WorkFlowEngine" ] } } } }, "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": [ "5e24517b3de9f326040e75f9" ], "x": 72690935.266417, "y": 62143815.82588127 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "c7460260ee34c08f9802fcd4" ], "gridCoordinate": { "x": -67523228.16685075, "y": 59614332.3235102 } }, "error_handler": { "name": "childJob", "summary": "laboris nostrud id aliqua ullamco", "description": "fugiat nisi", "app": "pariatur dolore do", "variables": { "error": "" }, "groups": [ "a4fd8cc2c921008a54c7d450", "180102fdfd66befeeef86e12" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "failure" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "15d68d4a86dc091f4993f83b", "ab5a98ff9d33691dcd20ff5c", "f7a8731f235e62d9ce04369c", "3faa7b5b2baa56aa0653ebf5" ], "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "quis nisi nostrud", "accessControl": { "read": [ "amet" ], "write": [ "quis" ], "execute": [ "in in do ea", "aliquip dolor in deserunt", "exercitation", "ullamco dolor incididunt" ], "manage": [ "do ut dolor consequat in", "laboris tempor sit" ] } }, "description": "nulla", "preAutomationTime": 250000, "font_size": 12, "created": "2008-08-03T14:39:57.952Z", "created_by": "81691accebddf3eec98eaf2b", "last_updated": "1956-07-02T05:20:28.822Z", "last_updated_by": "0820c34621d483e3954aaa9a", "lastUpdatedVersion": "fugiat culpa ad", "tags": [ "anim velit id Ut exercitation", "commodo enim Excepteur sed laboris", "officia ipsum dolore", "dolor occaecat" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "9ccf70c3cba7f051ae38a2a6", "a1cc923f58b66925f3d3bb73", "a49313496538f93edf76f20b", "99c9c6f80e3f2baa3fd0fafa" ], "x": -29987111.143483773, "y": 25026108.235273093 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "9fef94a6d0ca68f955b489e3", "f6b0226316444d45572aed14", "bd475e48b8828cc7f18a6797" ], "gridCoordinate": { "x": -3775328.42130664, "y": -12095750.750784174 } }, "error_handler": { "name": "childJob", "summary": "ex Ut sunt", "description": "amet cillum qui Duis quis", "app": "nisi", "variables": { "error": "" }, "groups": [ "b2dc92eba16410f7a48d5e1d", "79cb6059f24766a4ec9d512b", "bce87aea0a0097faf0ec0005" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "failure", "success" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "74a594f8005b30dfe42a3169", "1159103760aae249cbe821c2", "575c70700023940eea5cd85c", "212149ad33eb61f50d632423", "5d20260bf72e93360f959ad0" ], "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "quis ipsum eu sunt in", "accessControl": { "read": [ "id quis ipsum ad", "consectetur Ut officia", "qui est aliquip", "consectetur ullamco esse sit ad" ], "write": [ "dolore nulla laborum", "minim in sit" ], "execute": [ "nisi tempor est quis et", "cupidatat", "elit" ], "manage": [ "voluptate in est", "mollit proident in qui aute", "commodo in ut ut adipisicing", "exercitation cupidatat laborum", "aute ut mollit velit eiusmod" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "2012-10-22T03:16:13.497Z", "created_by": "86341ce57bfb5e8d5b135609", "last_updated": "1954-04-20T13:15:58.223Z", "last_updated_by": "00ff3e22e193c63d104e19ed", "lastUpdatedVersion": "occaecat dolore dolor minim anim", "tags": [ "ad voluptate est in", "aliquip incididunt ipsum elit", "pariatur aliqua occaecat ad", "est do dolor" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "ef57bc47102a7877044e43f0" ], "x": -50964482.64710789, "y": 63318260.82653192 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "0ca8c94bcbb6c415865cf015", "e5377c95f7a442c363e3e41e" ], "gridCoordinate": { "x": 96358781.79508951, "y": 3686322.1757344753 } }, "error_handler": { "name": "childJob", "summary": "Duis exercitation cillum dolore et", "description": "sint nulla minim do", "app": "anim ipsum aliqua quis", "variables": { "error": "" }, "groups": [ "79fdb6e1017f05a07c8bf89f" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure", "failure", "success", "success", "error" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "fb24c38dc44e4f86acac845e", "3f47f34c0ef46ad717f0a003", "9e8a15e3bce50259625ba018", "68fe7491086db2c751821a1b" ], "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "aliquip", "accessControl": { "read": [ "id", "nulla in", "ut", "voluptate enim labore", "consequat ad labore do" ], "write": [ "consectetur ex commodo in nisi" ], "execute": [ "quis deserunt" ], "manage": [ "ad consequat id dolor", "enim commodo labore", "nulla id fugiat", "sed consectetur exercitation" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1993-03-01T18:33:15.457Z", "created_by": "c12bcf44a34feb1659754e86", "last_updated": "2014-10-28T09:42:47.407Z", "last_updated_by": "536eba7d05a57a62a94497bf", "lastUpdatedVersion": "eiusmod laborum aliqua incididunt", "tags": [ "dolore est", "aliqua incididunt enim eiusmod ipsum", "magna do labore quis Excepteur", "incididunt et elit" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "59566f993b1c09f2763d1a8c" ], "x": -72081790.15191272, "y": -51780513.24599786 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "fbdebc31a404c7dc21b72641", "3a89dc3f609b0a25319ca5b6" ], "gridCoordinate": { "x": -15745054.19194901, "y": 26189370.467516497 } }, "error_handler": { "name": "childJob", "summary": "irure", "description": "minim", "app": "occaecat incididunt sed", "variables": { "error": "" }, "groups": [ "80e9d57aa6077e9ecd81141d", "a83a9a5f7f52324ae2c35084", "1ed6765963a3bd81e4cd2625", "7a1c182d7b8b055c61e40b7c" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "success" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "56a8539ffbbc6739573bac04", "694df6aa52161594dc98d6f1", "0e3237bb878cd3a2b6b2489d" ], "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "nisi", "accessControl": { "read": [ "esse deserunt sint Duis", "eiusmod esse nisi est" ], "write": [ "ullamco est eu occaecat" ], "execute": [ "minim occaecat fugiat ullamco", "ad tempor" ], "manage": [ "sit et deserunt esse", "ea", "dolore" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1956-08-02T17:00:47.828Z", "created_by": "4a244a23a5eb162093d08193", "last_updated": "2020-06-25T10:35:35.522Z", "last_updated_by": "0827e3a227227860955e71a5", "lastUpdatedVersion": "id sit cupidatat sint", "tags": [ "id do", "cupidatat", "labore", "est ullamco dolore Duis adipisicing" ], "canvasVersion": 2, "encodingVersion": 1 } ], "total": 78709806, "start": 30142329, "end": -21837028, "count": 82552200, "limit": 93789933, "next": null, "previous": "proident Ut amet esse" }
{ "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" } ] } } }