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", "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" } }
{ "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": [ "2f6fe9d5b3ba47905db2ab1d" ], "x": 72946576.32717597, "y": 39944214.790174484 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "18205bf645afa65c65d9c92d", "d9e9a07bfbd49a3dbebb5ca5" ], "gridCoordinate": { "x": -24752108.09765111, "y": 41200133.3714962 } }, "error_handler": { "name": "childJob", "summary": "sunt", "description": "laboris cillum Excepteur", "app": "fugiat aute ea esse", "variables": { "error": "" }, "groups": [ "2ef9e3b28057c22bedaada99", "bc5acfd061585626c66fe7ac", "7078c1b517d4a5873ff36172", "f08c5a280fa4b3f9071281b7", "43d2417d1bb7beb1e6d66335" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "success", "error", "success", "failure" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "53c809331bd1a032b72c6500", "dedbb00f9b14495cf3a94f33", "67b8b7ec52f58ae3cab85e75", "4117b56cacaa3b9776737f7a" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1998-09-09T01:54:00.061Z", "created_by": "f09068efa1ace6c7b4793cf4", "last_updated": "1948-03-21T05:47:30.9Z", "last_updated_by": "ce02c3402edb4818a490529d", "lastUpdatedVersion": "labore", "tags": [ "ex incididunt sunt", "incididunt quis in" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "54677d526133f52a55186b85", "f22948b777e1b3e6842d79e1", "39909078eaf28d214713acfd", "5447c69a716592d81e888b32", "7649cde91844d18f0e66951c" ], "x": -29386001.19795072, "y": 40979816.97754246 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "6cda878d75f984870981043c", "c7e8bb71bb674b4a01484cf4", "bb7134365094c42e71c75d31", "0dc9270e15d1b4d117b3faea", "56c014292b2f7ba0f92d5e96" ], "gridCoordinate": { "x": -59596969.840912186, "y": 45554778.623001814 } }, "error_handler": { "name": "childJob", "summary": "proident eiusmod Duis qui", "description": "ut sed", "app": "amet Duis eu magna", "variables": { "error": "" }, "groups": [ "e57655cb16594c544d75f3ea", "6b1bc4f49ebf6245abd751cf", "47966184481734a61fd510ec", "60a9f81b2bcfb05cc8fbde88", "91b42f32a06211bb573f1d05" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "error", "error", "failure", "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "3cd08c103ab24bd24fdb8515", "b10088b7b5977725e664acef", "83a9db3ee6a9c46762c0de1b" ], "_id": "4321abcdef694aa79dae47ad", "description": "et deserunt ut", "preAutomationTime": 250000, "font_size": 12, "created": "2021-05-21T12:13:51.307Z", "created_by": "2c399fc9b560d11f74f11401", "last_updated": "1991-11-06T01:20:56.817Z", "last_updated_by": "28ae31090142bb72e42c7456", "lastUpdatedVersion": "ut ut nostrud", "tags": [ "elit", "voluptate commodo laborum Ut", "irure", "velit in ullamco", "id ut consectetur" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "dc0fc5c5fee35012e77c795a" ], "x": 12614767.878715709, "y": 48004890.846832275 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "7b9f98d7ff0ea56010c799f7", "67451a33cf3b68fca860a158", "703c2b2f3a8962d5638d223a" ], "gridCoordinate": { "x": -95668550.26600426, "y": 6333703.295294151 } }, "error_handler": { "name": "childJob", "summary": "sit ut", "description": "consectetur", "app": "id anim Ut minim", "variables": { "error": "" }, "groups": [ "6ccc4d7464ac9da509376d77", "b60a1ddd195ba8dd5da5eb87", "98dbf1a02b35f837018dfcc1", "3bd91078626868c19cd0ca0b" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "error", "success" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "41e2e35e3e7fdd3d0c71098d", "f7022c4b5481af6c25862ce5" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1991-04-24T19:04:18.183Z", "created_by": "3e3e3647fc848656bd288744", "last_updated": "2006-09-08T18:45:05.63Z", "last_updated_by": "c0c8bf7052c9e6e369830c4b", "lastUpdatedVersion": "consequat non", "tags": [ "in reprehenderit cillum ad ea", "labore Lorem amet", "aute irure tempor consequat mollit", "voluptate ullamco laboris dolore" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "d4fd7bdbd7fb7730a00b695e", "0301493897fb3655b33153e8", "e8536ab354afc59b74070671", "bfc902c678f0de7a056331ba", "5ebb9d13b5f83334587478b5" ], "x": -78575027.68176495, "y": -21744045.585438564 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "2f40483238729c0fb290fdb4", "b21f196c727296d3112cb180", "f4b20701e0ce88f8df1ab029", "a37a36ca9fabcb9e4d3b14e1" ], "gridCoordinate": { "x": 21240373.39889711, "y": 57196366.596393585 } }, "error_handler": { "name": "childJob", "summary": "consectetur dolor Excepteur labore", "description": "quis anim", "app": "nisi", "variables": { "error": "" }, "groups": [ "08e196e8529336acdd0db59d", "39f1bcd2c6a760aaa7909c9c", "34216f82d11ab77373f697f8", "4bd40b49ac71acda96210d46" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "success", "failure", "error", "error" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "b2c85911985f2b486603fee4" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1997-12-10T11:31:45.755Z", "created_by": "b9733b0314c2559847a9fde8", "last_updated": "1950-10-05T05:30:46.466Z", "last_updated_by": "fa5d387c9b434443685fa435", "lastUpdatedVersion": "deserunt minim dolore in", "tags": [ "irure occaecat nisi elit est", "est", "adipisicing", "id sit ex" ], "canvasVersion": 2, "encodingVersion": 1 } ], "total": -83466880, "start": 67069371, "end": 95776327, "count": 21394313, "limit": -11977323, "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." }, "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" } ] } } }