getWorkflows

{ "options": { "limit": 50, "skip": 10, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name", "exclude": "_id", "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": [ "2aa7acbaf07146b1ac9e6fa9", "592d8699e7dde03b29c64c0b", "5d92700ed814e3482a63f52a", "428371d1e6d74607fd32b9ed" ], "nodeLocation": { "x": 34011386.44772433, "y": -56263307.761515155 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "006e6a08b85f7d3b6dbd6ff1", "81e40603022e040e9ac25491", "9761e33be814a94fa86dec6c", "a99423e109586c2ab3e57603", "a36515a43f50cdaafa1e0c69" ], "nodeLocation": { "x": -67536016.04587378, "y": 78322627.04121494 } }, "error_handler": { "name": "childJob", "summary": "pariatur aute non aliqua quis", "description": "consectetur cupidatat", "app": "voluptate adipisicing", "variables": { "error": "" }, "groups": [ "9c918a90dd5225e0ceafcdb9", "77f98017c45528a8e07510b5", "2d504a72f061855aa7390c69" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "error", "error", "failure", "success" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "8aace2dbe783123ff717a343" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "officia minim", "accessControl": { "read": [ "ut sint culpa et ut", "Excepteur laboris ex quis nostrud", "exercitation veniam do dolor" ], "write": [ "sed officia dolor", "aliqua", "in", "est" ], "execute": [ "elit" ], "manage": [ "dolore Duis ea velit incididunt", "eu", "dolor dolore ea id eiusmod", "ut anim fugiat amet nulla", "sed culpa laboris" ] } }, "description": "culpa Duis", "preAutomationTime": 250000, "font_size": 12, "created": "2003-12-04T01:09:37.37Z", "created_by": "11097213a678223031bc206c", "last_updated": "1989-11-06T20:12:25.536Z", "last_updated_by": "9e08bd0ab52588e95eac4ace", "lastUpdatedVersion": "aliquip", "tags": [ "amet ut commodo", "ea", "nulla nisi veniam consectetur anim", "in ut incididunt Duis", "adipisicing velit" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "d3cfeebb80728c68aaa845a8", "2acf91cbc045e3302de7a43b", "0479f3f72ac37213d32ecce3", "73859712858fb7e646bc3bcf", "28a2c04a117c59e1ddb206b2" ], "nodeLocation": { "x": -65228084.819396146, "y": 41695465.510165066 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "829c3d3164d3f3c67dce7a5a", "6aaa42a67ee633e31cc56f0a", "21300402d4a71c9cd4a0051e" ], "nodeLocation": { "x": 61020105.51148528, "y": 5667368.669936717 } }, "error_handler": { "name": "childJob", "summary": "consectetur mollit", "description": "irure deserunt", "app": "laboris sed", "variables": { "error": "" }, "groups": [ "58423a891092bbd5d2bb3fdc", "29a501b25bc9027ac08756eb", "1cfba42cc1f4e22290b14fbb" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "failure", "failure" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "746873e7890cfb35e7daa4d3", "602c046a17c380fc6947e7ff", "82d7d5bc70f1d1a37a7b1ce5" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "cupidatat do nisi adipisicing et", "accessControl": { "read": [ "laboris esse quis amet", "qui velit" ], "write": [ "ea eu", "aliqua ut consectetur dolor" ], "execute": [ "laboris consectetur" ], "manage": [ "tempor", "ut do occaecat", "occaecat dolor mollit", "voluptate quis ex" ] } }, "description": "ut aliquip", "preAutomationTime": 5000, "font_size": 12, "created": "2021-10-16T11:25:27.621Z", "created_by": "d4a96ebcd37af9d339fe5f39", "last_updated": "1975-03-14T11:58:27.91Z", "last_updated_by": "43d9d32e28fd0fc8755c5522", "lastUpdatedVersion": "ullamco", "tags": [ "Ut pariatur anim exercitation" ], "encodingVersion": 1 } ], "total": -66671323, "start": -75134027, "end": 8320932, "count": -65902275, "limit": -5140357, "next": "dolor", "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" } ] } } }