Summary
Run Evaluation Task
Description
Run an evaluation
Route
No Northbound API Available
Roles
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
job_id |
string |
yes |
The Job ID |
all_true_flag |
boolean |
yes |
Set whether all evaluation groups must pass |
evaluation_groups |
array |
yes |
Evaluation groups |
Copied to Clipboard
{
"job_id": "4321abcdef694aa79dae47ad",
"all_true_flag": false,
"evaluation_groups": [
{
"operand_1": false,
"operator": "contains",
"query": "somePropertyNameInOperand_1IfItIsAnObject.nestedProperty",
"rightQuery": "somePropertyNameInOperand_2IfItIsAnObject.nestedProperty"
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"job_id": {
"$ref": "wfEngineCommon#/definitions/mongoObjectId"
},
"all_true_flag": {
"title": "all_true_flag",
"type": "boolean"
},
"evaluation_groups": {
"title": "evaluation_groups",
"type": "array",
"items": {
"$ref": "wfEngineCommon#/definitions/evaluationItem"
}
}
},
"required": [
"job_id",
"all_true_flag",
"evaluation_groups"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
return_value |
boolean |
Result of evaluation |
Copied to Clipboard
{
"type": "boolean",
"title": "return_value"
}