Skip to content
BatteryPass Docs
Portal
Get startedGuidesRecipesIntegrationsAPI referenceChangelog
Lifecycle

The condition data of a unit (the registry's dynamic fields)

Scope: readSee also:Authentication ·Errors ·Pagination ·Rate limits
GET
/batteries/{batteryId}/condition

Any member. The dynamic fields visible for the unit and their current values with measured_at.

Authorization

apiKey
headerAuthorizationBearer <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.

Path Parameters

batteryId*string
Formatuuid

Response Body

The condition data.

application/json
  1. response
battery_id*string
Formatuuid
field_keys*array<>

The dynamic fields visible for the unit, in registry order.

republish*ConditionRepublish

When accepted condition data reaches a published passport (ADR-016): immediate or daily (02:00 UTC).

Value in"immediate""daily"
values*array<>

Current values of these fields.

Example Request
curl -X GET 'https://example.com/api/v1/batteries/497f6eca-6276-4993-bfeb-53cbbbba6f08/condition'
Example Response
{  "battery_id": "bf9efcd2-a647-473f-b459-71d521ebe1ad",  "field_keys": [    "string"  ],  "republish": "immediate",  "values": [    {      "checks": [        {          "check_key": "string",          "message": {            "de": "string",            "en": "string"          },          "result": "pass"        }      ],      "evidence": [        {          "access_tier": "public",          "filename": "string",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "kind": "declaration_of_conformity",          "revision": 1,          "superseded": true,          "title": "string"        }      ],      "field_key": "string",      "measured_at": "2019-08-24T14:15:22Z",      "recorded_at": "2019-08-24T14:15:22Z",      "recorded_by": {        "display_name": "string",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"      },      "registry_version": "string",      "responsible": {        "display_name": "string",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"      },      "review_note": "string",      "review_status": "captured",      "reviewed_at": "2019-08-24T14:15:22Z",      "reviewed_by": {        "display_name": "string",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"      },      "revision": 1,      "source": "manual",      "superseded_at": "2019-08-24T14:15:22Z",      "unit": "string",      "value": null    }  ]}

Record an event in the life of a unit POST

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`.

The lifecycle of a unit, newest first GET

Any member. Events recorded by members, service-partner reports, condition updates and second life.