Task API
3.2 Task API¶
3.2.1 Get Task List Under Specified Test Suite¶
Path： /api-evaluation/tasks
Method： GET
Headers：Headers
Request Parameters¶
| Parameter | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| suite | query | Test Suite ID | Yes | string |
| page | query | Current page | No | number |
| pageSize | query | Items per page | No | number |
| sort | query | Sort type "time" | "score" |
No | string |
| order | query | Order direction "ASC" | "DESC" |
No | string |
Response Data¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | TaskResponse |
3.2.2 Create Task¶
Path： /api-evaluation/tasks
Method： POST
Headers：Headers
Request Parameters¶
| Parameter | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| task | body | Task info including id, name, etc. | Yes | { "task": Task } |
Response Data¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | Task |
3.2.3 Get Single Task Details¶
Path： /api-evaluation/tasks/{id}
Method： GET
Headers：Headers
Request Parameters¶
| Parameter | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Task ID | Yes | string |
Response Data¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | Task |
3.2.4 Update Single Task¶
Path： /api-evaluation/tasks/{id}
Method： PUT
Headers：Headers
Request Parameters¶
| Parameter | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Task ID | Yes | string |
| data | body | Task info to update | Yes | { "data": Task } |
Response Data¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | Task |
3.2.5 Batch Delete Tasks¶
Path： /api-evaluation/tasks/remove
Method： POST
Headers：Headers
Request Parameters¶
| Parameter | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| ids | body | Task ID list | Yes | { "ids": [ string ] } |
Response Data¶
| Code | Description |
|---|---|
| 204 | No content |