Appendix: Common Headers & Types¶

Common Headers¶

Headers¶

Name	Type	Description	Required	Notes
Authorization	string	Token for Authentication	Yes
projectId	string	Default value: `"default"`	Yes	3.7.0
accept	application/json	Client accepts JSON data	No

FormDataHeaders¶

Name	Type	Description	Required
Authorization	string	Token for Authentication	Yes
projectId	string	Default value: `"default"`	Yes
Content-Type	multipart/form-data	Data type sent by client	Yes
accept	application/json	Client accepts JSON data	No

AssetList¶

System Asset list

Record\Asset]>

Asset¶

Asset

Name	Type	Description	Required
id	string	ID	Yes
name	string	Name	Yes
userId	string	User ID	Yes
schema	string	Type	Yes
category	string	Directory	Yes
thumbnail	string	Thumbnail file path	No
builtIn	boolean	Whether built-in	No
external	boolean	Whether an external element	No

PartialAsset¶

Partial\<Asset>

Indicates that every key-value pair of Asset is optional.

AssetBaseResponse¶

Response returning an Asset

Name	Type	Description	Required
data	Asset	Asset data	Yes

AssetSaveRequest¶

Request body for updating an Asset

Name	Type	Description	Required
data	PartialAsset	Data of the Asset to update	Yes
sourceId	string	When the Asset contains a file, the uploaded filename	No
overwrite	boolean	Whether to re-enable a deleted Asset	No
needRefresh	boolean	Whether to refresh the page list after update	No

IsRepeatResponse¶

Response indicating whether a name is duplicate

Name	Type	Description	Required
isRepeat	boolean	Whether duplicate	Yes

AssetIsRepeatRequest¶

Request body to check if an Asset name is duplicate

Name	Type	Description	Required
schema	string	Asset type Enum: `"vehicleModel"`, `"trafficflow"`, `"sensor"`, `"judgement"`, `"dynamics"`, `"controller"`	Yes
name	string	Asset name	Yes

GeneralResponse¶

Response returning an ID

Name	Type	Description	Required
id	string	ID of the operated object	Yes

Environment¶

Environment

Name	Type	Description	Required
timeOfDay	double	Current time of day	Yes
lightIntensity	double	Light intensity	Yes
ambientLightIntensity	double	Ambient light	Yes
artificialLightIntensity	double	Artificial light	Yes
heightAngle	double	Elevation angle	Yes
cloudDensity	double	Cloud density	Yes
rainDensity	double	Rain density	Yes
fogDensity	double	Fog density	Yes
snowDensity	double	Snow density	Yes
ground	{ "enable": boolean, "humidityLevel": double, "dirtyLevel": double, "adhesionCoefficient": double }	Ground parameters	Yes
id	string	Environment ID	Yes
name	string	Environment name	Yes
schema	string	Asset type Enum: `"environment"`	Yes
thumbnail	string	Thumbnail path	No
builtIn	boolean	Whether built-in	No
classId	string	Class type	Yes
time	string	Time	Yes

EnvironmentList¶

Use Case environment list

Name	Type	Description	Required
byId	{ [id]: Environment }	Object with environment instance IDs and data as key-value pairs	Yes
allIds	[ string ]	List of environment instance IDs	Yes

CaseSensorList¶

Use Case roadside sensor list

Name	Type	Description	Required
byId	{ [id]: Sensor }	Object with sensor instance IDs and data as key-value pairs	Yes
allIds	[ string ]	List of sensor instance IDs	Yes

JudgementList¶

Use Case Judgment Group list

Name	Type	Description	Required
byId	object	Object with Judgment Group instance IDs and data as key-value pairs	Yes
allIds	[ string ]	Judgment Group instance IDs	Yes

SpecialAreaList¶

Use Case special area list

Name	Type	Description	Required
byId	object	Object with special area instance IDs and data as key-value pairs	Yes
allIds	[ string ]	Special area instance IDs	Yes

MapGenConfigItem¶

Use Case map configuration item

Name	Type	Description	Required
enable	boolean	Whether to auto-generate roadside scene	Yes
distance	double	Spacing	No
distanceToRoadVerge	double	Distance to road verge	No

MapGenConfig¶

Use Case map configuration list (key-value pairs)

Record\MapGenConfigItem>

CommunicationConfig¶

Communication common Parameter settings

Name	Type	Description	Required
frequencyBand	double	Frequency band	Yes
bandwidth	double	Bandwidth	Yes
maxRadiu	double	Maximum coverage radius	Yes
protocol	string	Protocol Enum: `"LTE-V"`	Yes
model	string	Wireless communication propagation model Enum: `"Urban"`, `"Rural"`	Yes
psSwitch	boolean	Whether to enable wireless communication performance simulation	Yes

