Zum Inhalt springen
Katalog

The units as a spreadsheet with the import's columns

Scope: readSiehe auch:Authentifizierung ·Fehler ·Paginierung ·Ratenlimits
GET
/batteries/export

Any member. The units matching the filters (at most 10 000) with the columns of an import: model, version, the unit's fields and every unit-level field with a value, so the file can be edited and imported again (docs/architecture.md §7). XLSX by default.

Autorisierung

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

Query-Parameter

battery_model_id?string
Formatuuid
model_version_id?string
Formatuuid
passport_status?string

Status of a unit's passport (docs/domain-model.md §7).

Wert in"draft""qr_locked""published""update_needed""suspended""withdrawn""deleted_recycled"
serial_prefix?string
Länge1 <= length <= 50
import_id?string
Formatuuid
format?string

The file format of a spreadsheet download.

Wert in"xlsx""csv"

Antwort-Body

The spreadsheet.

response?unknown
Beispielanfrage
curl -X GET 'https://example.com/api/v1/batteries/export'
Beispielantwort
null