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
}, - "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 (CapacityCharacteristic) Characteristic for dynamic capacity values such as the throughput and the remaining capacity. |
required | object (RecordCharacteristic) Characteristic for a dynamic record with a value and timestamp. |
required | object (FullCycleCharacteristic) Characteristic for dynamic cycle values. |
required | object (TemperatureConditionCharacteristic) Temperature Condition details for battery |
required | object (RecordCharacteristic) Characteristic for a dynamic record with a value and timestamp. |
required | object (ResistanceByPackCharacteristic) internal resistance information of pack |
object (ResistanceByCell) Internal Resistance By Cell | |
object (ResistanceByModuleCharacteristic) internal resistance information of module | |
| evolutionOfSelfDischargingRate required | number (PercentMeasurement0) Measurement in percent as double. |
required | object (RecordCharacteristic) Characteristic for a dynamic record with a value and timestamp. |
| powerCapabilityFade required | number (PowerFadeCharacteristic) 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 | number (PowerCharacteristic) Power capability in kilowatts |
required | object (RecordCharacteristic) Characteristic for a dynamic record with a value and timestamp. |
required | object (NegativeEventsLMTCharacteristic) Negative Events Characteristic |
| intoServiceDate required | string (DateTrait) ^\d{4}-\d{2}-\d{2}$ Constraint fo a timestamp in the format (yyyy-mm-dd). |
| initialSelfDischargingRate required | number (PercentMeasurement0) Measurement in percent as double. |
| currentSelfDischargingRate required | number (PercentMeasurement0) Measurement in percent as double. |
required | object (EnergyCharacteristic) Characteristic for energy values expressed in a timestamp and a kilowatt-hours value. |
required | object (CapacityCharacteristic) Characteristic for dynamic capacity values such as the throughput and the remaining capacity. |
{- "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
}
}