Katalog
A unit
GET
Any member.
apiKeyheader
AutorisierungBearer <Token>Organisation API key sent as Authorization: Bearer bp_live_… (ADR-017). Accepted only by the
operations that list this scheme, with the scope in their x-api-key-scope.
batteryId*stringFormat
uuidThe unit.
application/json- response
battery_model_id*stringFormat
uuidbattery_status*BatteryStatusWert in
"original""repurposed""reused""remanufactured""waste"created_at*stringFormat
date-timefacility_id?stringFormat
uuidid*stringFormat
uuididentifiers_locked_at?stringSet when the identifiers were locked (pre-print) or first published; serial and model are fixed afterwards.
Format
date-timeimport_id?stringThe import that created the unit.
Format
uuidmanufacturing_date?stringFormat
datemodel_version_id*stringFormat
uuidpassport_status*PassportStatusStatus of a unit's passport (docs/domain-model.md §7).
Wert in
"draft""qr_locked""published""update_needed""suspended""withdrawn""deleted_recycled"predecessor_battery_id?stringSecond life: the unit this battery was repurposed, reused or remanufactured from.
Format
uuidputting_into_service?stringFormat
daterow_version*RowVersionOptimistic-concurrency version; send it back as If-Match when updating.
Format
int64Bereich
1 <= valueserial_number*stringsuccessor_battery_ids?array<>Second life: the units made from this battery.
updated_at*stringFormat
date-timeBeispielanfrage
curl -X GET 'https://example.com/api/v1/batteries/497f6eca-6276-4993-bfeb-53cbbbba6f08'Beispielantwort
{ "battery_model_id": "6a002912-62a3-4058-99d0-53cbf87e9e1c", "battery_status": "original", "created_at": "2019-08-24T14:15:22Z", "facility_id": "82d24387-b696-4928-8926-f6f7f16d3353", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers_locked_at": "2019-08-24T14:15:22Z", "import_id": "13230382-dadc-41f2-963d-e123bd5c0585", "manufacturing_date": "2019-08-24", "model_version_id": "337b5de9-de8e-4f60-90b9-4857763aa5cd", "passport_status": "draft", "predecessor_battery_id": "2d846581-4798-4b11-872b-c08d9dbbd2f8", "putting_into_service": "2019-08-24", "row_version": 1, "serial_number": "string", "successor_battery_ids": [ "5baa088d-7bb3-4e66-8627-37644733d9aa" ], "updated_at": "2019-08-24T14:15:22Z"}