Evaluation Report API
3.4 Evaluation Report API¶
3.4.1 Create Evaluation Report¶
Path: /api-evaluation/evaluations
Method: POST
Headers:Headers
Request Parameters¶
| Parameter | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| body | body | Evaluation report info | Yes | Evaluation |
Response Data¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | Evaluation |
3.4.2 Get Single Evaluation Report¶
Path: /api-evaluation/evaluations
Method: GET
Headers:Headers
Request Parameters¶
| Parameter | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| taskId | query | Task ID; only one of taskId or suiteId can be provided | No | string |
| suiteId | query | Test Suite ID | No | string |
Response Data¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | Evaluation |
3.4.3 Batch Get Evaluation Report Status¶
Path: /api-evaluation/evaluations/status
Method: GET
Headers:Headers
Request Parameters¶
| Parameter | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| taskIds | query | Task ID string; only one of taskIds or suiteId can be provided | No | string |
| suiteIds | query | Test Suite ID string | No | string |
Response Data¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | object |
3.4.4 Delete Single Evaluation Report¶
Path: /api-evaluation/evaluations/{id}
Method: DELETE
Headers:Headers
Request Parameters¶
| Parameter | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Report ID | Yes | string |
Response Data¶
| Code | Description |
|---|---|
| 204 | No content |
3.4.5 Trigger Planning & Control Evaluation¶
Path: /api-evaluation/evaluations/evaluate
Method: POST
Headers:Headers
Request Parameters¶
| Parameter | Parameter Format | Description | Required | Type | Notes |
|---|---|---|---|---|---|
| body | body | Contains Test Suite ID and preset ID or operator ID | Yes | { suiteId: string; presetId?: number; algorithmId?: string } | 3.7.0 |
Response Data¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | object |
3.4.6 Check Whether Evaluation Service Is Running¶
Path: /api-evaluation/health
Method: GET
Headers:Headers
Response Data¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | { "code": number, "data": { "message": string } } |