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": 25, "skip": 0, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "expand": "non", "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": "occaecat laboris", "description": "culpa", "app": "id nostrud esse", "variables": { "error": "" }, "groups": [ "602b6f21edde81e8f959342a", "728e82e3dab095610866ecd0", "61a65400807f27702ea73001" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "success", "success", "failure", "error" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "dd8f8587f03bd015b6178039", "d2d4f1f39fcf41fffec87e2f", "624ec71cf7233276ffe221b9", "ac74b26db04c6d50ec80d4fe", "39db2a11f97d576fb0506c4c" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2010-09-24T22:02:23.408Z", "created_by": "029dbe17f41c0e71ccf5956d", "last_updated": "1993-03-29T16:25:59.728Z", "last_updated_by": "a1bc8574eed02ba4c6c8434e", "lastUpdatedVersion": "voluptate ex nulla", "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": "occaecat quis", "description": "est", "app": "esse proident do aliquip", "variables": { "error": "" }, "groups": [ "71977b8f3edb1d4079fb188e" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "f9cceb11eafba355af32d2a1", "3ddfadf4b84d64a776fbfd93" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1991-10-23T18:36:11.334Z", "created_by": "28a2703242b390f284ed3ef7", "last_updated": "1962-11-17T01:32:31.629Z", "last_updated_by": "c798e6417ff6eb69679df248", "lastUpdatedVersion": "Ut Lorem", "tags": [], "canvasVersion": 1 } ], "total": -54543876, "start": -24674921, "end": 26323260, "count": 88025080, "next": null, "previous": "Lorem reprehenderit adipisicing" }
{ "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." } } }