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', and 'ends-with'. |
{ "options": { "limit": 1, "skip": 10, "order": 1, "sort": "name", "include": "name", "exclude": "_id", "expand": "labore consectetur", "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" } }
{ "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" ] }, "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", "items": { "type": "string", "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" ] } } } }, "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": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "veniam", "description": "in id consequat veniam", "app": "velit", "variables": { "error": "" }, "groups": [ "3d8a4c0e3e06ad7d1e8d3eba", "ea9cdec478e941c5815cea72" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "success" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "4cdb50996751bc66467e5457", "b0b21cd1e8c0133e8293b22d", "7bb3205d08760268b61d0f85", "7f663551b2c51fca7c8bc58b" ], "_id": "4321abcdef694aa79dae47ad", "description": "esse enim deserunt tempor", "preAutomationTime": 250000, "font_size": 12, "created": "2023-07-11T01:33:33.122Z", "created_by": "1cf693f512edd08a755c51bb", "last_updated": "2002-05-30T06:01:39.063Z", "last_updated_by": "6518b58b61ae2a3ff389099c", "lastUpdatedVersion": "aliqua dolor nostrud", "tags": [], "canvasVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "anim dolor", "description": "non officia", "app": "est eiusmod", "variables": { "error": "" }, "groups": [ "b5f80f30e189d8344d9b549d", "3b0ceb16100741cec94e5664", "338e19215ca0bdc9407527f3" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error", "success", "success", "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "3f15f8e395720e05f30b364c" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1989-07-13T09:10:47.547Z", "created_by": "1759c3cd59d3ab08c0c3b890", "last_updated": "1984-07-14T23:56:16.886Z", "last_updated_by": "7edfd5ad02b6836281d6fd80", "lastUpdatedVersion": "ut ad ea fugiat esse", "tags": [], "canvasVersion": 2 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "ea voluptate", "description": "voluptate ad ex consectetur esse", "app": "sit voluptate Duis aliqua", "variables": { "error": "" }, "groups": [ "1a0d541bd2c45750d33bc015", "c32f99e631007429e0a83e54", "ef802e1e127dc3769eeff7dc", "59a6f7769621d58ad92a34e5" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "success", "failure", "failure" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "5a4edc4189edcfe1ad756fcf" ], "_id": "4321abcdef694aa79dae47ad", "description": "pariatur dolor est ut ea", "preAutomationTime": 5000, "font_size": 12, "created": "1987-12-04T12:16:18.064Z", "created_by": "7b330f8154865c37b1eb76f9", "last_updated": "1958-04-20T02:14:47.878Z", "last_updated_by": "9a1845f9cac85e14813e36dc", "lastUpdatedVersion": "irure id occaecat", "tags": [], "canvasVersion": 2 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "nulla ullamco laborum", "description": "officia occaecat sit", "app": "quis incididunt", "variables": { "error": "" }, "groups": [ "208467c92ed7d3cbc7d7f661", "7015d97a870cf36c7bedf43b" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure", "error", "failure" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "a20bc8d70e2282c73bfd6049", "2623554bace4a66293206baa", "581ebba3eb7a6bb70f91f326", "8bc710f13bb159d49dc76cf7", "f99b8a529b4cde6d4dcfc35c" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2007-05-18T02:25:38.998Z", "created_by": "4cfe848ad771e402317cfc8a", "last_updated": "1947-05-09T01:27:46.437Z", "last_updated_by": "e15037d88af236aa4794f2a5", "lastUpdatedVersion": "dolore ut ad", "tags": [], "canvasVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 0.36142061281337046, "y": 0.502092050209205 }, "error_handler": { "name": "childJob", "summary": "nostrud dolore", "description": "eiusmod labore magna", "app": "dolor officia exercitation sed sit", "variables": { "error": "" }, "groups": [ "43638fa04dfc701ea9e84343", "5865abf6d6795d9211c3e80f" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "error", "error", "success", "success" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "ee6ad52960330abe03cef868" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1993-04-05T18:54:25.166Z", "created_by": "0a8c43cfc173bfc9e8f4d362", "last_updated": "1974-12-02T16:31:33.603Z", "last_updated_by": "2aae70b8d877ab2c02aaa28a", "lastUpdatedVersion": "id minim consectetur commodo", "tags": [], "canvasVersion": 1 } ], "total": -60858270, "start": 95374017, "end": 10300284, "count": 84870116, "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." }, "next": { "type": [ "string", "null" ], "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results." }, "previous": { "type": [ "string", "null" ], "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results." } } }