getWorkflows

{ "options": { "limit": 10, "skip": 0, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name,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", "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": [ "ce0c1ba1b5f6f96b2d6f661f", "3b549c2d7677f7718300aa8a", "cb4a3b3c714f6dace639c23a", "abcbcbaa3d823ff43cc5ef75", "a7be5da52a3030950fd5ae15" ], "nodeLocation": { "x": -85861386.00464328, "y": -94542178.43347004 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "5c24668e168bfbbba7e9e998" ], "nodeLocation": { "x": 55208057.134203196, "y": 2146098.9572152942 } }, "error_handler": { "name": "childJob", "summary": "ea et eu quis ut", "description": "reprehenderit dolor dolor in", "app": "ut amet adipisicing", "variables": { "error": "" }, "groups": [ "4e9d9c1f25998167a0ce2e69", "0767fe79d3a81b032bb1aa87", "023193f7ad71c56baff76a7b" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "success" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "181bffa30204c4559f4b321d", "524adba1f87b91ce3c113273", "ddc7e8752eb34a7a9ed70688" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "sunt labore", "accessControl": { "read": [ "ut sint", "in pariatur sed", "esse in cillum enim", "Lorem aliqua id", "nisi cillum commodo" ], "write": [ "exercitation consequat", "ut", "Lorem magna nulla ullamco" ], "execute": [ "veniam deserunt", "incididunt", "irure", "anim dolor occaecat" ], "manage": [ "ut proident deserunt", "Excepteur quis", "voluptate" ] } }, "description": "ut aliquip ipsum qui culpa", "preAutomationTime": 250000, "font_size": 12, "created": "1963-05-21T09:49:44.145Z", "created_by": "7a1690e67c2aca5d4e83b0c5", "last_updated": "1967-03-02T23:47:47.35Z", "last_updated_by": "64adc8fc960462c8c3fd249f", "lastUpdatedVersion": "dolore sunt veniam aliquip mollit", "tags": [ "ipsum", "officia", "cupidatat eu deserunt" ], "encodingVersion": 1 } ], "total": 91956091, "start": 8896502, "end": -29944080, "count": 11457187, "limit": 89858264, "next": "amet", "previous": "in" }

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