Task API
2.2 Task API¶
2.2.1 Get Running or Replay Task IDs¶
Path： /api-task/sessions/isPlay
Method： GET
Headers：Headers
Request Parameters¶
None
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| testingSessionIds | Running Task IDs | Yes | string[] |
| replaySessionIds | Replay Task IDs | Yes | string[] |
2.2.2 Get Replay Task Status¶
Path： /api-task/sessions/replayTasks
Method： GET
Headers：Headers
Request Parameters¶
None
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| replayTasks | Replay Task status | Yes | Record |
2.2.3 Get Task Queue¶
Path： /api-task/sessions/queue
Method： GET
Headers：Headers
Request Parameters¶
None
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| queue | Queue info | Yes | Record |
2.2.4 Resume Paused Task Set¶
Path： /api-task/sessions/:id/resume
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.2.5 Pause Task¶
Path： /api-task/sessions/:id/pause
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.2.6 Get Task Report¶
Path： /api-task/sessions/:id/report
Method： GET
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Task Set ID | Yes | string |
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| success | Success | Yes | boolean |
Notes¶
After receiving success: true, download using the /report/:id_zh-Hans.pdf URL. For example, if sessionId is 123456, the download URL is: <page-origin>/report/123456_zh-Hans.pdf
2.2.7 Step to Next Frame¶
Path： /api-task/sessions/step
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | body | Task ID | Yes | string |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
None
2.2.8 Modify Simulation Speed¶
Path： /api-task/sessions/speed
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | body | Task ID | Yes | string |
| speed | body | Task speed | Yes | number |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
None
2.2.9 Skip to Time¶
Path： /api-task/sessions/skipTo
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | body | Task ID | Yes | string |
| seconds | body | Task time | Yes | number |
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
None
2.2.10 Update Ego Vehicle Control¶
Path： /api-task/sessions/updateVehicleControl
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| id | body | Task ID | Yes | string |
| egoId | body | Ego Vehicle ID | Yes | string |
| vehicleControl | body | Ego Vehicle control | Yes | VehicleControl |
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
None
2.2.11 Get Replay Task Data¶
Path： /api-task/sessions/:id/replayChartData
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 |
|---|---|---|---|
| timestamp | Timestamp | Yes | string |
| taskId | Task ID | Yes | string |
| caseId | Case ID | Yes | string |
| taskUuid | Task UUID | No | string |
| timeMs | Time | No | number |
| durationMs | Duration | No | number |
| fps | Frame rate | No | number |
| speed | Speed | No | number |
| mainvehicles | Ego Vehicle | No | MainVehicleUIData |
2.2.12 Get Replay Task State¶
Path： /api-task/sessions/:id/taskState
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 |
|---|---|---|---|
| taskId | Task ID | Yes | string |
| isPlay | Whether Replay | Yes | number |
2.2.13 Stop Task Set¶
Path： /api-task/sessions/stop
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| ids | body | Task Set IDs | Yes | string[] |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
None
2.2.14 Delete Task Set¶
Path： /api-task/sessions/delete
Method： POST
Headers：Headers
Request Parameters¶
| Field | Parameter Format | Description | Required | Type |
|---|---|---|---|---|
| ids | body | Task Set IDs | Yes | string[] |
Response Codes¶
| Code | Description |
|---|---|
| 202 | Ok |
Response Data¶
None