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, and sorting workflow documents. For ‘limit’, ‘skip’, ‘order’, ‘sort’, ‘include’, ‘exclude’, and ‘expand’: Example usage in getWorkflows task -- ‘{ ‘limit’: 10 }’ Example usage in HTTP query -- ‘?limit=10' For ‘in’, ‘not-in’, ‘equals’, ‘contains’, ‘starts-with’, ‘ends-with’, and ‘task-equals’: Example usage in getWorkflows task -- ‘{ ‘in’: { ‘name’: ‘my-workflow’ } }’ Example usage in HTTP query -- ‘?in[name]=my-workflow' |
{ "options": { "limit": 10, "skip": 10, "order": 1, "sort": "name", "exclude-project-members": false, "include": "description", "exclude": "_id,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": [ "2b779fb89c6bb16c0bbfc13c", "d55a253014de7b189997f8b5", "6f46c75b8fbc3677cdf53ffa" ], "nodeLocation": { "x": -73198932.24033257, "y": 41757643.41356474 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "d1adfbf0b86f9feb3cd453ef", "c54f9d10f024853ea26d6455", "fbdbb88c1a5fddf7ed843cf7", "0eae59ea3b34570e1cafce0f" ], "nodeLocation": { "x": -42996379.76542146, "y": -27412707.475791767 } }, "error_handler": { "name": "childJob", "summary": "ut dolore commodo", "description": "officia exercitation ex dolor id", "app": "Lorem tempor id", "variables": { "error": "" }, "groups": [ "3979f23f735319da207a2a26", "74abbd148c14ba5fe5738397", "4dd84d2650582c6be05d1d44", "1c968faf79ad89a5f2a60d39", "3575f399bb56e53a5c0fcbd3" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "success", "failure" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "546bc8a2e70a34af31699817", "ac194fae8114e3e3a113ebfc", "06f168901034bb3166a1d57c", "5375c04c8a3f831dcbf25dcf" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "occaecat sint irure ut", "accessControl": { "read": [ "esse ullamco sunt dolore" ], "write": [ "culpa anim" ], "execute": [ "aute mollit pariatur minim est", "aliquip eiusmod consectetur sunt labore" ], "manage": [ "in Ut", "ad cupidatat", "tempor mollit qui veniam aute" ] } }, "description": "nulla", "preAutomationTime": 5000, "font_size": 12, "created": "2013-03-22T09:27:59.415Z", "created_by": "8b4e6c3003f7b526b75af629", "last_updated": "1977-04-10T18:28:26.912Z", "last_updated_by": "bc80ec341f5b2fc1e5f02343", "lastUpdatedVersion": "elit laboris veniam voluptate", "tags": [ "sint adipisicing laborum aliqua mollit", "qui adipisicing dolore nostrud incididunt", "aute sunt labore irure", "culpa commodo nisi aliqua", "pariatur consectetur" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "e2e5d4d49092f3a817b08531" ], "nodeLocation": { "x": -4161197.394479066, "y": 17102572.93279907 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "84d52cdf664033cb7b8bcb8a", "922e100166f8cdab0e065070", "dd8554888dcb5cee99872462", "378a961672e3284d7b525a07", "ef579981290a4404b85ffeeb" ], "nodeLocation": { "x": 48859045.748601556, "y": 58542169.42035574 } }, "error_handler": { "name": "childJob", "summary": "aute dolore cupidatat sit", "description": "adipisicing labore Duis", "app": "irure mollit cillum dolor", "variables": { "error": "" }, "groups": [ "a30da16dcfb3d5acaf2e108b", "71e3fb5d88815b9bde20ae0f" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "388eabeda6c4971cee14f225", "5d8eee0d7ff3fb31bba650bd", "ff469ba35ee19ee5ccd0d662", "3186a51bba17e67ee6fbc3e1", "d26e28bc31cc3430dcfbc735" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "sunt labore sit", "accessControl": { "read": [ "veniam dolor", "dolor magna", "occaecat ullamco", "anim enim fugiat nostrud" ], "write": [ "velit Excepteur incididunt elit ut", "minim ad dolore exercitation consequat", "laborum nostrud officia ea", "ex", "minim" ], "execute": [ "id", "et Excepteur mollit labore consequat", "non culpa", "Excepteur dolore magna dolor", "proident" ], "manage": [ "adipisicing eiusmod in pariatur quis", "eu nulla", "aliqua eiusmod" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1990-07-11T21:49:45.337Z", "created_by": "907fc02519e3cff36be4831a", "last_updated": "1984-04-07T00:02:52.596Z", "last_updated_by": "02004dd092bfa19d83c8a6ce", "lastUpdatedVersion": "culpa Ut nisi exercitation ullamco", "tags": [ "ex nisi Lorem" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "4f00443097814f6de75520c0", "d1b65305ab253770abd95817", "8d1685ee71bbc69e26b629f1", "32be884d8752ec91bf067cef", "4b948f71335ecf066f9d9f67" ], "nodeLocation": { "x": -56359004.35704375, "y": -58666218.53908685 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "b2a893e3e4c10f758f704d40", "3ab3e991ab0a7db9c6d1d029", "2f25438d12e676cbd76fd1bf" ], "nodeLocation": { "x": 79263187.63363564, "y": 50480457.844323695 } }, "error_handler": { "name": "childJob", "summary": "irure eiusmod aute et officia", "description": "sit veniam ea", "app": "id", "variables": { "error": "" }, "groups": [ "6f5b377c0621043139ccaa89", "33b7c7378eb6d3b6787cafc4", "b5de0b4e1633ef64694117e6", "c23344564ec3ed0e983a789b" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "error", "failure" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "d7ec93ca4de12a882e05166e", "72d3a491525f04644e6fce77" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "Lorem anim dolor sit in", "accessControl": { "read": [ "consectetur ea", "ipsum proident" ], "write": [ "cupidatat", "irure magna sed", "reprehenderit occaecat in pariatur ut" ], "execute": [ "eiusmod Excepteur", "ut non in", "cupidatat", "Duis amet" ], "manage": [ "adipisicing occaecat dolore enim", "eu", "sint amet est in commodo", "nostrud in" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2007-08-27T11:01:32.569Z", "created_by": "23934f7a4b7e3d2562410453", "last_updated": "1981-10-15T15:01:25.539Z", "last_updated_by": "07b7ebe5e75337a6e24e36e5", "lastUpdatedVersion": "mollit in ipsum Excepteur", "tags": [ "eu non commodo Duis" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "6143d36e5b377c32bdec4207" ], "nodeLocation": { "x": 12888484.594392136, "y": -97885276.37628 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "5fdd93cb11a874c3f3fc126b", "655135b88de796799ed3d2cf", "d42d60e7c4e7b12566e67316", "46d1e2ad4066407c3ef67cf1" ], "nodeLocation": { "x": 96213003.21081737, "y": 42735824.96819496 } }, "error_handler": { "name": "childJob", "summary": "eu pariatur proident laborum", "description": "tempor minim laboris", "app": "eiusmod reprehenderit", "variables": { "error": "" }, "groups": [ "5276383abb5d41df7dafa183" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "success", "failure" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "c90ec094c102658921f39911" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "sit eu aliquip", "accessControl": { "read": [ "proident laboris", "sunt nisi in" ], "write": [ "culpa Excepteur fugiat ut in", "consectetur dolor tempor sed", "amet dolore eiusmod occaecat", "non adipisicing consectetur ad" ], "execute": [ "labore", "dolore culpa et ut irure" ], "manage": [ "sint ut eu", "magna enim labore", "deserunt reprehenderit est exercitation", "esse nisi deserunt labore Excepteur" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1978-04-23T17:06:45.177Z", "created_by": "a435eb1ec7674dce41dc06be", "last_updated": "1971-09-23T11:57:03.957Z", "last_updated_by": "c6d6647f1ae85d843a81d4b4", "lastUpdatedVersion": "cillum", "tags": [ "enim ut laborum", "Duis commodo consectetur Lorem" ], "encodingVersion": 1 } ], "total": -99451948, "start": -9007186, "end": 62975040, "count": 13060467, "limit": -45768512, "next": null, "previous": null }
{ "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" } ] } } }