Skip to content

Appendix: Common Headers & Types

Common Headers

Headers

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

Common Response

Response

Parameter Name Type Description Required
data { "code": number} Yes
Suite

Test Suite

Parameter Name Type Description Required
id string Test Suite ID Yes
name string Test Suite name Yes
withEvaluation boolean Whether Evaluation is enabled Yes
presetId number Current preset No
algorithmName string Current algorithm name No
algorithmVersion string Current algorithm version No
startTime number Test Suite start time Yes
endTime number Test Suite end time No
SuiteResponse

Test Suite Response

Parameter Name Type Description Required
total number Total count Yes
suites [ Suite ] Test Suite list Yes

Task

Task

Parameter Name Type Description Required
id string Task ID Yes
name string Task name Yes
suiteId string Belonging Test Suite ID Yes
map string Map ID No
mapName string Map name No
vehicle string Ego Vehicle ID No
controller string Controller ID No
algorithmName string Algorithm name No
algorithmVersion string Algorithm version No
presetId number Current preset ID No
startTime number Task start time Yes
endTime number Task end time No
TaskResponse

Task Response

Parameter Name Type Description Required
total number Total count Yes
tasks [ Task ] Task list Yes

Preset

Evaluation Preset

Parameter Name Type Description Required Notes
id number Preset ID Yes
name string Preset name Yes
data [ object ] Preset data Yes
builtIn boolean Whether built-in No
algorithmId string Operator ID No 3.7.0
algorithm Algorithm Algorithm data No 3.7.0
PresetResponse

Evaluation Preset Response

Parameter Name Type Description Required
code number Status code Yes
data Preset Preset data Yes
PresetsResponse

Evaluation Preset Collection Response

Parameter Name Type Description Required
code number Status code Yes
data { presets: [ Preset ] , total: number } Preset data Yes
PresetImportResponse

Evaluation Preset Import Response

Parameter Name Type Description Required
code number Status code Yes
data { reason: string } Failure reason Yes

Evaluation

Evaluation Report

Parameter Name Type Description Required
name string Report name Yes
type string Report enum type: "task" | "suite" Yes
status string Report status Yes
suiteId string Test Suite ID Yes
taskId string Task ID No
presetId number Preset ID Yes
presetName string Preset name No
presetVersionId number Preset version ID Yes
score number Evaluation score No
data object Report data Yes

Algorithm

Evaluation Operator

Parameter Name Type Description Required
id string Operator ID Yes
name string Operator name Yes
description string Operator description No
version string Operator version Yes
type string Operator type No
params [ object ] Operator data Yes
presets [ Preset ] Associated Evaluation presets No
AlgorithmResponse

Evaluation Operator Response

Parameter Name Type Description Required
code number Status code Yes
data Algorithm Operator data Yes
AlgorithmsResponse

Evaluation Operator Collection Response

Parameter Name Type Description Required
data { algorithms: [ Algorithm ] , total: number } Operator data Yes