Catalog
The units as a spreadsheet with the import's columns
GET
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.
apiKeyheader
AuthorizationBearer <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.
battery_model_id?stringFormat
uuidmodel_version_id?stringFormat
uuidpassport_status?stringStatus of a unit's passport (docs/domain-model.md §7).
Value in
"draft""qr_locked""published""update_needed""suspended""withdrawn""deleted_recycled"serial_prefix?stringLength
1 <= length <= 50import_id?stringFormat
uuidformat?stringThe file format of a spreadsheet download.
Value in
"xlsx""csv"The spreadsheet.
response?unknownExample Request
curl -X GET 'https://example.com/api/v1/batteries/export'Example Response
null