API docs by Redocly

Battery Passport Module Server (v1)

Download OpenAPI specification:Download

battery-passports-frontend-resource

getFrontendResource

Authorizations:
None
path Parameters
tenantId
required
string <uuid>
Example: 33a5eb75-c9d0-402f-824a-17ae4e7cebf8

The Owning Tenant UUID

batteryIdentifier
required
string

The Battery Identifier

Responses

battery-type-resource

getBatteryTypes

Authorizations:
None
path Parameters
tenantId
required
string <uuid>
Example: 33a5eb75-c9d0-402f-824a-17ae4e7cebf8

The Tenant UUID

Request Body schema: application/json
required
select
string [ 1 .. 4096 ] characters
filter
string [ 1 .. 4096 ] characters
options
string [ 1 .. 4096 ] characters
cursor
string [ 1 .. 4096 ] characters
Default: "0"
limit
integer <int32> [ 0 .. 500 ]
Default: 500

Responses

Request samples

Content type
application/json
{
  • "select": "string",
  • "filter": "string",
  • "options": "string",
  • "cursor": "0",
  • "limit": 500
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextCursor": "string",
  • "itemCount": 0
}

mergeApprovalStatus

Authorizations:
None
path Parameters
tenantId
required
string <uuid>
Example: 33a5eb75-c9d0-402f-824a-17ae4e7cebf8

The Tenant UUID

id
required
integer <int64>
Example: 0

Battery type id

Request Body schema: application/json
required
approvalStatus
required
string (ApprovalStatusEnumeration)
Enum: "Approved" "Draft"

Approval status of the battery type

Responses

Request samples

Content type
application/json
{
  • "approvalStatus": "Approved"
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextCursor": "string",
  • "itemCount": 0
}

battery-instance-resource

getBatteryInstances

Authorizations:
None
path Parameters
tenantId
required
string <uuid>
Example: 33a5eb75-c9d0-402f-824a-17ae4e7cebf8

The Tenant UUID

Request Body schema: application/json
required
select
string [ 1 .. 4096 ] characters
filter
string [ 1 .. 4096 ] characters
options
string [ 1 .. 4096 ] characters
cursor
string [ 1 .. 4096 ] characters
Default: "0"
limit
integer <int32> [ 0 .. 500 ]
Default: 500

Responses

Request samples

Content type
application/json
{
  • "select": "string",
  • "filter": "string",
  • "options": "string",
  • "cursor": "0",
  • "limit": 500
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextCursor": "string",
  • "itemCount": 0
}

asset-administration-shell-registry-resource

getShellByBatteryId

Authorizations:
None
path Parameters
tenantId
required
string <uuid>
Example: 33a5eb75-c9d0-402f-824a-17ae4e7cebf8

The Owning Tenant UUID

batteryIdentifier
required
string

The battery id of the shell of digital product passport identifying the asset administration shell

Responses

Response samples

Content type
application/json
"{ \"id\": \"https://example.org/aas/motor\" }"

battery-passport-document-resource

getBatteryPassportDocument

Authorizations:
None
path Parameters
tenantId
required
string <uuid>
Example: 33a5eb75-c9d0-402f-824a-17ae4e7cebf8

The Tenant UUID

passportIdentifier
required
string <uuid>
Example: 33a5eb75-c9d0-402f-824a-17ae4e7cebf8

The Battery Passport UUID

assertType
required
string (AssertTypeDto) [ 1 .. 20 ] characters
Enum: "EV" "INDUSTRIAL" "SLI" "LMT"
Example: SLI

Assert type for the battery type

Responses

Response samples

Content type
application/pdf
"JVBERi0xLjQKJcfs... (base64 encoded PDF content)"

battery-passport-document-public-resource

getPublicBatteryPassportDocument

Authorizations:
None
path Parameters
tenantId
required
string <uuid>
Example: 33a5eb75-c9d0-402f-824a-17ae4e7cebf8

The Tenant UUID

passportIdentifier
required
string <uuid>
Example: 33a5eb75-c9d0-402f-824a-17ae4e7cebf8

The Battery Passport UUID

assertType
required
string (AssertTypeDto) [ 1 .. 20 ] characters
Enum: "EV" "INDUSTRIAL" "SLI" "LMT"
Example: SLI

Assert type for the battery type

Responses

Response samples

Content type
application/pdf
"JVBERi0xLjQKJcfs... (base64 encoded PDF content)"