Record an event in the life of a unit
Editor and above, or an API key with the condition scope (source api, ADR-017). occurred_on lies
between the manufacturing date and today. evidence_ids name
documents of the evidence library (a diagnostic report, a repair protocol). Events are records: they
do not change the unit's data; condition values are reported with updateCondition, second life with
createSecondLifeBattery.
apiKeyAuthorizationBearer <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*stringuuidapplication/json- body
description?stringlength <= 2000evidence_ids?array<>items <= 20occurred_on*stringdatetype*ReportedEventTypeThe event types members and service partners report.
"placed_on_market""put_into_service""inspection""repair""component_replaced""condition_update""waste""recycled""custom"The event.
application/json- response
api_key?An organisation API key (ADR-017) that reported an event (source api) or staged an import (ADR-026).
battery_id*stringuuidcreated_at*stringdate-timedescription?stringevidence*array<>field_keys*array<>The condition fields this event updated.
id*stringuuidoccurred_on*stringdatepartner?related_battery_id?stringSecond life: the successor (on the predecessor's event) or the predecessor (on the successor's).
uuidrelated_serial_number?stringreported_by?source*EventSourcemanual (a member), supplier (a service-partner link), api (an API key, M7), system.
"manual""supplier""api""system"type*LifecycleEventTypeWhat happened to a unit. condition_update is recorded by condition updates, repurposed, reused
and remanufactured by createSecondLifeBattery; the others are reported.
"placed_on_market""put_into_service""inspection""repair""component_replaced""condition_update""repurposed""reused""remanufactured""waste""recycled""custom"curl -X POST 'https://example.com/api/v1/batteries/497f6eca-6276-4993-bfeb-53cbbbba6f08/lifecycle-events' \ -H 'Content-Type: application/json' \ -d '{ "occurred_on": "2019-08-24", "type": "placed_on_market"}'{ "api_key": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "battery_id": "bf9efcd2-a647-473f-b459-71d521ebe1ad", "created_at": "2019-08-24T14:15:22Z", "description": "string", "evidence": [ { "access_tier": "public", "filename": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "declaration_of_conformity", "revision": 1, "superseded": true, "title": "string" } ], "field_keys": [ "string" ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "occurred_on": "2019-08-24", "partner": { "email": "user@example.com", "name": "string", "request_id": "266ea41d-adf5-480b-af50-15b940c2b846" }, "related_battery_id": "1ce5ea42-7c27-4051-b607-ecc81b42bedf", "related_serial_number": "string", "reported_by": { "display_name": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "source": "manual", "type": "placed_on_market"}The published versions of a unit's passport, newest first GET
Any member. With `at`, only versions published at or before that instant: the first item is the version that was valid then (history by date for the portal, with every tier).
The condition data of a unit (the registry's dynamic fields) GET
Any member. The dynamic fields visible for the unit and their current values with `measured_at`.