Task Runtime API
2.3 Task Runtime API¶
2.3.1 Get Task List¶
Path： /api-task/tasks/
Method： GET
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| finished | query | Whether completed | Yes | boolean |
| page | query | Page number | Yes | string |
| pageSize | query | Items per page | Yes | string |
| own | query | Whether own Tasks | Yes | boolean |
| expandedIds | query | Expanded Task IDs | Yes | string[] |
| filters | query | Filters | No | string[] |
| searchFilter | query | Search keyword | No | string |
| startTime | query | Start time | No | number |
| endTime | query | End time | No | number |
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| list | Task list | Yes | TaskListItem[] |
| page | Page number | Yes | number |
| total | Total pages | Yes | number |
| pageSize | Items per page | Yes | number |
2.3.2 Get Task Details¶
Path： /api-task/tasks/task
Method： GET
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| taskIds | query | Expanded Task IDs | Yes | string[] |
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| tasks | Task list | Yes | TaskListItem[] |
TaskListItem¶
| Field | Description | Required | Type |
|---|---|---|---|
| id | Task ID | Yes | string |
| parentId | sessionId | Yes | string | null |
| loading | Whether loading | No | boolean |
| userId | Username | No | string |
| userName | User full name | No | string |
2.3.3 Get Task Count¶
Path： /api-task/tasks/count
Method： GET
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| own | query | Whether own Tasks | Yes | boolean |
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| count | Task count | Yes | number |
2.3.4 Get Task Queue¶
Path： /api-task/tasks/queue
Method： GET
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| own | query | Whether own Tasks | Yes | boolean |
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| total | Total Task count | Yes | number |
| running | Running Task count | Yes | number |
| pending | Pending Task count | Yes | number |
| waiting | Waiting Task count | Yes | number |
| finished | Finished Task count | Yes | number |
| estimatedTaskDuration | Estimated Task duration | Yes | number |
2.3.5 Clear All Tasks (Requires Admin Privileges)¶
Path： /api-task/tasks/clean
Method： POST
Headers：Headers
Request Parameters¶
None
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
None
2.3.6 Get Task by ID¶
Path： /api-task/tasks/:id/task
Method： GET
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Task ID | Yes | string |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
None
2.3.7 Create Task¶
Path： /api-task/tasks/
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type | Notes |
|---|---|---|---|---|---|
| caseIds | body | Case IDs | Yes | string[] | |
| taskName | body | Task name | Yes | string | |
| ~~controllers~~ | body | Task name | Yes | AlgorithmSlot | Removed |
| ~~overrideVehicleId~~ | body | Override Ego Vehicle ID | No | string | Removed |
| vehicleConfig | body | WorldSim vehicle & algorithm config | Yes | VehicleConfig | 3.7.0 |
| overrideJudgementId | body | Override Judgment ID | No | string | |
| evaluationPresetId | body | Evaluation preset ID | No | string | |
| withEvaluation | body | Whether to evaluate | No | boolean | |
| notification | body | Run result notification config | No | Notification | 3.7.0 |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| sessionId | sessionId | Yes | string |
| taskIds | Task IDs | Yes | string[] |
2.3.8 Replay Specified Task¶
Path： /api-task/tasks/:id/replay
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Task ID | Yes | string |
| RTC | query | Whether RTC Task | No | boolean |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| taskId | Task ID | Yes | string |
2.3.9 Observe Task Visualization¶
Path： /api-task/tasks/:id/observe
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Task ID | Yes | string |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
None
2.3.10 Dump Task¶
Path： /api-task/tasks/:id/dump
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Task ID | Yes | string |
| vizConfig | body | Items per page | Yes | VizConfig |
| outputConfig | body | Items per page | Yes | OutputConfig |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
None
2.3.11 Get Task Data¶
Path： /api-task/tasks/:id/data
Method： GET
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Task ID | Yes | string |
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| success | Success | Yes | boolean |
2.3.12 Create Replay Use Case¶
Path： /api-task/tasks/convert2case
Method： GET
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| name | path | Case name | Yes | string |
| categoryId | body | Save directory ID | Yes | string |
| opponent | body | Save type: Replay Use Case or standard Use Case | No | "record" | "openscenario" |
| ego2npc | body | When saving as standard Use Case, whether to convert Ego Vehicle to Opponent Vehicle | No | boolean |
| tags | body | Tags | No | string[] |
| notes | body | Case notes | No | string |
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
| 404 | Not Found |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| id | ID | Yes | string |
2.3.12 Stop Task¶
Path： /api-task/tasks/stop
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| all | query | Whether to stop all Tasks | No | boolean |
| ids | body | Task IDs | Yes | string[] |
| isReplay | body | Whether Replay | No | boolean |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
None
2.3.13 Stop Replay Task¶
Path： /api-task/tasks/stopReplay
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| ids | body | Task IDs | Yes | string[] |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
None
2.3.14 Delete Task¶
Path： /api-task/tasks/delete
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| taskIds | body | Task IDs | Yes | string[] |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
None
2.3.15 Check Whether Task Has Finished¶
Path： /api-task/tasks/:id/hasFinished
Method： GET
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Task ID | Yes | string |
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| hasFinished | Whether Task has finished | Yes | boolean |