VDS - DSS (0.2.5+S030919A)

Download OpenAPI specification:

API reference for datasource-server (DSS).

Version format: a semantic version followed by a build manifest, e.g. 0.2.5+S030919A. The metadata after + encodes the build date and time to distinguish granular builds; it has no bearing on API or binary compatibility.

DataService

ListSignals

Request Body schema: application/json

end_time required	number <double>
source required	string Source (data group) to list signals for.
start_time required	number <double> Inclusive time window in fractional Unix epoch seconds.
vehicle_ids required	Array of integers[ items [ -2147483648 .. 2147483647 ] ] Restrict to these vehicles. Empty means every vehicle in the project.

Responses

Request samples

Payload

Content type

application/json

{"end_time": 0.1,
"source": "string",
"start_time": 0.1,
"vehicle_ids": [-2147483648
]
}

Response samples

200
default

Content type

application/json

{"signals": ["string"
]
}

ListSources

Request Body schema: application/json

end_time required	number <double>
start_time required	number <double> Inclusive time window in fractional Unix epoch seconds.
vehicle_ids required	Array of integers[ items [ -2147483648 .. 2147483647 ] ] Restrict to these vehicles. Empty means every vehicle in the project.

Responses

Request samples

Payload

Content type

application/json

{"end_time": 0.1,
"start_time": 0.1,
"vehicle_ids": [-2147483648
]
}

Response samples

200
default

Content type

application/json

{"sources": ["string"
]
}

ListVehicles

Request Body schema: application/json

object (datasource.ListVehiclesRequest)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
default

Content type

application/json

{"vehicles": [{"id": -2147483648,
"name": "string"
}
]
}

GetData

Request Body schema: application/json

end_time required	number <double>
plugin_id required	string
signal_id required	string
start_time required	number <double>
trip_id required	string

Responses

Request samples

Payload

Content type

application/json

{"end_time": 0.1,
"plugin_id": "string",
"signal_id": "string",
"start_time": 0.1,
"trip_id": "string"
}

Response samples

200
default

Content type

application/json

{"points": [{"t": 0.1,
"v": { }
}
]
}

GetDecimatedData

Request Body schema: application/json

end_time required	number <double>
plugin_id required	string
signal_id required	string
start_time required	number <double>
target_points required	integer [ 0 .. 4294967295 ]
trip_id required	string

Responses

Request samples

Payload

Content type

application/json

{"end_time": 0.1,
"plugin_id": "string",
"signal_id": "string",
"start_time": 0.1,
"target_points": 4294967295,
"trip_id": "string"
}

Response samples

200
default

Content type

application/json

{"points": [{"t": 0.1,
"v": { }
}
]
}

GetDecimatedDataBatch

Request Body schema: application/json

end_time required	number <double>
plugin_id required	string
required	Array of objects (datasource.DecimatedSignalRequest)
start_time required	number <double>
trip_id required	string

Responses

Request samples

Payload

Content type

application/json

{"end_time": 0.1,
"plugin_id": "string",
"signals": [{"signal_id": "string",
"target_points": 4294967295
}
],
"start_time": 0.1,
"trip_id": "string"
}

Response samples

200
default

Content type

application/json

{"series": [{"points": [{"t": 0.1,
"v": { }
}
],
"signal_id": "string"
}
]
}

GetEnumeration

Request Body schema: application/json

plugin_id required	string
signal_id required	string
trip_id required	string

Responses

Request samples

Payload

Content type

application/json

{"plugin_id": "string",
"signal_id": "string",
"trip_id": "string"
}

Response samples

200
default

Content type

application/json

{"has_enumeration": true,
"mappings": {"property1": "string",
"property2": "string"
}
}

ExportTrip

Request Body schema: application/json

	null or number
format required	string (datasource.ExportFormat) Enum: "UNSPECIFIED" "MF_4"
signal_ids required	Array of strings Fully-qualified `plugin::signal` ids to include. An empty list exports every signal; otherwise only the listed signals are written.
	null or number Optional inclusive time window in fractional Unix epoch seconds. Records outside the window are trimmed from the export. Provide both or neither; omitting them exports the whole trip.
trip_id required	string

Responses

Request samples

Payload

Content type

application/json

{"end_time": { },
"format": "UNSPECIFIED",
"signal_ids": ["string"
],
"start_time": { },
"trip_id": "string"
}

Response samples

200
default

Content type

application/json

{"artifact_url": "string"
}

LoadSignals

Request Body schema: application/json

plugin_id required	string
signal_ids required	Array of strings
trip_id required	string

Responses

Request samples

Payload

Content type

application/json

{"plugin_id": "string",
"signal_ids": ["string"
],
"trip_id": "string"
}

Response samples

200
default

Content type

application/json

{ }

GetSignals

Request Body schema: application/json

plugin_id required	string
trip_id required	string

Responses

Request samples

Payload

Content type

application/json

{"plugin_id": "string",
"trip_id": "string"
}

Response samples

200
default

Content type

application/json

{"signals": [{"chart_index": 4294967295,
"color": { },
"conversion_type": { },
"id": "string",
"name": "string",
"unit": { }
}
]
}

GetTimeRange

Request Body schema: application/json

plugin_id required	string
trip_id required	string

Responses

Request samples

Payload

Content type

application/json

{"plugin_id": "string",
"trip_id": "string"
}

Response samples

200
default

Content type

application/json

{"end": 0.1,
"start": 0.1
}