Ego Vehicle API
4.5 Ego Vehicle API¶
4.5.1 Get Ego Vehicle List¶
Path: /api-asset/vehicles
Method: GET
Headers:Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| page | query | Page number | No | string |
| pageSize | query | Items per page | No | string |
| search | query | Search keyword | No | string |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | BasePageResponseVehicleList |
4.5.2 Create an Ego Vehicle¶
Path: /api-asset/vehicles
Method: POST
Headers:Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | VehicleCreateRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | GeneralResponse |
4.5.3 Get a Specific Ego Vehicle¶
Path: /api-asset/vehicles/{id}
Method: GET
Headers:Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Ego Vehicle ID | Yes | string |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | VehicleItem |
4.5.4 Update an Ego Vehicle¶
Path: /api-asset/vehicles/{id}
Method: PUT
Headers:Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | VehicleSaveRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | VehicleSaveResponse |
4.5.5 Delete an Ego Vehicle¶
Path: /api-asset/vehicles/{id}
Method: DELETE
Headers:Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | ID of the Ego Vehicle to delete | Yes | string |
Response¶
| Code | Description | Type |
|---|---|---|
| 202 | Ok | object |
4.5.6 Check if an Ego Vehicle Name is Duplicate¶
Path: /api-asset/vehicles/isrepeat
Method: POST
Headers:Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | IsRepeatRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | IsRepeatResponse |
4.5.7 Clone an Ego Vehicle¶
Path: /api-asset/vehicles/{id}/clone
Method: POST
Headers:Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Ego Vehicle ID | Yes | string |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | GeneralResponse |
4.5.8 Update Ego Vehicle Resource Files¶
Path: /api-asset/vehicles/{vehicleId}/files
Method: POST
Headers:FormDataHeaders
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| vehicleId | path | Ego Vehicle ID | Yes | string |
| formData | body | Request body | Yes | VehicleReplaceRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | GeneralResponse |
4.5.9 Get Ego Vehicle Count¶
Path: /api-asset/vehicles/count
Method: GET
Headers:Headers
Request Parameters¶
None
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | { "count": double } |
4.5.10 Import Ego Vehicles¶
Path: /api-asset/vehicles/import
Method: POST
Headers:Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | VehiclesCreateRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | GeneralResponse |