Appendix: Common Headers & Types

Common Headers

Headers

Parameter	Type	Description	Required	Notes
Authorization	string	Token used for Authentication	Yes
projectId	string	Default value: "default"	Yes	3.7.0

Related Types

2.2 Task API Related Types

ReplayTaskInfo

Replay Task information

Field	Description	Required	Type
status	Task status	Yes	string
mode	Task mode	Yes	"replay" | "dump"
RTC	Whether RTC Task	No	boolean

VizConfig

Visualization configuration

Field	Description	Required	Type
duration	Start time, end time	Yes	[number, number]
sensors	Sensors	Yes	{ [key: string]: boolean }

OutputConfig

Dump output configuration

Field	Description	Required	Type
dumpHz	Dump rate	Yes	number
h264	h264	Yes	boolean
bitrate	Bitrate	Yes	number
bbox3D	3D bounding box	Yes	boolean

VehicleControl

Ego Vehicle control input information

Field	Description	Required	Type
vehicleId	Ego Vehicle ID	No	number
throttlepercentage	Throttle percentage	No	number
steeringpercentage	Steering percentage	No	number
brakepercentage	Brake percentage	No	number
handBrake	Handbrake state	No	boolean
isManualGear	Whether manual gear	No	boolean
manualGear	Manual gear position	No	number
gearImmediate	Immediate gear shift	No	boolean
activeInput	Active input	No	number
acceleration	Acceleration	No	number
speed	Speed	No	number
signalLights	Signal lights	No	number

TaskListItem

Task item summary information

Field	Description	Required	Type
id	Task ID	Yes	string
parentId	sessionId	Yes	string | null
loading	Whether loading	No	boolean
userId	Username	No	string
userName	User full name	No	string

MainVehicleUIData

Hotzone Ego Vehicle information

Field	Description	Required	Type
id	ID	No	number | null
speed	Speed	No	number | null
throttle	Throttle	No	number | null
steering	Steering	No	number | null
brake	Brake	No	number | null
rpm	RPM	No	number | null
gear	Gear	No	number | null
velocityx	Velocity in x direction	No	number | null
velocityy	Velocity in y direction	No	number | null
velocityz	Velocity in z direction	No	number | null
accelerationx	Acceleration in x direction	No	number | null
accelerationy	Acceleration in y direction	No	number | null
accelerationz	Acceleration in z direction	No	number | null
posx	Position in x direction	No	number | null
posy	Position in y direction	No	number | null
posz	Position in z direction	No	number | null
rotationRate	Rotation rate	No	number | null

2.3 Task Runtime API Related Types

AlgorithmSlot

Controller configuration

Field	Description	Required	Type
id	Placeholder Controller ID	Yes	string
name	Placeholder Controller name	Yes	string
algorithmId	Actual algorithm ID	No	string
algorithmVId	Actual algorithm name	No	string

2.4 Test Plan API Related Types

TestTypes

Test types (supports custom types)

Type	Value
Smoke Test	"1"
Regression Test	"2"
Unit Test	"3"
Functional Test	"4"
System Test	"5"

AlgorithmConfig

WorldSim algorithm configuration

Name	Type	Description	Required
id	string	Algorithm ID within Use Case	Yes
name	string	Algorithm name within Use Case	Yes
algorithmId	string	Algorithm Asset ID	Yes
algorithmVId	string	Algorithm Asset version ID	No

Algorithm

LogSim algorithm configuration

Name	Type	Description	Required
id	string	Algorithm ID within Use Case	Yes
name	string	Algorithm name within Use Case	No
version	string	Algorithm version	No
vId	string	Algorithm Asset version ID	No

VehicleConfig

Vehicle configuration

Name	Type	Description	Required
id	string	Ego Vehicle Asset ID	Yes
classId	string	Ego Vehicle model ID	Yes
instanceId	string	Ego Vehicle instance ID within Use Case, set to Ego	Yes
name	string	Ego Vehicle name	No
algorithms	Array<AlgorithmConfig>	Algorithm configuration referenced within Use Case	Yes

Trigger

Trigger settings

// eg:
// Every day at 12:00
{type: "daily", at: "12:00"}
// Every Monday at 12:00
{type: "weekly", at: "12:00", day: 1}
// Every 1st of the month at 12:00
{type: "monthly", at: "12:00", date: 1}
// Triggered when another test plan finishes, based on result condition: any: any result  passed: passed  failed: not passed
{testplanId: "5051903e-6e52-43c6-b386-702a06c60cca", condition: "any"}

Notification

Execution result notification settings

// eg:
// No notification
{type: "none", condition: "any"}
// groupId: DingTalk config ID  condition any: any result  passed: passed  failed: not passed
{type: "dingtalk", condition: "any", groupId: "5a714bf6-7730-4470-ad82-f6d45d8c367d", groupName: "dev"}

FilterOptions

Test Plan filter options

Field	Description	Required	Type
category	Use Case type	Yes	Enum: "worldsim", "logsim"
search	Search keyword	No	string
types	Test type list	No	TestTypes[]
vehicleIds	Ego Vehicle ID list	No	string[]
algorithms	Algorithm config & version list	No	Array<{ type: string; groupIds?: string[] }>
triggerTypes	Trigger type list	No	Array<Enum: "manual", "conditional", "algorithm", "timed">
notifications	Notification type list	No	Array<{ type: "dingtalk","none"; groupIds?: string[] }>
stateMachine	State machine test script list	No	string[]

TestPlan

Test Plan

Field	Description	Required	Type
id	Test Plan ID (not required when creating)	Yes	string
name	Test Plan name	Yes	string
category	Use Case type	Yes	Enum: "worldsim", "logsim"
categoryIds	Use Case folder ID list	No	string[]
caseSuiteIds	Test Suite ID list	No	string[]
type	Test type	Yes	TestTypes a
Algorithm	LogSim algorithm configuration	No	Algorithm
vehicleConfig	WorldSim Ego Vehicle & algorithm configuration	No	VehicleConfig
overrideJudgementId	Judgment set, "-1" means none	No	string
withEvaluation	Whether to automatically evaluate	No	boolean
evaluationPresetId	Evaluation preset ID, "-1" means none	No	string
triggerType	Trigger type	No	Enum: "manual", "conditional", "algorithm", "timed"
trigger	Required when triggerType is "conditional" or "timed"	No	Trigger
notification	Run result notification configuration	No	Notification
enableStateMachine	State machine test script	No	boolean