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": 50, "skip": 0, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name", "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", "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": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "b1710453ce3fda2822e8aa6b", "2c68352091bdbd41f6f46113", "e6d49f32b5c9d7b7511a32b5" ], "nodeLocation": { "x": -49168284.993981406, "y": -1766555.0747862905 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "48a545199719de4cc3181205", "f69c8f3be6aa8539fe8b20df", "1a0a7b3e75689b8f9dcf0e20" ], "nodeLocation": { "x": 6623385.099914581, "y": 95777303.1917029 } }, "error_handler": { "name": "childJob", "summary": "nulla laboris", "description": "deserunt irure do ut est", "app": "nisi esse", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/U8/~0/BtRiHuAjH/zgLvphmx/~0" } ] }, "groups": [ "c9c01451711e26335917bd68" ], "type": "operation", "nodeLocation": { "x": -76531698.07328531, "y": -28967589.76822263 }, "deprecated": true, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "e39a025093a8cf1574f09f8e", "3f74c26c095f56f145582fbb", "fae1f9311bedf188dfeb4ecc", "6556eeac4284554fa6523797" ], "canvasVersion": 3, "_id": "69adaabd-51ad-5df5-d226-28806d845e28", "uuid": "2742491b-037f-6612-b02e-d96dbee4b4ba", "namespace": { "type": "project", "name": "dolor in quis", "accessControl": { "read": [ "nisi Lorem sunt", "qui", "sunt", "exercitation", "culpa tempor" ], "write": [ "incididunt veniam pariatur" ], "execute": [ "fugiat nulla ut ullamco in", "voluptate cillum est do Lorem", "incididunt in deserunt consectetur", "aliquip id cupidatat" ], "manage": [ "non dolor amet ad" ] } }, "description": null, "preAutomationTime": 250000, "sla": -48851217, "errorHandler": { "type": "dolor amet fugiat", "name": "sunt sed do" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "5696baa6aaf6dc320b4df1cf", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "fc7fa0e5cad2a961004b7076", "lastUpdatedVersion": "4.69.69", "tags": [ "eiusmod minim officia in" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/jFlZ8,D4a/~0" } ], "migrationVersion": 2756880 }, { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "afd4e5aa24cb4e36fd0c053d" ], "nodeLocation": { "x": 90854463.29264718, "y": 22716506.15000716 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "8812be77eb2f2f805ab0a02e", "ad81b94ab31eb277ac9506ad", "737c91803a6fe7cc26e4c806", "2877f09e6db58eb3f9687b9d" ], "nodeLocation": { "x": 62003408.27226043, "y": 92930248.74012187 } }, "error_handler": { "name": "childJob", "summary": "eu tempor irure voluptate et", "description": "ipsum sed irure dolore", "app": "do nisi laborum ut pariatur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/U0s/~1/Aj/xjo" } ] }, "groups": [ "0e5b5d48398ae5377a10c7d1" ], "type": "operation", "nodeLocation": { "x": 28821713.728301868, "y": -69679856.9943386 }, "deprecated": false, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "2f76d019dca0d32957849280", "4f8304e86f6f4644107ebd83", "f6e6551be01ece863696f958", "edcc54703dc9e157bc147eae" ], "canvasVersion": 3, "_id": "5e4454ec-a130-153e-873b-b76633d2abca", "uuid": "907648cb-f492-8d30-3c68-a818c54ca583", "namespace": { "type": "project", "name": "eiusmod id non nisi", "accessControl": { "read": [ "officia laboris ea ad dolor", "nostrud eu do aliquip est", "do commodo", "incididunt", "sit" ], "write": [ "quis culpa ipsum est", "in irure Excepteur eu amet", "labore culpa laborum nostrud aute" ], "execute": [ "irure", "anim occaecat minim eu dolor", "elit eu in officia", "qui aliqua deserunt" ], "manage": [ "dolor", "sunt ullamco" ] } }, "description": null, "preAutomationTime": 5000, "sla": -80048757, "errorHandler": { "type": "quis pariatur Duis deserunt mollit", "name": "Ut" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "d7ca8b08cd2c733c3bbee24b", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "21104cb6c00b2cd787610530", "lastUpdatedVersion": "4.69.69", "tags": [ "adipisicing pariatur dolore voluptate incididunt", "amet" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/BE6lyA29R/~1/~1/vwJBH/ft/~1" } ], "migrationVersion": 31944087 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "86192e958248b422ebe0670f" ], "nodeLocation": { "x": 34197716.761532694, "y": 8502828.015014112 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "0f9356a7a72b65b5639232e8" ], "nodeLocation": { "x": -41268041.06710997, "y": 30447615.543488517 } }, "error_handler": { "name": "childJob", "summary": "dolor laborum sint pariatur", "description": "amet eiusmod", "app": "sit dolore nostrud", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/CLdjf89gcY1" } ] }, "groups": [ "026af1c0430d77c58a84cbaf" ], "type": "operation", "nodeLocation": { "x": 30627333.259545922, "y": 5386208.029136926 }, "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "success" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "f75b7c189635d00bd61b1a84", "8f5eaf66a2eaf0365f7bfb40", "febdb00fb72e658cbfcbac6b" ], "canvasVersion": 3, "_id": "79b9c273-c823-fa45-63b1-a9d8c26879dc", "uuid": "70044498-2e40-9d70-12df-aced0264793e", "namespace": { "type": "project", "name": "cillum Ut eiusmod labore", "accessControl": { "read": [ "veniam eu Ut" ], "write": [ "ad dolore in magna non" ], "execute": [ "id ipsum labore proident ut", "sint ex incididunt", "pariatur", "elit Ut" ], "manage": [ "eu commodo", "aliqua exercitation non voluptate", "cillum aliqua sint", "Excepteur sint labore consequat" ] } }, "description": "Push Config to Device", "preAutomationTime": 250000, "sla": 28288217, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "d4b24e357b1bc69a8b2c525e", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "85f6418beb326f665d80bfd8", "lastUpdatedVersion": "4.69.69", "tags": [ "voluptate sed culpa esse", "occaecat elit Ut nostrud reprehenderit", "velit nisi proident in", "dolore irure fugiat mollit" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/AIxZmRq2/Qc58r/vnM,2hiZ+/Ya-62ncZuKd/TJ6HX8/AsrIO/~1/Uhk/o9/uo8nlVQQA" } ], "migrationVersion": 61155014 } ], "total": 56039577, "start": -82299464, "end": 56675365, "count": 19444901, "limit": -4727598, "next": null, "previous": "in non elit proident" }
{ "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" } ] } } }