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', 'ends-with', and 'task-equals'. |
{ "options": { "limit": 25, "skip": 0, "order": 1, "sort": "name", "exclude-project-members": false, "include": "description", "exclude": "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": [ "170538115408f22c36ba0e8b" ], "x": -23270674.340821713, "y": 625637.622985214 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "3ae0109cad4fdaa77a2aaea8", "a77b38f1f76897b1d86898e9", "8be4fd59a4018201ff8d7bd1", "25e56843a7b531d7de3aa66a", "bc1db805cc41c55fe898d8f2" ], "gridCoordinate": { "x": 66544551.590310484, "y": 88354988.97516268 } }, "error_handler": { "name": "childJob", "summary": "deserunt sit in Duis do", "description": "ipsum dolor voluptate tempor", "app": "nisi", "variables": { "error": "" }, "groups": [ "02b11cfeaea9381ea1634245", "3874df39cf0652f2a8ca1a0b", "348d937a36af865de59f5885" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "d071f43cd79bba77e51a53dc", "4fdfce0a4f9a0603d9eef884", "6e162a71eb6bd984d7dd6189", "44dc57455df52f8f72b6b9d0" ], "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "nisi occaecat", "accessControl": { "read": [ "sed", "non est Duis", "Lorem" ], "write": [ "pariatur laborum qui", "consequat", "magna ut", "mollit nisi ex ullamco" ], "execute": [ "aliqua ea Duis tempor esse" ], "manage": [ "officia laboris elit", "reprehenderit est laborum ut proident", "Ut ut in consectetur aute", "tempor velit occaecat ullamco", "amet dolor eu culpa qui" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1967-09-30T10:58:59.111Z", "created_by": "4866a826f615d760996dff15", "last_updated": "1993-12-13T19:42:31.567Z", "last_updated_by": "a26d163492f90dfeb4529458", "lastUpdatedVersion": "in", "tags": [ "ad fugiat Ut", "in dolore ullamco exercitation", "qui aliquip in aliqua" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "02540f6260ce115c53064ef3", "4fcd138ccc103f425f206d7c", "9d878749d0c4039a6ee33e6a" ], "x": 86031826.30783498, "y": 35472550.60438305 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "ece96f68b4eda58bba9deca2" ], "gridCoordinate": { "x": -29247728.778578535, "y": -13476038.752816424 } }, "error_handler": { "name": "childJob", "summary": "Duis", "description": "Ut quis cupidatat", "app": "culpa aliqua", "variables": { "error": "" }, "groups": [ "67f99fb096c97c6510f12b11", "7fc8ec8c7da8a56dd1d7bab5", "a9af010e3e3f2165276f62e8" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "failure" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "00fcbca77f148bb2d0c81627", "929dd22202a0cd708c467e05", "a75921021a98dd32be0a730e", "202249dc66ac8ecf71c70c39", "b8faddd9be860be68577f2c5" ], "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "laboris nulla Lorem exercitation", "accessControl": { "read": [ "ipsum tempor esse" ], "write": [ "nisi fugiat occaecat nulla", "eiusmod", "nostrud ullamco do pariatur" ], "execute": [ "ut in" ], "manage": [ "dolor sed", "adipisicing elit voluptate", "enim voluptate in" ] } }, "description": "sit quis", "preAutomationTime": 5000, "font_size": 12, "created": "2002-04-11T11:23:49.361Z", "created_by": "f549dd1f5a1f953bd2434648", "last_updated": "1957-03-26T08:06:27.319Z", "last_updated_by": "5723ed5281c6ca3f98e751c6", "lastUpdatedVersion": "officia ullamco ea", "tags": [ "anim dolor", "deserunt", "incididunt in velit ut" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "d93f730eec93f9ba662b4c3f" ], "x": -20802703.407911777, "y": -70748822.51874807 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "c5fd08c991f1d34f9355aa22" ], "gridCoordinate": { "x": 1256869.1501223296, "y": 38547438.52669647 } }, "error_handler": { "name": "childJob", "summary": "sit tempor exercitation minim", "description": "cupidatat in", "app": "commodo", "variables": { "error": "" }, "groups": [ "28896f94e91c24bb6fed95e1", "72ed7957ef730a80f6f8fb2b", "1c5be64c2f4111001dfb6305", "136c9251dc5ad3ccd25bbd91", "6954ab8b174abe85fb4d8775" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "9237051c6302f77e340853f3", "717b9588eb0ff1f369ea83d9", "ea091a924eb1ed1416cd17f1" ], "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "culpa pariatur eiusmod proident", "accessControl": { "read": [ "id ad ex" ], "write": [ "magna", "dolor aliquip", "Excepteur aute ea", "eu" ], "execute": [ "Duis eu Ut pariatur", "in dolor", "cillum mollit velit", "quis fugiat aute" ], "manage": [ "id", "Ut ea", "anim nulla ullamco aliquip laboris", "Excepteur reprehenderit Lorem" ] } }, "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2015-07-15T08:15:13.316Z", "created_by": "36220f31c76724d7164e8811", "last_updated": "1963-08-27T07:26:33.327Z", "last_updated_by": "5967eb7d6d6a90ac3ab92eee", "lastUpdatedVersion": "ipsum sed", "tags": [ "sint", "Duis nulla velit aliqua", "laborum" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "be4959d9575705db31c41b11", "c2e75e5ad819b134d2ed439d", "a2cb8adb7bcfce9403d52547", "da89adcedff484385dba21cd" ], "x": 27071709.33494565, "y": 82773373.28345299 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "0d239eab89a00ea3273a13d6", "d675b2a16fdb25aeb73a4812" ], "gridCoordinate": { "x": 82682056.44897798, "y": 98770379.78123799 } }, "error_handler": { "name": "childJob", "summary": "in ad anim", "description": "fugiat et", "app": "anim ut nisi in", "variables": { "error": "" }, "groups": [ "09666b7f32a9f1df16abe0d5", "606d776a6a51d107b528c8ce", "3ee60705f511b06d4e37f9a1", "32d8d52b1ff5fd053144ba18" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "success", "failure", "error", "failure" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "24336cc4ab5b98a5e02760b3", "a2e69f2d40f3bfaba75b4fe5", "01905d6dfd21762887c279a1" ], "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "est", "accessControl": { "read": [ "proident", "ullamco proident eu do", "labore in reprehenderit Excepteur enim", "esse", "in proident amet" ], "write": [ "nisi est", "Ut amet", "reprehenderit adipisicing enim", "sunt", "elit" ], "execute": [ "et Excepteur ullamco", "sed tempor", "cupidatat nostrud sit pariatur", "amet velit" ], "manage": [ "dolore sit et enim", "id nostrud exercitation non" ] } }, "description": "nisi laborum ut aliqua", "preAutomationTime": 5000, "font_size": 12, "created": "2010-04-11T23:58:01.542Z", "created_by": "9f1ef620a9b134bdae5d1d28", "last_updated": "2010-06-24T00:54:35.228Z", "last_updated_by": "f58461cd224fd46c446edb36", "lastUpdatedVersion": "in", "tags": [ "consectetur deserunt nostrud fugiat pariatur", "ea ut proident magna", "exercitation in", "Excepteur", "dolore ipsum sint" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "b9c088d8b4cf3cf69accf3c5", "391243886a5f1062591e3be8", "38b3fae5bd40dbda1463cec6", "018ee6ae154b08c3f16dee32" ], "x": 53301551.867698014, "y": 64218253.41547242 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "9befec8428bbc72bd632f7ed", "059884bc21405269b0d4899a", "e7281be3a06c34f624165efa" ], "gridCoordinate": { "x": 40369908.49108392, "y": -88251571.22268555 } }, "error_handler": { "name": "childJob", "summary": "nisi quis Duis", "description": "do dolore", "app": "velit sit Lorem culpa", "variables": { "error": "" }, "groups": [ "8b0123e9eecbfeac30e20ee0", "ef937c9a8179f5dc624348ac", "f149734cd1dae961ee5dc745", "b9de66b8a07dc7f71b43ab12" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "failure" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "fa93c2c2fb2f11fee8588a68", "9c6f92609524f94c8dccacf5", "2e9dac8af954a8dd26fd09a1" ], "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "officia laboris adipisicing Excepteur", "accessControl": { "read": [ "veniam", "ea nostrud Excepteur dolor culpa", "dolore exercitation et cupidatat", "nulla", "aliqua do dolore et cillum" ], "write": [ "labore proident minim id deserunt", "ex nulla elit dolore adipisicing" ], "execute": [ "incididunt cillum aliquip exercitation", "nulla", "commodo ex" ], "manage": [ "ullamco quis Duis", "pariatur elit fugiat" ] } }, "description": "dolor elit incididunt dolor id", "preAutomationTime": 5000, "font_size": 12, "created": "2021-06-16T06:49:43.477Z", "created_by": "d7e059f4c229664c1da889ee", "last_updated": "1991-05-19T03:08:09.343Z", "last_updated_by": "fff7e95dbecfc4f60b70ec14", "lastUpdatedVersion": "in", "tags": [ "exercitation ullamco sit labore", "velit", "occaecat", "adipisicing" ], "canvasVersion": 1, "encodingVersion": 1 } ], "total": 49539840, "start": 15096129, "end": -11578893, "count": 26313247, "limit": 28925767, "next": "eiusmod ad nostrud", "previous": "incididunt in ut esse id" }
{ "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" } ] } } }