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 |
{- "initialRoundTripEfficiency": 0,
- "roundTripEfficiency50Percent": 0,
- "performanceTemperature": {
- "lower": 0,
- "upper": 0
}, - "warranty": {
- "lifeValue": 0,
- "lifeUnit": "unit:day"
}, - "initialResistanceByModule": 0,
- "initialResistanceByPack": 0,
- "initialResistanceByCell": 0,
- "ratedCapacity": {
- "value": 0,
- "thresholdExhaustion": 0,
- "temperature": 0
}, - "voltage": {
- "min": 0,
- "max": 0,
- "nominal": 0,
- "temperature": 0
}, - "batteryPower": {
- "originalPowerCapability": 0,
- "ratioBetweenNominalAllowedBatteryPowerAndBatteryEnergy": 0
}, - "lifetime": {
- "expectedYears": 0,
- "report": [
- {
- "content": "string",
- "contentType": "string",
- "header": "string"
}
], - "cycleLifeTesting": {
- "temperature": 0,
- "cycles": 0,
- "depthOfDischarge": 0,
- "appliedChargeRate": 0,
- "appliedDischargeRate": 0
}
}
}| 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
}, - "capacityFade": {
- "value": 0,
- "time": "string"
}, - "fullCycles": {
- "time": "string",
- "value": 0
}, - "temperatureCondition": {
- "timeSpentInExtremeTemperaturesAboveBoundary": 0,
- "timeSpentinExtremeTemperaturesBelowBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesAboveBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesBelowBoundary": 0
}, - "stateOfCharge": {
- "value": 0,
- "time": "string"
}, - "resistanceByPack": {
- "currentResistanceByPack": 0,
- "resistanceIncreaseByPack": 0
}, - "resistanceByCell": {
- "currentResistanceByCell": 0,
- "resistanceIncreaseByCell": 0
}, - "resistanceByModule": {
- "currentResistanceByModule": 0,
- "resistanceIncreaseByModule": 0
}, - "evolutionOfSelfDischargingRate": 0,
- "remainingRoundTripEfficiency": {
- "value": 0,
- "time": "string"
}, - "powerCapabilityFade": 0,
- "remainingPowerCapability": 0,
- "roundTripEfficiencyFade": {
- "value": 0,
- "time": "string"
}, - "negativeEventsLMT": {
- "informationOnAccidents": [
- {
- "content": "string",
- "contentType": "string",
- "header": "string"
}
], - "noOfDeepDischargeEvents": -2147483648,
- "noOfOverchargeEvents": -2147483648
}, - "intoServiceDate": "string",
- "initialSelfDischargingRate": 0,
- "currentSelfDischargingRate": 0,
- "energyThroughput": {
- "time": "string",
- "value": 0
}, - "capacityThroughput": {
- "time": "string",
- "value": 0
}
}| 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 |
required | 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:
|
required | object Capacity fade refers to a reduction in the capacity of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part A:
|
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 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. |
required | object internal resistance information of pack |
object “Internal battery cell and pack resistance”/“Internal resistance (in ?) by Cell.” “Internal resistance” means the opposition to the flow of current within a cell or a battery, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties. | |
object internal resistance information of module | |
| evolutionOfSelfDischargingRate required | integer The increase of self-discharging rates in the use-phase as percentage with reference to the initial self-discharging rate. |
required | object The remaining round trip efficiency in the battery expressed as percentage. 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: 3. where possible, the remaining round trip efficiency. Definition from Annex IV: (6) "Energy round trip efficiency" means the ratio of the net energy delivered by a battery during a discharge test to the total energy required to restore the initial state of charge by a standard charge. |
| powerCapabilityFade required | integer In-use power fade, as defined 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. |
| remainingPowerCapability required | 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 Round trip efficiency fade refers to a reduction in the round trip efficiency of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV: 4. Where applicable, energy round trip efficiency and its fade (in %). Definition from Annex IV: (6) "Energy round trip efficiency" means the ratio of the net energy delivered by a battery during a discharge test to the total energy required to restore the initial state of charge by a standard charge. |
required | object Information on accidents. |
| intoServiceDate required | string^\d{4}-\d{2}-\d{2}$ Putting into service is the transition from a state of readiness to actual use or operation. The date should be formatted as yyyy-mm-dd. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: 1.the date of manufacture of the battery and, where appropriate, the date of putting into service; Defined is "putting into service" in Article 3: (18) "putting into service" means the first use, for its intended purpose, in the Union, of a battery, without having been previously placed on the market. |
| initialSelfDischargingRate required | integer Initial self-discharge in % of capacity per unit of time in defined conditions (temperature range etc) as pre-use metric. |
| currentSelfDischargingRate required | integer Current self-discharge in % of capacity per unit of time in defined conditions (temperature range) during the use phase. |
required | object Energy throughput refers to the total amount of energy that passes through a system over a specific period. This measure encompasses both the energy input (during charging) and the energy output (during discharging). Energy throughput is expressed in kilowatt-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: 2. the energy throughput. |
required | object Capacity throughput refers to the total amount of energy that a battery has delivered over its lifetime. It represents the cumulative energy discharge and recharge cycles a battery has undergone. Capacity throughput is expressed in ampere-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: 3. the capacity throughput. |
{- "remainingCapacity": {
- "time": "string",
- "value": 0
}, - "capacityFade": {
- "value": 0,
- "time": "string"
}, - "fullCycles": {
- "time": "string",
- "value": 0
}, - "temperatureCondition": {
- "timeSpentInExtremeTemperaturesAboveBoundary": 0,
- "timeSpentinExtremeTemperaturesBelowBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesAboveBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesBelowBoundary": 0
}, - "stateOfCharge": {
- "value": 0,
- "time": "string"
}, - "resistanceByPack": {
- "currentResistanceByPack": 0,
- "resistanceIncreaseByPack": 0
}, - "resistanceByCell": {
- "currentResistanceByCell": 0,
- "resistanceIncreaseByCell": 0
}, - "resistanceByModule": {
- "currentResistanceByModule": 0,
- "resistanceIncreaseByModule": 0
}, - "evolutionOfSelfDischargingRate": 0,
- "remainingRoundTripEfficiency": {
- "value": 0,
- "time": "string"
}, - "powerCapabilityFade": 0,
- "remainingPowerCapability": 0,
- "roundTripEfficiencyFade": {
- "value": 0,
- "time": "string"
}, - "negativeEventsLMT": {
- "informationOnAccidents": [
- {
- "content": "string",
- "contentType": "string",
- "header": "string"
}
], - "noOfDeepDischargeEvents": -2147483648,
- "noOfOverchargeEvents": -2147483648
}, - "intoServiceDate": "string",
- "initialSelfDischargingRate": 0,
- "currentSelfDischargingRate": 0,
- "energyThroughput": {
- "time": "string",
- "value": 0
}, - "capacityThroughput": {
- "time": "string",
- "value": 0
}
}{- "remainingCapacity": {
- "time": "string",
- "value": 0
}, - "capacityFade": {
- "value": 0,
- "time": "string"
}, - "fullCycles": {
- "time": "string",
- "value": 0
}, - "temperatureCondition": {
- "timeSpentInExtremeTemperaturesAboveBoundary": 0,
- "timeSpentinExtremeTemperaturesBelowBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesAboveBoundary": 0,
- "timeSpentChargingDuringExtremeTemperaturesBelowBoundary": 0
}, - "stateOfCharge": {
- "value": 0,
- "time": "string"
}, - "resistanceByPack": {
- "currentResistanceByPack": 0,
- "resistanceIncreaseByPack": 0
}, - "resistanceByCell": {
- "currentResistanceByCell": 0,
- "resistanceIncreaseByCell": 0
}, - "resistanceByModule": {
- "currentResistanceByModule": 0,
- "resistanceIncreaseByModule": 0
}, - "evolutionOfSelfDischargingRate": 0,
- "remainingRoundTripEfficiency": {
- "value": 0,
- "time": "string"
}, - "powerCapabilityFade": 0,
- "remainingPowerCapability": 0,
- "roundTripEfficiencyFade": {
- "value": 0,
- "time": "string"
}, - "negativeEventsLMT": {
- "informationOnAccidents": [
- {
- "content": "string",
- "contentType": "string",
- "header": "string"
}
], - "noOfDeepDischargeEvents": -2147483648,
- "noOfOverchargeEvents": -2147483648
}, - "intoServiceDate": "string",
- "initialSelfDischargingRate": 0,
- "currentSelfDischargingRate": 0,
- "energyThroughput": {
- "time": "string",
- "value": 0
}, - "capacityThroughput": {
- "time": "string",
- "value": 0
}
}