Asset API
4.1 Asset API¶
4.1.1 Get Asset List¶
Path： /api-asset/assets
Method： GET
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| schema | query | Asset type Enum: "vehicleModel", "trafficflow", "sensor", "judgement", "dynamics", "controller" |
No | string |
| category | query | Directory ID | No | string |
| vehicleOnly | query | When "true", returns only Assets used by the Ego Vehicle editor page |
No | string |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | AssetList |
4.1.2 Create an Asset¶
Path： /api-asset/assets
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | data: Asset data； sourceId: When the Asset contains a file, the uploaded filename (md5)； overwriteId: If provided, overwrites the existing Asset with this ID |
No | { "data": Asset, "sourceId": string, "overwriteId": string } |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | AssetBaseResponse |
4.1.3 Get a Specific Asset¶
Path： /api-asset/assets/{id}
Method： GET
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | ID of the Asset to retrieve | Yes | string |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | Asset |
4.1.4 Update an Asset¶
Path： /api-asset/assets/{id}
Method： PUT
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | ID of the Asset to update | Yes | string |
| requestBody | body | Request body | Yes | AssetSaveRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | AssetBaseResponse |
4.1.5 Delete an Asset¶
Path： /api-asset/assets/{id}
Method： DELETE
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | ID of the Asset to delete | Yes | string |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | AssetBaseResponse |
4.1.6 Check for Duplicate Asset¶
Path： /api-asset/assets/isrepeat
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | AssetIsRepeatRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | IsRepeatResponse |
4.1.7 Clone an Asset¶
Path： /api-asset/assets/{id}/clone
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | ID of the Asset to clone | Yes | string |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | AssetBaseResponse |