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": 10, "order": 1, "sort": "name", "include": "name,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" } }
{ "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", "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": [ "31cdb9cc57d45c366cafb3b3", "8b0444f63067d6b0ed710c2c", "a12793a07c073f9476acfaf5", "7a12264434962f3b293af198" ], "gridCoordinate": { "x": 56314320.15444288, "y": 91822631.77343342 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "428de9b692dd2bef65d4464b", "f460b5d77ff6ac0857dc7181", "2167fff955ccfecd42dee037", "a01c77cfd41aa993e297880a", "80dda4d680de421793137baf" ], "x": -43325156.55572848, "y": -73076017.55672169 }, "error_handler": { "name": "childJob", "summary": "dolore ea magna", "description": "Lorem veniam Ut", "app": "aliquip", "variables": { "error": "" }, "groups": [ "5b5f8318377579e35aaa3bd7" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "ca99f4f3a65773bf82764313" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1957-05-24T08:49:12.057Z", "created_by": "29e757cc45fdbd1516896af4", "last_updated": "1966-08-21T09:10:48.756Z", "last_updated_by": "9be6138201e221c9224cb7a4", "lastUpdatedVersion": "cupidatat laboris laborum dolore", "tags": [ "Ut cillum consequat velit sint", "eu dolore commodo magna adipisicing", "ullamco non consequat", "ipsum" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "d76d2629104c52992361f397", "830e44d4024e9caef46df63a", "fd7d810e7c96483560f81ab0", "adac7f717140b76f63411f8d" ], "gridCoordinate": { "x": 2248488.325727433, "y": 50806341.7375676 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "ae00c780283bd0ad7d7fb1e3", "cb40373731732c21476689fb" ], "x": 15260131.304105192, "y": 25584107.583461568 }, "error_handler": { "name": "childJob", "summary": "eiusmod eu sunt", "description": "amet ea reprehenderit", "app": "ullamco velit", "variables": { "error": "" }, "groups": [ "b2deaa8dcb5661b3d6cd7c81", "5d920cef2c7be0d59db2d7f9", "960e0616cb854548bbf02bc7", "a289cef8785e4fbe79513ee3", "379ad2a93d93ff1441c67d96" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "success", "error", "failure" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "835d72fcf407c814acf5e328" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1979-05-06T06:27:44.383Z", "created_by": "f02c025a0cc953715f086eb3", "last_updated": "1993-12-31T13:50:21.541Z", "last_updated_by": "b42ee5a44236ecf4b8b45978", "lastUpdatedVersion": "cupidatat dolor laboris ex", "tags": [ "minim", "nisi velit", "ipsum officia in", "Lorem ea voluptate irure" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "064cf4e7a2e5c0332ce91adc", "60e62494d81f277973dcf376" ], "gridCoordinate": { "x": -95786475.9897527, "y": 58373787.79316822 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "6fc5d80eedae59519a446c30" ], "x": 83278179.69880384, "y": -96423690.83585933 }, "error_handler": { "name": "childJob", "summary": "consequat nisi dolor Duis", "description": "nisi laboris irure minim", "app": "incididunt sed non", "variables": { "error": "" }, "groups": [ "ef6080fafa9e5f4816b4fcdc", "b828c4977a5cbfdac614c3c7" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "success", "success", "failure", "error" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "6d01498604218020d3befd14", "352d9ef79f7538d177d406ca", "394b962dfc5fac34bb8e4b5c" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2024-12-02T18:35:25.807Z", "created_by": "efc0f8d5b5fdfd87a763b732", "last_updated": "1975-05-23T11:37:10.369Z", "last_updated_by": "b7ca1862b662c4dcc7c71c12", "lastUpdatedVersion": "officia occaecat commodo deserunt in", "tags": [ "aliqua aute adipisicing", "non ex", "officia", "dolore est culpa" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "f3d5d9efe1a925666630b986", "6c47e1a2ab6f34a9edc59eda", "5b74d9a3036ef8b6029196af", "8c2078dda7e9e9a7784d23e5", "3097435414341e57a3524d6a" ], "gridCoordinate": { "x": -78496326.90873514, "y": 99719603.36022896 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "8bce81df0a29c7596762bd50", "f27d42f65e4f9bf91a42e2cc", "3e3231858e2968f9005a0b7d" ], "x": -64021779.82248456, "y": -60002359.95481784 }, "error_handler": { "name": "childJob", "summary": "in commodo ut quis", "description": "amet fugiat Duis exercitation veniam", "app": "sint Duis adipisicing dolor anim", "variables": { "error": "" }, "groups": [ "99b0053b362b978cbdb1fc4a", "b267141fadd6aacfd8942fcc", "37d7c06a37fb00672d12a9c2" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure", "error", "error", "error", "failure" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "1041129ad957d31bbaaa0807" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1969-03-10T19:39:08.267Z", "created_by": "6f114df830b86da9ef766abb", "last_updated": "1945-12-15T18:54:45.142Z", "last_updated_by": "53fff1aeb6cd2133e5bc8178", "lastUpdatedVersion": "proident do esse consectetur", "tags": [ "sit velit aute", "nisi Duis" ], "canvasVersion": 1, "encodingVersion": 1 } ], "total": -24787853, "start": 3740795, "end": -65569688, "count": -96025435, "limit": -72047383, "next": null, "previous": "mollit laborum cillum aute aliqua" }
{ "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" } ] } } }