CaseData¶

Use Case data

Name	Type	Description	Required
environments	EnvironmentList	Environment configuration	Yes
sensors	CaseSensorList	Roadside sensor configuration	Yes
judgements	JudgementList	Judgment Group configuration	Yes
specialAreas	SpecialAreaList	Special area configuration	Yes
mapGenConfig	MapGenConfig	Map configuration	No
communicationParams	CommunicationConfig	Communication common Parameter settings	No
schema	string	Type Enum: `"casedata"`	Yes
caseId	string	Use Case ID	Yes

CaseCreateOptions¶

Use Case creation options

Name	Type	Description	Required
envId	string	Specify environment ID	No
mapGenConfig	MapGenConfig	Map configuration	No
autoMapScene	boolean	Omitted	No
scenario	{ "vehicleId": string, "content": string }	Omitted	No
taskId	string	Used when saving a completed Task as a Use Case; Task ID	No
changeType	boolean	Used when saving a completed Task as a Use Case; whether to convert the Ego Vehicle to an Opponent Vehicle	No

CaseCreateRequest¶

Use Case creation request body

Name	Type	Description	Required
casedata	CaseData	Use Case data	No
options	CaseCreateOptions	Use Case creation options	No
needRefresh	boolean	Whether to refresh the page after creation	No

CaseSaveResponse¶

Response for updating a Use Case

Name	Type	Description	Required
code	double	0 on success	No
msg	string	Response message	No

CaseDefVehicle¶

Use Case Ego Vehicle configuration

Name	Type	Description	Required
id	string	Use Case Ego Vehicle Asset ID	Yes
name	string	Ego Vehicle name	Yes
classId	string	Ego Vehicle model ID	Yes
physicalGradeSensor	double	Number of physical sensors	Yes
category	string	Omitted	No
instanceId	string	Use Case Ego Vehicle instance ID	No
instanceName	string	Instance name in the Use Case	No
instanceColor	string	Instance color	No

CaseDef¶

Use Case

Name	Type	Description	Required
schema	string	Type Enum: `"casedef"`	Yes
id	string	Use Case ID	Yes
name	string	Use Case name	Yes
userId	string	Username	Yes
created	double	Creation time	Yes
lastModified	double	Modification time	Yes
opponent	object	Use Case type	Yes
categoryId	string	Directory ID	No
mapId	string	Map ID	Yes
mapName	string	Map name	No
vehicles	[ CaseDefVehicle ]	Ego Vehicle info list	No
vehicleId	[ string ]	Ego Vehicle ID list	No
tags	[ string ]	Tag list	No
notes	string	Remarks	No
builtIn	boolean	Whether built-in	No
joinway	string	Omitted	No
thumbnail	string	Thumbnail	No
roadSidePhysicalGradeSensor	double	Number of roadside physical sensors	No

PartialCaseDef¶

Partial<CaseDef>

Indicates that every key-value pair of CaseDef is optional.

CaseSaveRequest¶

Use Case update request body

Name	Type	Description	Required
casedef	PartialCaseDef	Use Case info	No
casedata	CaseData	Use Case configuration data	Yes
needRefresh	boolean	Whether to refresh the page after update	No

CaseCloneResponse¶

Use Case clone Response

Name	Type	Description	Required
clonedIds	[ string ]	IDs of successfully cloned Use Cases	Yes

CaseCloneRequest¶

Use Case clone request

Name	Type	Description	Required
ids	[ string ]	IDs of Use Cases to clone	Yes
categoryId	string	ID of the target folder	Yes

CaseMoveResponse¶

Use Case move Response

Name	Type	Description	Required
movedIds	[ string ]	List of Use Case IDs	Yes

CaseMoveRequest¶

Use Case move request

Name	Type	Description	Required
ids	[ string ]	IDs of Use Cases to move	Yes
categoryId	string	ID of the destination folder	Yes

IRow¶

Use Case directory

Name	Type	Description	Required
id	string	Directory ID	Yes
parentId	string	Parent directory ID	No

CaseExportRequest¶

Export Use Cases request

Name	Type	Description	Required
caseIds	[ string ]	List of Use Case IDs	Yes
includesVehicle	boolean	Whether to include the Ego Vehicle	Yes
includesMap	boolean	Whether to include the map	Yes
format	string	Export format Enum: `"simone"`, `"xosc"`	Yes
pathinfo	[ IRow ]	Directory info of Use Cases to export	Yes

