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": 1, "order": 1, "sort": "name", "exclude-project-members": false, "include": "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", "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": [ "9b1cd09f80960d2e4b4499ab", "157cfa2eeac392e9a152b40e", "284ecb1125dd665f143b973a", "b1bcdf3d3b451d88b11abfd3", "b121e72e832f01b7a4f729f0" ], "nodeLocation": { "x": -95483469.88170402, "y": -9653294.329786226 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "f05d792c6f6261307c82f1d2", "acf788f8a261606f06452487", "8fcadee0efd70a897f834da1" ], "nodeLocation": { "x": -83412616.27627695, "y": 86024964.12205595 } }, "error_handler": { "name": "childJob", "summary": "aliquip aute in ut exercitation", "description": "qui quis", "app": "labore reprehenderit elit Ut", "variables": { "error": "" }, "groups": [ "47e79417014fd622d7dca812" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure", "error", "failure", "success", "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "20fcdb216b19e7b802e07811", "ffa6e9f359d008e0d857b9a7" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "ut commodo culpa deserunt", "accessControl": { "read": [ "aliqua ut est Duis", "tempor minim aliquip pariatur", "officia magna velit", "in sit eu" ], "write": [ "minim tempor" ], "execute": [ "tempor", "mollit exercitation veniam Ut in", "ut", "dolore cupidatat" ], "manage": [ "ad elit", "fugiat esse mollit", "ea" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1970-10-21T14:14:12.759Z", "created_by": "eb7c276ca9ebdc19e5d1a8b9", "last_updated": "2018-01-26T17:20:00.228Z", "last_updated_by": "e254ab910015661ecdee1770", "lastUpdatedVersion": "Ut ut cupidatat consectetur", "tags": [ "nostrud labore commodo", "laboris", "elit ullamco" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "c254784ac1d306e71e06727d", "c2b83c5e263c25360e52a8d9", "3247166ab629a2d725f289b5", "f03bb4f9d0757c8d63fad66b", "bb735e851e100bd621f64810" ], "nodeLocation": { "x": 32609454.524135068, "y": -27441458.71726355 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "c3082cf99f889b3c1caaa2a0", "33e7731011f5b9f6c0247872" ], "nodeLocation": { "x": -85665848.32601807, "y": -92173814.64293015 } }, "error_handler": { "name": "childJob", "summary": "occaecat sint Lorem proident consectetur", "description": "tempor id minim non", "app": "commodo culpa quis exercitation", "variables": { "error": "" }, "groups": [ "d75ab17eb0e0eff3b0c96151", "7f75e8a4c52fe36de3184345", "d38182c7b434e1801ecfb57f", "27dafe827d44a77c61b89ea3", "70ea156cea2cd769e1cdb41a" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "86a0ef9ce90b8e094a8be868", "bf23a22d4f1ded68fc573759", "e10182a4e3f7c44db8ad35f3", "43b0216adb1799c64a4dde43", "4190541b233ddb69ed0560e5" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "consequat magna et nostrud", "accessControl": { "read": [ "ullamco", "fugiat" ], "write": [ "cillum eu non pariatur", "eu anim", "consectetur eu nulla exercitation" ], "execute": [ "consectetur", "cupidatat reprehenderit", "ea ex", "ut Duis", "aliquip exercitation et" ], "manage": [ "tempor sunt", "sint ad pariatur" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1947-10-23T18:09:43.107Z", "created_by": "1e357127e773eb38cc577980", "last_updated": "1966-05-23T01:20:06.654Z", "last_updated_by": "1871a1817a408b7cffe2f3a1", "lastUpdatedVersion": "in reprehenderit ut sed", "tags": [ "quis reprehenderit nulla aute", "irure occaecat", "aliqua Ut sunt consequat id" ], "encodingVersion": 1 } ], "total": -27720908, "start": 61086355, "end": 45667630, "count": -29217278, "limit": -99839262, "next": "enim anim nostrud eu elit", "previous": "eiusmod dolor" }
{ "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" } ] } } }