getWorkflows

{ "options": { "limit": 1, "skip": 10, "order": 1, "sort": "name", "exclude-project-members": false, "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", "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 }

{ "items": [ { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "590c9b791b354a86a10d8a60", "a051b7e75723a9e42ab18121", "3658701fdbedb605d9cb1f6b", "4c6b2611d46995726391ac8e", "7cbedc1a9f84e698ff0559b2" ], "nodeLocation": { "x": -41978771.651934244, "y": 59002408.30383155 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "731956eb6e9519fc23a76502", "f64a90f425304d7ba214d3a7" ], "nodeLocation": { "x": 90422663.17406341, "y": -81074474.46306582 } }, "error_handler": { "name": "childJob", "summary": "Duis consequat", "description": "pariatur dolor enim cupidatat nisi", "app": "nulla ut magna labore eiusmod", "variables": { "error": "" }, "groups": [ "ac41ff1ab6839343672ea7d7", "d4dc29fbd7b7b31c42221135", "bc7e47a48637f50684b7992a" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure", "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "28f593c879e91aab124fdb3a", "6e9c45eeb1eba1bbf1a2c2b9", "e964c903ebba9d1f769bd154", "90cc7f60e284dd1e7be72130" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "mollit deserunt eiusmod culpa id", "accessControl": { "read": [ "in minim id cupidatat ipsum", "eu do", "aute et adipisicing in" ], "write": [ "non", "dolore anim", "Duis sint quis nisi", "Excepteur magna fugiat" ], "execute": [ "deserunt nulla proident" ], "manage": [ "quis tempor laboris", "quis irure", "aute aliquip Ut in", "ut quis labore in qui" ] } }, "description": "adipisicing", "preAutomationTime": 250000, "font_size": 12, "created": "1997-09-26T18:46:24.221Z", "created_by": "01ef426626086db2bc4eb575", "last_updated": "1963-04-17T05:02:41.223Z", "last_updated_by": "e8bce4899652d6f39924ebd6", "lastUpdatedVersion": "in", "tags": [ "ea" ], "encodingVersion": 1 } ], "total": 88388981, "start": -90497862, "end": -84443112, "count": -44421321, "limit": 72636113, "next": "voluptate mollit", "previous": "eu in id esse" }

{ "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" } ] } } }