CaseImportResponse¶

Import Use Cases Response

Name	Type	Description	Required
id	string	MD5 of the imported file	Yes
isFixed	boolean	Whether format errors were corrected	No
reasons	[ [ string ] ]	Error reasons	No

Recordstringstring¶

Key-value pair (value type is string)

Record\

CaseOverrideInfo¶

Ego Vehicle and map info when importing Use Cases

Name	Type	Description	Required
id	string	Use Cases contained in the uploaded file (including relative path)	Yes
name	string	Name	Yes
replaceMap	boolean	Whether to replace the map	Yes
replaceVehicle	boolean	Whether to replace the Ego Vehicle	Yes
missingMap	boolean	Whether the map is missing	Yes
missingVehicle	boolean	Whether the Ego Vehicle is missing	Yes
overrideMapId	string	ID of the map to replace with	Yes
overrideVehicleId	string	ID of the Ego Vehicle to replace with	Yes
mapId	string	Ignorable	No
mapName	string	Ignorable	No
vehicleIds	[ string ]	Ignorable	No
path	string	Ignorable; Use Cases in the uploaded file (including relative path) + ext	No

CaseImportRequest¶

Import Use Cases request

Name	Type	Description	Required
id	string	uploadId (UUID) when uploading the file	Yes
file	string	MD5 of the file (used as a temporary filename on the server)	Yes
category	string	Directory folder	Yes
includesVehicle	boolean	Whether to include the Ego Vehicle	Yes
includesMap	boolean	Whether to include the map	Yes
includes	[ string ]	Which Use Cases are included in the uploaded file (including relative paths)	Yes
needRemoveCases	Recordstringstring	Pass an empty object `{}`	Yes
overrides	[ CaseOverrideInfo ]	Pass an empty array `[]`	Yes
categoryInfo	Recordstringstring	Pass an empty object `{}`	Yes
includesStopTrigger	boolean	Add a default Use Case end condition (simulation time > 60 s)	No
excludeVehicleIds	[ string ]	Pass an empty array `[]`	No
excludeMapIds	[ string ]	Pass an empty array `[]`	No
replaceVehiclesMap	Recordstringstring	Replaced Ego Vehicles	No
replaceMapIds	[ string ]	Replaced maps (deleted from the Asset library)	No
name	string	Name of the uploaded file	Yes
ext	string	File extension (zip, sim, xosc)	Yes
ignoreNameChecking	boolean	Tag list	No
tags	[ string ]	Tag list	No
notes	string	Remarks	No
needFix	boolean	Whether to validate failed Use Cases	No
needFixCases	[ string ]	Use Cases that failed validation and need to be fixed	No

CheckSensorsRequest¶

Request to check whether sensors configured in a Use Case are overloaded

Name	Type	Description	Required
caseIds	[ string ]	IDs of Use Cases to run	Yes
maxWay	double	Number of sensors supported by the system	Yes
vehicleId	string	Ego Vehicle ID for running the Use Case; pass `"-1"` if no Ego Vehicle is specified	Yes

CreateMapParams¶

Create map Parameters

Name	Type	Description	Required
category	string	Map type (directory) Enum: `"integrated"`, `"atomic"`, `"customized"`, `"city"`, `"city_viaduct"`, `"city_parking"`, `"city_integrated"`, `"i_highway"`, `"i_highway_integrated"`, `"straightway"`, `"turn"`, `"crossroads"`, `"T_junction"`, `"roundabout"`, `"a_highway"`	Yes
id	string	Default is `""`	Yes
name	string	Name	Yes
size	double	Parsed from xodr	Yes
ppm	double	Parsed from xodr	Yes
bgColor	string	Parsed from xodr	Yes
reproject	boolean	Parsed from xodr	Yes
reprojectOrigin	boolean	Parsed from xodr	Yes
reprojectOriginLat	double	Parsed from xodr	Yes
reprojectOriginLng	double	Parsed from xodr	Yes
tags	[ string ]	Tag list	No
notes	string	Remarks	No

MapCreateRequest¶

Create map request

Name	Type	Description	Required
params	CreateMapParams	JSON must be stringified	Yes
xodr	File	xodr file	Yes
thumbnail	File	Map thumbnail file	Yes

UploadFileParams¶

Upload file Parameters

Name	Type	Description	Required
uploadId	string	UUID	Yes
category	string	Business type	Yes
filename	string	Filename	Yes
index	double	Chunk sequence number	Yes
chunks	double	Total number of chunks	Yes
filesize	double	Current chunk size	Yes

FileUploadRequest¶

Upload file request

