getWorkflows

{ "options": { "limit": 10, "skip": 50, "order": 1, "sort": "name", "exclude-project-members": true, "include": "description", "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": [ "8c879a460c41346fa8b2e80d", "ab9fcd9a3247f879fed18f46", "2c74c1697dfae803119a7758" ], "nodeLocation": { "x": -91769730.30955589, "y": 67028250.703597486 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "48a3e7fe049ae7ae49f9e858", "2b331ac790ee2bb8afd98436" ], "nodeLocation": { "x": 33451193.65865372, "y": 5574501.522930935 } }, "error_handler": { "name": "childJob", "summary": "in aliquip", "description": "esse enim Ut Lorem", "app": "incididunt occaecat mollit laborum", "variables": { "error": "" }, "groups": [ "92d6df7851ec5090636f621f", "4765c00a20256a9e5696527a", "f53598b4e97dbc9d9f911a41", "1b5bd3944b04f82c138a71ce" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure", "success", "failure" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "36864ef0778369e0bf3b806a", "0eb248955dedab68e09fd8c1", "0a0e785b2117f2180b4e00b6", "26d0dad2cc3d6658f2b6f73a" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "magna est", "accessControl": { "read": [ "do laborum ullamco ut", "cillum esse est sed", "sed reprehenderit sint esse labore", "dolore id fugiat sed", "id Ut incididunt" ], "write": [ "aute", "irure anim nisi non ea", "dolore ea sit", "culpa veniam ex" ], "execute": [ "ullamco in non", "fugiat in et", "consectetur ex aliquip laborum", "dolore aliqua aliquip officia", "mollit" ], "manage": [ "minim cillum nostrud", "sunt Excepteur cillum", "sed dolore nisi", "cupidatat anim" ] } }, "description": "est eu", "preAutomationTime": 250000, "font_size": 12, "created": "2013-12-12T15:10:04.514Z", "created_by": "e4cd5e5ffcec438f5feca89c", "last_updated": "1983-10-05T03:03:50.26Z", "last_updated_by": "33b00130ec7987f6560d578b", "lastUpdatedVersion": "dolore nostrud cillum consequat esse", "tags": [ "proident", "reprehenderit ex", "consectetur sunt Duis commodo ullamco" ], "encodingVersion": 1 } ], "total": -7948471, "start": -8497485, "end": -81030449, "count": -30456721, "limit": -73385553, "next": null, "previous": "sed minim" }

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