Skip to content
BatteryPass Docs
Portal
Get startedGuidesRecipesIntegrationsAPI referenceChangelog
Catalog

Versions of a battery model, newest effective date first

Scope: readSee also:Authentication ·Errors ·Pagination ·Rate limits
GET
/battery-models/{modelId}/versions

Any member. At most 200.

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

modelId*string
Formatuuid

Response Body

The versions.

application/json
  1. response
items*array<>
Itemsitems <= 200
Example Request
curl -X GET 'https://example.com/api/v1/battery-models/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions'
Example Response
{  "items": [    {      "approved_at": "2019-08-24T14:15:22Z",      "approved_by_name": "string",      "battery_model_id": "6a002912-62a3-4058-99d0-53cbf87e9e1c",      "created_at": "2019-08-24T14:15:22Z",      "effective_from": "2019-08-24",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "registry_version": "string",      "row_version": 1,      "status": "draft",      "unit_count": 0,      "updated_at": "2019-08-24T14:15:22Z",      "version_label": "string"    }  ]}

List the battery models of the active organisation GET

Any member. Ordered by name, then id. Archived models only with `include_archived=true`.

Registry evaluation of the unit-level fields GET

Any member. Evaluated against the category, the unit's putting-into-service date (else its manufacturing date, else the version's effective date) and the organisation's facts; includes the summary of its model version.