Name	Type	Description	Required
params	UploadFileParams	JSON must be stringified	Yes
file	File	File	Yes

VehicleList¶

Ego Vehicle list

Name	Type	Description	Required
byId	{[id]: VehicleItem}	Object with Ego Vehicle IDs and data as key-value pairs	Yes
allIds	[ string ]	Ego Vehicle Asset IDs	Yes

BasePageResponseVehicleList¶

Response for getting the Ego Vehicle list

Name	Type	Description	Required
list	VehicleList	Ego Vehicle list	Yes
page	double	Current page number	Yes
total	double	Total Ego Vehicle count	Yes

VehicleCreateRequest¶

Create Ego Vehicle request

Name	Type	Description	Required
name	string	Ego Vehicle name	Yes
classId	string	Ego Vehicle model ID	Yes
overwriteId	string	ID of the Ego Vehicle to overwrite	No

DataBlock¶

Key-value pair

Record\

VehicleDynamics¶

Ego Vehicle dynamics

Name	Type	Description	Required
id	string	ID	Yes
name	string	Name	Yes
schema	string	Asset type `"dynamics"`	Yes
builtIn	boolean	Whether built-in	No
type	string	Dynamics type Enum: `"srvehicles"`, `"srvehicle-truck"`, `"srvehicle-bus"`, `"carsim"`, `"carmaker"`, `"vigrade"`, `"none"`	Yes
params	DataBlock	Dynamics Parameters	Yes

VehicleCtl¶

Ego Vehicle Controller

Name	Type	Description	Required
id	string	ID	Yes
type	string	Type	Yes
name	string	Name	Yes
params	DataBlock	Controller Parameters	Yes
aideId	string	Auxiliary Controller ID	No
builtIn	boolean	Whether built-in	No

SensorOutput¶

Sensor output settings

Name	Type	Description	Required
byType	{[selected]: any}	Output configuration	Yes
selected	string	Output format	Yes

Sensor¶

Sensor

Name	Type	Description	Required
id	string	ID	Yes
name	string	Name	Yes
schema	string	Asset type Enum: `"sensor"`	Yes
category	string	Directory ID	Yes
thumbnail	string	Thumbnail path	No
builtIn	boolean	Whether built-in	No
classId	string	Class type	Yes
x	double	X-axis position	Yes
y	double	Y-axis position	Yes
z	double	Z-axis position	Yes
roll	double	Roll angle	Yes
pitch	double	Pitch angle	Yes
yaw	double	Yaw angle	Yes
params	DataBlock	Sensor Parameters	Yes
includeIds	[ string ]	When fusing sensors, which sensors are fused	No
output	SensorOutput	Sensor output settings	No
disabled	boolean	Whether disabled	No
presetId	string	For non-built-in sensors, the original sensor ID	No

VehicleItem¶

Ego Vehicle

Name	Type	Description	Required
id	string	ID	Yes
name	string	Name	Yes
thumbnail	string	Thumbnail path	No
builtIn	boolean	Whether built-in	No
schema	string	Type Enum: `"vehicle"`	Yes
classId	string	Model ID	Yes
driver	string	Ignored Enum: `"ai"`, `"human"`	Yes
dynamics	VehicleDynamics	Dynamics Parameters	Yes
controller	VehicleCtl	Controller	Yes
category	string	Ego Vehicle category Enum: `"Bike"`, `"Vehicle"`, `"Pedestrian"`	Yes
sensors	[ Sensor ]	Sensor configuration	Yes

PartialVehicleItem¶

Partial\<VehicleItem>

Indicates that every key-value pair of VehicleItem is optional.

VehicleSaveResponse¶

Response for updating an Ego Vehicle

Name	Type	Description	Required
data	PartialVehicleItem	Updated data	Yes

VehicleSaveRequest¶

Request to update an Ego Vehicle

Name	Type	Description	Required
data	PartialVehicleItem	Ego Vehicle info	Yes
overwrite	boolean	Whether to re-enable a deleted Ego Vehicle	No
needRefresh	boolean	Whether to refresh the page after update	No

IsRepeatRequest¶

Request to check if an Ego Vehicle or Test Suite name is duplicate

Name	Type	Description	Required
name	string	Name	Yes

VehiclesCreateRequest¶

Import Ego Vehicles request

Name	Type	Description	Required
vehicleData	VehicleList	Data of Ego Vehicles to import	Yes

VehicleReplaceRequest¶

Request to update Ego Vehicle resource files

Name	Type	Description	Required
params	{ "type": "controller" or "dynamics" }	Replace Controller or dynamics-related resources; must be stringified	Yes
file	File	Resource file to replace	Yes

