UDS API / Reference
JSON Schema directory
Core schemas are served from the API contract definitions using JSON Schema 2020-12. They describe accepted request fields, not permission grants. Cross-record ownership, source relationships, exact-byte semantics and other database-dependent validation still apply.
Read the evidence semantics alongside the request schemas.
Message evidence
Message request schema covers complete, partial and unavailable observations. Exactly-one encoding, nonempty bytes, segment overlap and artifact verification have additional semantic validation. Batches accept an envelope durably before validating each item; see the import operations in OpenAPI.
Core resource inputs
Use returned IDs in path parameters. Nested create request schemas exclude the parent ID because the URL supplies it. PATCH accepts only the listed mutable fields and requires If-Match.
| Resource | Schema | Create route |
|---|---|---|
| organization | Create request | /catalog/organizations |
| vehicle node | Create request | /catalog/vehicle-nodes |
| vehicle relation | Create request | /catalog/vehicle-relations |
| vehicle variant | Create request | /catalog/vehicle-variants |
| vehicle | Create request / Patch request | /vehicles |
| ecu family | Create request | /catalog/ecu-families |
| ecu hardware | Create request | /catalog/ecu-hardware |
| ecu | Create request / Patch request | /ecus |
| installation | Create request | /installations |
| software component | Create request | /catalog/software-components |
| identifier | Create request | /identifiers |
| source | Create request / Patch request | /sources |
| source record | Create request | /source-records |
| extraction run | Create request | /extraction-runs |
| session | Create request / Patch request | /sessions |
| session source | Create request | /sessions/:sessionId/sources |
| vehicle observation | Create request / Patch request | /sessions/:sessionId/vehicle-observations |
| ecu observation | Create request / Patch request | /sessions/:sessionId/ecu-observations |
| ecu component | Create request | /ecu-observations/:ecuObservationId/components |
| connection | Create request | /sessions/:sessionId/connections |
| endpoint | Create request | /connections/:connectionId/endpoints |
| operation | Create request | /sessions/:sessionId/operations |
| event | Create request | /sessions/:sessionId/events |
| message link | Create request | /message-links |
| operation message link | Create request | /operation-message-links |
| decoding | Create request | /messages/:messageId/decodings |
| fact | Create request | /facts |
| definition | Create request / Patch request | /definitions |
| definition version | Create request | /definitions/:definitionId/versions |
| applicability | Create request | /definition-versions/:definitionVersionId/applicability |
| evidence link | Create request | /evidence-links |
| review | Create request | /reviews |
| revision | Create request | /revisions |
| redaction | Create request | /redactions |
Imports, artifacts and extensions
The generated OpenAPI components include import, batch and artifact-registration bodies. Authenticated GET /api/v1/uds/schemas returns registered extension schemas; GET /api/v1/uds/reference-codes returns registered code catalogs. Do not fetch arbitrary schema URLs supplied inside source evidence.
This directory indexes the initial 1.0.0 contract. Confirm the deployed contract and effective limits before ingestion. Public schema access does not permit reading or writing dataset records.