app-workflow_engine Schemas

On this page:

wfEngineCommon

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "wfEngineCommon", "type": "object", "title": "Workflow Engine common schema definitions", "definitions": { : { "type": "integer", "description": "The number of documents skipped before returning data. When 0, no data is skipped.", "minimum": 0, "examples": [ 0 ] }, "limit": { "type": "integer", "title": "The returned document limit", "description": "Specifies a limit to the maximum number of data results returned.", "minimum": 0, "maximum": 100, "examples": [ 50 ] }, "total": { "type": "integer", "description": "The total number of documents returned from a search.", "minimum": 0, "examples": [ 100 ] }, "x": { "$id": "#/properties/x", "type": "number", "title": "The X position on the workflow", "description": "The x coordinate position of this task on the workflow", "examples": [ 0.36142061281337046 ] }, "y": { "$id": "#/properties/y", "type": "number", "title": "The Y position on the workflow", "description": "The x coordinate position of this task on the workflow", "examples": [ 0.502092050209205 ] }, "expandedSearchOptions": { "type": "object", "title": "Search Options", "properties": { "expand": { "type": "array", "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", "items": { "type": "string", "examples": [ "created_by", "user", "owner" ] } }, "fields": { "$ref": "#/definitions/queryResultFieldFilter" }, "query": { "$id": "#/properties/options/properties/query", "type": "object", "description": "A MongoDB query object", "additionalProperties": { "type": "string" }, "examples": [ { "name": "abcd" } ] }, "limit": { "$ref": "#/definitions/limit" }, "local": { "$id": "#/properties/options/properties/local", "type": "boolean", "description": "Look on local IAP server" }, "skip": { "$ref": "#/definitions/skip" }, "sort": { "type": "object", "title": "The Sort fields", "description": "Set to sort the documents coming back from the query. If multiple fields, sorts from first field then to last field", "additionalProperties": { "type": "integer", "enum": [ -1, 1 ] }, "examples": [ { "name": -1 } ] } } }, "filteredListSearchOptions": { "name": "options", "description": "Options for displaying getJobList returned data.", "type": "object", "properties": { "filter": { "$ref": "#/definitions/queryResultFieldFilter" }, "page": { "type": "object", "properties": { "skip": { "$ref": "#/definitions/skip" }, "limit": { "$ref": "#/definitions/limit" } } }, "sort": { "type": "object", "properties": { "field": { "type": "string", "examples": [ "name", "description" ] }, "direction": { "enum": [ 1, -1 ], "description": "Specifies ascending sort order if value is 1. Specifies descending sort order if value is -1." } } } } }, "mongoCursorOptions": { "type": "object", "title": "MongoDB Cursor options", "properties": { "comment": { "$id": "#/properties/mongoCursorOptions/properties/comment", "type": "string", "title": "The Cursor Comment", "description": "You can put a comment field on a query to make looking in the profiler logs simpler.", "examples": [ "You can put a comment field on a query to make looking in the profiler logs simpler." ] }, "maxTimeMS": { "$id": "#/properties/mongoCursorOptions/properties/maxTimeMS", "type": "integer", "title": "The Max Time Milliseconds to wait before aborting query", "minimum": 1, "description": "Number of milliseconds to wait before aborting the query.", "examples": [ 1000 ] }, "partial": { "$id": "#/properties/mongoCursorOptions/properties/partial", "type": "boolean", "title": "Return partial results setting", "description": "Specify if the cursor should return partial results when querying against a sharded system." }, "readPreference": { "$id": "#/properties/mongoCursorOptions/properties/readPreference", "type": "string", "title": "The Read Preference Setting", "description": "Control how the client routes the query to members of the replica set. Allowed values are primary, primaryPreferred, secondary, secondaryPreferred, and nearest.", "enum": [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ] }, "timeout": { "$id": "#/properties/mongoCursorOptions/properties/timeout", "type": "boolean", "title": "The Cursor Timeout", "description": "Specify if the cursor can timeout automatically after a period of inactivity.." }, "hint": { "$id": "#/properties/mongoCursorOptions/properties/hint", "type": "object", "title": "The Cursor Hint ", "description": "Tell the query to use specific indexes in the query. See https://docs.mongodb.com/manual/reference/method/cursor.hint/ for more info" }, "limit": { "$ref": "#/definitions/limit" }, "max": { "$id": "#/properties/mongoCursorOptions/properties/max", "type": "integer", "title": "Sets upper bound for a specific index", "description": "Set index upper bound. See https://docs.mongodb.com/manual/reference/method/cursor.max/ for more info" }, "maxScan": { "$id": "#/properties/mongoCursorOptions/properties/maxScan", "type": "integer", "minimum": 1, "title": "The Max Scan ", "description": "Limit the number of items to scan. See https://docs.mongodb.com/manual/reference/method/cursor.maxScan/" }, "min": { "$id": "#/properties/mongoCursorOptions/properties/min", "type": "integer", "title": "The Min lower bound for an index", "description": "Specifies the inclusive lower bound for a specific index. See https://docs.mongodb.com/manual/reference/method/cursor.min/" }, "skip": { "$ref": "#/definitions/skip" }, "snapshot": { "$id": "#/properties/mongoCursorOptions/properties/snapshot", "type": "boolean", "title": "The Snapshot indicator", "description": "Prevents the cursor from returning a document more than once because an intervening write operation results in a move of the document. Cannot be used with sort or hint." }, "sort": { "$id": "#/properties/mongoCursorOptions/properties/sort", "type": [ "object", "array" ], "title": "The Sort options", "description": "Set to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc." }, "filter": { "$ref": "#/definitions/queryResultFieldFilter" }, "returnKey": { "$id": "#/properties/mongoCursorOptions/properties/returnKey", "type": "boolean", "title": "Only return the index key.", "description": "Only return the index key. see https://docs.mongodb.com/manual/reference/method/cursor.returnKey/" }, "explain": { "$id": "#/properties/mongoCursorOptions/properties/explain", "type": "boolean", "title": "The Explain ", "description": "Explain the query instead of returning the data." } } }, "evaluationOperand": { "type": [ "object", "string", "array", "boolean", "integer", "number" ], "title": "A comparison value", "description": "Used in evaluations as either the object to compare, or the object to compare to" }, "evaluationOperator": { "type": "string", "enum": [ "contains", "!contains", "<", "<=", ">", ">=", "==", "!=" ], "title": "The Operator ", "description": "The operation (contains, !contains, <,<=, etc)", "examples": [ "contains" ] }, "evaluationItem": { "type": "object", "title": "Evaluation Object", "description": "Contains all the items/properties needed for a comparison operation/evaluation", "required": [ "operand_1", "operator", "operand_2" ], "properties": { "query": { "type": "string", "title": "The Query ", "description": "Query the operand_1 (optional)", "examples": [ "somePropertyNameInOperand_1IfItIsAnObject" ] }, "operand_1": { "$ref": "#/definitions/evaluationOperand" }, "operator": { "$ref": "#/definitions/evaluationOperator" }, "operand_2": { "$ref": "#/definitions/evaluationOperand" } } }, "mongoObjectId": { "type": "string", "pattern": "^[0-9a-f]{24}$", "title": "MongoDB ObjectID", "description": "String representation of a MongoDB ObjectId", "examples": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ] }, "workflowTaskId": { "type": "string", "pattern": "^[0-9a-f]{4}$|^workflow_start$|^workflow_end$", "title": "Workflow task id", "description": "Four character hexadecimal task identifier", "examples": [ "12ab", "cd34" ] }, "variable": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "MethodName" ] }, "type": { "type": "string", "enum": [ "string", "number", "array", "object", "boolean", "enum", "*" ] }, "description": { "type": "string", "examples": [ "Example description" ] }, "info": { "type": "string", "examples": [ "Example info" ] }, "schema": { "type": "object" } } }, "methodDetails": { "type": "object", "title": "Method details for a task", "properties": { "canvasTab": { "type": "string", "examples": [ "WorkFlowEngine" ] }, "canvasName": { "type": "string", "examples": [ "Function name" ] }, "deprecated": { "type": "boolean" }, "description": { "type": "string", "examples": [ "Method description" ] }, "input": { "type": "array", "items": { "$ref": "#/definitions/variable" } }, "name": { "type": "string", "examples": [ "functionName" ] }, "output": { "$ref": "#/definitions/variable" }, "roles": { "type": "array", "items": { "type": "string", "examples": [ "methodRole" ] } }, "summary": { "type": "string", "examples": [ "Method summary" ] }, "task": { "type": "boolean", "enum": [ true ] } } }, "queryObjectFieldNames": { "name": "query", "type": "object", "title": "Query fields and values", "description": "An object of property name/value pairs to use in the query against a given collection. The property name must exist in the given collection. There must be at least 1 field you query upon. ", "minProperties": 1, "additionalProperties": { "type": [ "string", "number", "integer", "boolean" ], "description": "You can add as many field name/value pairs to the query as you want as long as the field name exists in the collection you're querying" }, "examples": [ { "someFieldName": "Some Value to query the against the someFieldName property" } ] }, "queryResultFieldFilter": { "type": "object", "description": "Filter specifying which fields are returned from a query. The structure of each property must conform to 'fieldName': 1. Eg. name:1 will return the 'name' field and name:0 will exclude the 'name' field from the results", "additionalProperties": { "type": "integer", "enum": [ -1, 1 ] }, "examples": [ { "name": 1 } ] } } }