SuiteList¶

Test Suite list

Name	Type	Description	Required
byId	{[id]: Suite}	Suite ID and data key-value pairs	Yes
allIds	[ string ]	Test Suite ID list	Yes

SuiteCreateRequest¶

Create Test Suite request

Name	Type	Description	Required
parentId	string	Parent directory ID	Yes
name	string	Name	Yes

Suite¶

Test Suite

Name	Type	Description	Required
schema	string	Type Enum: `"suite"`	Yes
id	string	ID	Yes
name	string	Name	Yes
userId	string	User ID	Yes
parentId	string	Parent directory ID	Yes
caseIds	[ string ]	Included Use Case IDs	No

PartialSuite¶

Partial\<Suite>

Indicates that every key-value pair of Suite is optional.

SuiteSaveResponse¶

Response for updating a Test Suite

Name	Type	Description	Required
data	PartialSuite	Updated Test Suite	Yes

SuiteSaveRequest¶

Request to update a Test Suite

Name	Type	Description	Required
data	PartialSuite	Test Suite to update	Yes
caseIds	[ string ]	List of Use Case IDs to operate on	No
delete	boolean	Whether to delete or add `caseIds`	No

CategoryMoveRequest¶

Move Test Suite request

Name	Type	Description	Required
dragId	string	ID of the Test Suite to move	Yes
dropId	string	Move relative to this Test Suite	Yes
state	string	Position relative to `dropId` Enum: `"up"`, `"down"`, `"inside"`	Yes

ObstacleNpc¶

Opponent Vehicle element

Name	Type	Description	Required
id	string	ID	Yes
category	string	Type	Yes
schema	string	Element category Enum: `"dynamic"`, `"static"`	Yes
assetId	double	Asset ID	No
name	string	Name	No
uicategory	string	Directory ID	No
oscSubCategory	string	OSC type	No
resourceType	string	Element resource type Enum: `"model"`, `"chartlet"`, `"external"`	No
resourceMd5	string	Resource file MD5	No
thumbnail	string	Thumbnail path	Yes
interpo	string	Ignored Enum: `"clothoid"`, `"legacy"`	Yes
semantic	string	Semantic type Enum: `"vehicle"`, `"none"`	Yes
builtIn	boolean	Whether built-in	No
modelPath	string	External model path	No
aniPath	string	External animation path	No
dimensions	{ "length": double, "width": double, "height": double }	Dimensions	No
originToCenter	{ "x": double, "y": double, "z": double }	Origin position	No

PartialObstacleNpc¶

Partial\<ObstacleNpc>

Indicates that every key-value pair of ObstacleNpc is optional.

BasePageResponseObstacleNpcArray¶

Response for getting the Opponent Vehicle list

Name	Type	Description	Required
list	[ ObstacleNpc ]	Opponent Vehicle list	Yes
page	double	Current page number	Yes
total	double	Total count	Yes

ObstacleCreateRequest¶

Create Opponent Vehicle request

Name	Type	Description	Required
data	PartialObstacleNpc	Element Parameters	Yes
sourceId	string	MD5 of the uploaded file	Yes
thumbnailId	string	MD5 of the uploaded thumbnail	No

AlgorithmListResponse¶

Response for getting the algorithm list

Name	Type	Description	Required
list	[ Algorithm ]	Algorithm list	Yes
page	double	Current page number	Yes
total	double	Total count	Yes

Algorithm¶

Algorithm

Name	Type	Description	Required	Notes
id	string	Algorithm ID	Yes
name	string	Name	Yes
type	string	Type Enum: `"client"`, `"cloud"`, `"builtIn"`	Yes
activatedId	string	Latest algorithm version ID	Yes
activated	AlgorithmVersion	Latest algorithm version	No
clientId	string	Owning client UUID	No	3.7.0

AlgorithmVersion¶

Algorithm version

Name	Type	Description	Required
id	string	Algorithm version ID	Yes
algorithmId	string	Owning algorithm ID	Yes
type	string	Integration method Enum: `"Manual"`, `"SM"`, `"SimOneDriver"`, `"Simulator"`, `"Simulink"`, etc.	Yes
params	object	Algorithm Parameters	Yes
notes	string	Remarks	No

AlgorithmCreateData¶

Algorithm creation Parameters

Name	Type	Description	Required
name	string	Name	Yes
type	string	Type Enum: `"client"`, `"cloud"`, `""`	Yes
versionData	object	Partial<AlgorithmVersion>	Yes
projectId	string	Project ID	No
notes	string	Remarks	No
id	string	Algorithm ID	No