Test a task workflow project¶
Execute project tests in the current generation task and read the coverage report. See common information for objects, variables, and environment boundaries.
POST https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-candidates/test
Before you call this API¶
Keep the injected service address, credentials, workspace, and short-lived authorization in the current generation task’s execution environment. Use the complete original authorization header value. Install jq and set the example variables.
Request body¶
jq -n --slurpfile files "$PROJECT_FILES_JSON" '{project_files:$files[0]}' > request.json
curl -X POST "${MOI_ENDPOINT%/}/workflow/v2/workflow-candidates/test" \
-H "X-API-Key: $MOI_API_KEY" \
-H "X-Workspace-ID: $MOI_WORKSPACE_ID" \
-H "X-MOI-Runtime-Authorization: $MOI_RUNTIME_AUTHORIZATION" \
-H 'Content-Type: application/json' \
--data-binary @request.json
Mutually exclusive with request, scratch, cases_dir, workflow, custom_operators, runtime_fields, verification_source, and nonzero catalog_id. Tests actually execute nodes and may perform external actions. Use test materials authorized for the task. Single-case diagnostics and verification_only do not replace full execution. status=completed means report generation completed. Inspect suite coverage, failures, and missing external actions, and check candidate test_status after submission. Legacy request modes require separate review.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
object |
Required for this branch |
The same file snapshot used by the submission API. |
|
string |
No |
Diagnose a specific case using a JSON filename under tests/cases/, without its directory. |
|
boolean |
No |
Rerun previous result assertions only; depends on existing suite results for the same execution content. |
|
string |
No |
If supplied, must match the current task. This API does not use a nested scope. |
|
string |
No |
If supplied, must match the current generation conversation. |
|
string |
No |
If supplied, must match the task’s frozen role. Do not invent role authorization. |
Successful response¶
{
"code": "OK",
"msg": "OK",
"data": {
"status": "completed",
"execution_coverage": {
"suite": {
"status": "completed",
"diagnostic_only": true,
"message": "此示例仅说明诊断报告,不能据此提交为测试通过"
}
}
}
}
Field |
Type |
Description |
|---|---|---|
|
string |
OK on success. |
|
string |
Response information. |
|
object |
Result of this action. |
|
string |
Status of this test report. |
|
object |
Suite results for the current project, including status and optional cases, results, diagnostics, and similar fields. |
|
boolean |
true means diagnostic only and cannot establish a full candidate test pass. |
|
string[] |
When present, external-action nodes still missing coverage. |
Error responses¶
Handle the HTTP status and business fields. History queries and recovery have dedicated error codes; see errors and environments. Retain identity, source references, and operation identifiers before checking state and proceeding. Do not automatically replace workspaces, candidates, or confirmation keys.