Skip to content

Test Suite / Directory / Opponent Element API

4.6 Test Suite API

4.6.1 Get Test Suite List

Path: /api-asset/suites

Method: GET

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
opponent query Use Case type Enum: "openscenario" Yes string
Response
Code Description Type
200 Ok SuiteList


4.6.2 Create a Test Suite

Path: /api-asset/suites

Method: POST

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
requestBody body Request body Yes SuiteCreateRequest
Response
Code Description Type
200 Ok GeneralResponse



4.6.3 Get a Test Suite

Path: /api-asset/suites/{id}

Method: GET

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
id path Test Suite ID Yes string
Response
Code Description Type
200 Ok Suite


4.6.4 Update a Test Suite

Path: /api-asset/suites/{id}

Method: PUT

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
id path Test Suite ID Yes string
requestBody body Request body Yes SuiteSaveRequest
Response
Code Description Type
200 Ok SuiteSaveResponse


4.6.5 Delete a Test Suite

Path: /api-asset/suites/{id}

Method: DELETE

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
id path Test Suite ID Yes string
opponent query Use Case type Enum: "openscenario" No string
Response
Code Description Type
200 Ok GeneralResponse



4.6.6 Move a Test Suite

Path: /api-asset/suites/move

Method: POST

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
requestBody body Request body Yes CategoryMoveRequest
Response
Code Description Type
200 Ok {}



4.6.7 Check for Duplicate Test Suite Name

Path: /api-asset/suites/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.7 Page Directory API

4.7.1 Get Directory List

Path: /api-asset/categories

Method: GET

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
pageType query Page type Enum: "assets", "case", "vehicle", "judgeAsset" Yes string
Response
Code Description Type
200 Ok AssetList



4.8 Opponent Vehicle API

4.8.1 Get Opponent Vehicle List

Path: /api-asset/obstacles

Method: GET

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
schema query Enum: "dynamic", "static"
Obstacle type; can be omitted when category is specified
Yes string
category query Directory ID Yes string
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 BasePageResponseObstacleNpcArray


4.8.2 Create a Custom Opponent Vehicle

Path: /api-asset/obstacles

Method: POST

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
requestBody body Request body Yes ObstacleCreateRequest
Response
Code Description Type
200 Ok { "npc": ObstacleNpc }



4.8.3 Get a Specific Opponent Vehicle

Path: /api-asset/obstacles/{id}

Method: GET

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
id path Opponent Vehicle ID Yes string
Response
Code Description Type
200 Ok { "npc": ObstacleNpc }


4.8.4 Update an Opponent Vehicle

Path: /api-asset/obstacles/{id}

Method: PUT

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
id path Opponent Vehicle ID Yes string
requestBody body Request body Yes ObstacleCreateRequest
Response
Code Description Type
200 Ok { "npc": ObstacleNpc }


4.8.5 Delete a Custom Opponent Vehicle

Path: /api-asset/obstacles/{id}

Method: DELETE

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
id path ID of the element to delete Yes string
Response
Code Description Type
200 Ok { "id": string, "schema": string }



4.8.6 Check for Duplicate Opponent Vehicle Name

Path: /api-asset/obstacles/isrepeat

Method: POST

Headers:Headers

Request Parameters
Parameter Name Format Description Required Type
requestBody body Request body Yes { "name": string; "id"?: string }
Response
Code Description Type
200 Ok IsRepeatResponse