getWorkflows

{ "options": { "limit": 1, "skip": 1, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name,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": [ "25060c5d28d39cda93b0a5a9", "f5718ee8cadad377e2b7b4b4", "d77cc1373f9be7fc59283e46", "7cd30d0ec652c536c3a953eb" ], "nodeLocation": { "x": 91743163.80511743, "y": -96468392.05852848 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "bd9f83aea8f4e3330bc3440a", "4119e929624399d99ffc51e0", "f39909c93fe54c22764ab83f", "ec5e3dc733919ff75d54dcc2" ], "nodeLocation": { "x": -36730435.72870567, "y": 24421741.526088163 } }, "error_handler": { "name": "childJob", "summary": "culpa", "description": "commodo tempor ut", "app": "aliquip sit cupidatat sint", "variables": { "error": "" }, "groups": [ "a4bd100b8721d287b5cf59da", "ad181deadcaaa64cff0093b2", "5d4fb7cc0ed4d06b24d3a7ce" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "26e62c63bd5b3a5a595afb6f" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "eu consectetur non dolor commodo", "accessControl": { "read": [ "ipsum est magna consequat labore", "enim Excepteur veniam", "non sit aliquip exercitation commodo" ], "write": [ "est veniam laborum voluptate dolor", "do proident", "enim aliquip mollit in", "nostrud" ], "execute": [ "officia nisi dolore pariatur", "et minim mollit", "anim in occaecat irure minim", "commodo in", "magna occaecat ullamco officia" ], "manage": [ "laboris elit incididunt", "anim dolore exercitation aliquip", "dolor voluptate reprehenderit" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1957-11-18T22:41:59.328Z", "created_by": "e4f326e5bc62c4f98d8cb6e3", "last_updated": "1997-07-03T10:01:46.555Z", "last_updated_by": "45e70a97e9d6aed715d4cebd", "lastUpdatedVersion": "exercitation dolore dolor", "tags": [ "ea ipsum cillum enim veniam", "velit", "qui in deserunt", "ullamco tempor do dolore consequat", "irure laboris cupidatat" ], "encodingVersion": 1 } ], "total": 97528902, "start": -46498761, "end": -10416487, "count": 47787585, "limit": -56318627, "next": null, "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" } ] } } }