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": 25, "skip": 1, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name", "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": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "03faf77b3385e9e5ed640136", "9a042af095434feb46e3b65a", "472f843e05480806eeee3c83", "4a5a03236e7af808902e74ee", "092769ee1785adf7a5947eca" ], "nodeLocation": { "x": 88671526.2449404, "y": 52995000.286764175 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "ead288121a4007b93e58b834", "e99d10820a28adb9897c440f", "48b622e0ac8aac32a0d875b7" ], "nodeLocation": { "x": -99581469.04029754, "y": -13267718.748961508 } }, "error_handler": { "name": "childJob", "summary": "quis do mollit enim id", "description": "ad dolor amet", "app": "laboris ad Ut incididunt et", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/lt,4J88S1xd/KEeZw/~0/~0/~0/~0/~1/~0/IOY1nll/s" }, { "type": "encryption", "pointer": "/f8wBa" }, { "type": "encryption", "pointer": "/al4c/MI1H,/~0/hys7QR.+H/~0/~1/SO3kAriD" }, { "type": "encryption", "pointer": "/~1/~0/~1/~0/~1/JXrc8BCh/~1/~1/W/EzIDtis/~0" }, { "type": "encryption", "pointer": "/iw7RoonLk/bhpEypR5gf/~0/~1/Na-D/~1/diRjk/~1/~1/~1" } ] }, "groups": [ "9f449fdffab559d7fd601e2c", "0c05b868621fbe73984f513c", "dec494da048633eb8f0636c6", "ea51468b9ca041b93c7b1b60", "23cac67fee34f735c7f47192" ], "type": "operation", "nodeLocation": { "x": 18080585.7903163, "y": 49894687.97759476 }, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "error", "failure", "failure", "failure" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "83fb135be461c273f560b263" ], "canvasVersion": 3, "_id": "a26013cc-d2df-3371-db41-982ed76ca76e", "uuid": "7e2eb8c2-189f-c154-7a29-87215448e227", "namespace": { "type": "project", "name": "amet", "accessControl": { "read": [ "Lorem", "sunt dolore adipisicing sit", "ullamco do", "amet veniam ipsum qui in" ], "write": [ "cupidatat commodo sit", "qui", "nulla" ], "execute": [ "irure non ullamco ipsum", "Duis Ut", "laboris voluptate velit dolore", "in aliquip", "irure culpa cupidatat eu enim" ], "manage": [ "cillum pariatur", "dolore proident do ullamco", "labore" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": -13978607, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "7e01bf23e74b4c3bb67fedc1", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "fe8f71138df8ccfae30c85f1", "lastUpdatedVersion": "4.69.69", "tags": [ "labore amet magna", "culpa ad adipisicing", "ut sed in fugiat", "proident nostrud non" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/~1/~0/v5/NBQs7mPRibP/pyF2zs.iD/~1/~0/VSjRrnRY/~1" } ], "migrationVersion": 91478359 } ], "total": -43376797, "start": -89758190, "end": -61067571, "count": -15425889, "limit": 29342579, "next": "reprehenderit ipsum aliquip eiusmod occaecat", "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" } ] } } }