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": 50, "order": 1, "sort": "name", "include": "description", "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": [ "53c23e70f6eeb691d69341a4", "b43ce8eca606e614e13630a1", "216b84b1f922fdc0cc73ee56", "9833f1056eccfed789e3a81f", "af9b031af4ff142d16299ede" ], "gridCoordinate": { "x": -5985557.449874923, "y": -45594890.35242614 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "9715c773f38050924994f791", "5957c951004d1c8868e27a9e", "6c8888da1fc7c8f5cd5f30ff" ], "x": -86247755.2608957, "y": 80774713.11696604 }, "error_handler": { "name": "childJob", "summary": "dolor amet", "description": "labore dolor", "app": "culpa id", "variables": { "error": "" }, "groups": [ "0c5c5139124c8184f188add5", "14708e8a68c567072bd3bd45" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "error" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "e870a2d85debca573bcc5c4c", "a6bf3bee31fdc3487648471f", "46db2dec8b4cafb76eaac7da", "e532b52c3bd571b6efddfae5" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "1993-02-01T08:34:56.242Z", "created_by": "43c80f18f864bab4acb59609", "last_updated": "2000-09-18T21:13:02.057Z", "last_updated_by": "ed252967c92a15e3ba75376f", "lastUpdatedVersion": "labore Ut nulla ut laboris", "tags": [ "officia ut dolore", "adipisicing ad Duis sit cillum" ], "canvasVersion": 2, "encodingVersion": 1 } ], "total": -30556039, "start": -29325251, "end": 14115076, "count": 70330326, "limit": 89222916, "next": null, "previous": "nostrud esse ad dolor eu" }
{ "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" } ] } } }