Download OpenAPI specification:
| tenantId required | string <uuid> The ID of the tenant owning the requested Twin. |
| passportIdentifier required | string <uuid> Example: 550e8400-e29b-41d4-a716-446655440000 The Battery Passport ID |
{- "remainingCapacity": {
- "time": "string",
- "value": 0
}, - "remainingEnergy": {
- "time": "string",
- "value": 0
}, - "soce": {
- "value": 0,
- "time": "string"
}, - "stateOfCharge": {
- "value": 0,
- "time": "string"
}, - "remainingPowerCapability": 0,
- "fullCycles": {
- "time": "string",
- "value": 0
}, - "temperatureCondition": {
- "timeSpentInExtremeTemperaturesAboveBoundary": 0,
- "timeSpentinExtremeTemperaturesBelowBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesAboveBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesBelowBoundary": 0
}, - "negativeEventsEV": {
- "noOfDeepDischargeEvents": -2147483648,
- "noOfOverchargeEvents": -2147483648,
- "informationOnAccidents": [
- {
- "content": "string",
- "contentType": "string",
- "header": "string"
}
]
}
}| tenantId required | string <uuid> The ID of the tenant owning the requested Twin. |
| passportIdentifier required | string <uuid> Example: 550e8400-e29b-41d4-a716-446655440000 The Battery Passport ID |
object The remaining capacity in the battery expressed in ampere hours. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:
| |
object The remaining energy in the battery expressed in kilowatt-hours. | |
required | object The state of certified energy (SOCE) refers to the current measured or on-board usable battery energy (UBE) performance expressed as a percentage. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(b) refers to Article 14) and refers to Annex VII Part A: state of certified energy (SOCE). |
required | object State of Charge (SOC) refers to the amount of energy remaining in a battery at a given point in time, expressed as a percentage of the total capacity. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. |
| remainingPowerCapability | integer Remaining (in-use) power capability: Definition of power capability as provided in Battery Regulation. Annex IV Part B, point 4 --> measurement at 80 % and 20 % SoC required. This requirement may not be implementable and should be reviewed together with SoC definition. |
required | object Full cycles include the cumulative and equivalent count of complete charge and discharge cycles experienced by the battery over its entire life. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. And in AnnexVII Part B: 5. the number of full equivalent charge-discharge cycles. |
required | object Property for battery temperature |
required | object Information on accidents. |
{- "remainingCapacity": {
- "time": "string",
- "value": 0
}, - "remainingEnergy": {
- "time": "string",
- "value": 0
}, - "soce": {
- "value": 0,
- "time": "string"
}, - "stateOfCharge": {
- "value": 0,
- "time": "string"
}, - "remainingPowerCapability": 0,
- "fullCycles": {
- "time": "string",
- "value": 0
}, - "temperatureCondition": {
- "timeSpentInExtremeTemperaturesAboveBoundary": 0,
- "timeSpentinExtremeTemperaturesBelowBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesAboveBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesBelowBoundary": 0
}, - "negativeEventsEV": {
- "noOfDeepDischargeEvents": -2147483648,
- "noOfOverchargeEvents": -2147483648,
- "informationOnAccidents": [
- {
- "content": "string",
- "contentType": "string",
- "header": "string"
}
]
}
}{- "remainingCapacity": {
- "time": "string",
- "value": 0
}, - "remainingEnergy": {
- "time": "string",
- "value": 0
}, - "soce": {
- "value": 0,
- "time": "string"
}, - "stateOfCharge": {
- "value": 0,
- "time": "string"
}, - "remainingPowerCapability": 0,
- "fullCycles": {
- "time": "string",
- "value": 0
}, - "temperatureCondition": {
- "timeSpentInExtremeTemperaturesAboveBoundary": 0,
- "timeSpentinExtremeTemperaturesBelowBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesAboveBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesBelowBoundary": 0
}, - "negativeEventsEV": {
- "noOfDeepDischargeEvents": -2147483648,
- "noOfOverchargeEvents": -2147483648,
- "informationOnAccidents": [
- {
- "content": "string",
- "contentType": "string",
- "header": "string"
}
]
}
}