{
"openapi": "3.0.4",
"info": {
"title": "Prove API",
"description": "Welcome to the Circulor API!\r\n\r\nWe provide schema documentation for our client-facing API using Swagger. Swagger is a powerful tool for exploring and testing APIs, and we encourage you to use it to interact with our API.\r\n\r\nOur API uses OAuth2 to authenticate and authorize customers. To get started, please contact our support team at circulor.com/contact-us. Our team will be happy to provide you with the necessary credentials to authenticate with our API.\r\n\r\nTo use our API with Swagger, please follow these steps:\r\n\r\nClick on the \"Authorize\" button at the top right of the Swagger page.\r\nIn the dialog box that appears, enter your credentials provided by our support team.\r\nClick \"Authorize\" to authenticate with our API.\r\nYou should now see a green padlock icon next to the \"Authorize\" button, indicating that you are authenticated with our API.\r\nTo make a request to our API, select the endpoint you would like to use from the list on the left-hand side of the Swagger page.\r\nInput any required parameters for the endpoint.\r\nClick the \"Try it out\" button to send the request to our API.\r\nThe response from our API will be displayed below the \"Try it out\" button.\r\n\r\nWe hope you find our API easy to use and look forward to hearing your feedback. If you have any questions or encounter any issues, please don't hesitate to contact our support team.\r\n",
"version": "v3"
},
"paths": {
"/api/product/v3/products": {
"get": {
"tags": [
"Product"
],
"summary": "List products and their respective keys. Keys are related to the current authorized customer",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModelKeyAndName"
}
},
"example": [
{
"key": "battery_0001",
"name": "RWD Battery Pack"
},
{
"key": "battery_0002",
"name": "FWD Battery Pack"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModelKeyAndName"
}
},
"example": [
{
"key": "battery_0001",
"name": "RWD Battery Pack"
},
{
"key": "battery_0002",
"name": "FWD Battery Pack"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModelKeyAndName"
}
},
"example": [
{
"key": "battery_0001",
"name": "RWD Battery Pack"
},
{
"key": "battery_0002",
"name": "FWD Battery Pack"
}
]
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/products/create": {
"post": {
"tags": [
"Product"
],
"summary": "[WIP] Create a product based on set types of products. This will create a product with key and will set the correct\ntemplate and product properties",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProductRequest"
},
"example": {
"key": "batteryPack001",
"name": "HAC-AWD-2009",
"ofType": "BatteryPack"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateProductRequest"
},
"example": {
"key": "batteryPack001",
"name": "HAC-AWD-2009",
"ofType": "BatteryPack"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateProductRequest"
},
"example": {
"key": "batteryPack001",
"name": "HAC-AWD-2009",
"ofType": "BatteryPack"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductModel"
},
"example": {
"key": "batteryPack001",
"properties": {
"batteryIdentifier": {
"type": "string",
"value": "?",
"name": "Battery identifier"
},
"operatorIdentifierAndInformation": {
"type": "string",
"value": "?",
"name": "Operator identifier and information"
},
"manufacturerIdentifierAndInformation": {
"type": "string",
"value": "?",
"name": "Manufacturer identifier and information"
},
"manufacturingPlace": {
"type": "string",
"value": "?",
"name": "Manufacturing place"
},
"manufacturingDate": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Manufacturing date"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Date of putting the battery into service"
},
"warrantyPeriodOfTheBattery": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Warranty period of the battery"
},
"batteryCategory": {
"type": "string",
"value": "?",
"name": "Battery category"
},
"batteryMass": {
"type": "uom",
"value": -1,
"uom": "kg",
"name": "Battery mass"
},
"batteryStatus": {
"type": "oneOf",
"value": "",
"oneOf": [
"Original",
"Re-Used",
"Re-Manufacture",
"Waste"
],
"name": "Battery status"
},
"separateCollectionSymbol": {
"type": "link",
"url": "?",
"name": "Separate collection symbol"
},
"symbolsForCadmiumAndLead": {
"type": "link",
"url": "?",
"name": "Symbols for cadmium and lead"
},
"carbonFootprintLabel": {
"type": "link",
"url": "?",
"name": "Carbon footprint label"
},
"extinguishingAgent": {
"type": "string",
"value": "?",
"name": "Extinguishing agent"
},
"meaningOfLabelsAndSymbols": {
"type": "string",
"value": "?",
"name": "Meaning of labels and symbols"
},
"euDeclarationOfConformity": {
"type": "link",
"url": "?",
"name": "EU declaration of conformity"
},
"resultsOfTestReportsProvingCompliance": {
"type": "link",
"url": "?",
"name": "Results of test reports proving compliance"
},
"batteryCarbonFootprintPerFunctionalUnit": {
"type": "uom",
"value": -1,
"uom": "kgCO2e/kWh",
"name": "Battery carbon footprint per Functional Unit"
},
"contributionOfRawMaterialAcquisitionAndPreProcessingLifecycleStage": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of raw material acquisition and pre-processing lifecycle stage"
},
"shareBcfMainProductProduction": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of main product production/manufacturing lifecycle stage"
},
"contributionOfDistributionLifecycleStage": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of distribution lifecycle stage"
},
"contributionOfEndOfLifeAndRecyclingLifecycleStage": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of end of life and recycling lifecycle stage"
},
"carbonFootprintPerformanceClass": {
"type": "string",
"value": "?",
"name": "Carbon footprint performance class"
},
"webLinkToPublicCarbonFootprintStudy": {
"type": "link",
"url": "?",
"name": "Web link to public carbon footprint study"
},
"generalBatteryAndManufacturerInformation": {
"type": "link",
"url": "?",
"name": "General battery and manufacturer information"
},
"absoluteBatteryCarbonFootprint": {
"type": "uom",
"value": -1,
"uom": "tCO2e",
"name": "Absolute battery carbon footprint"
},
"informationOfDueDiligenceReport": {
"type": "link",
"url": "?",
"name": "Information of due diligence report"
},
"thirdPartyAssurancesOfRecognisedSchemes": {
"type": "string",
"value": "?",
"name": "Third party assurances of recognised schemes"
},
"supplyChainIndices": {
"type": "string",
"value": "?",
"name": "Supply chain indices"
},
"batteryChemistry": {
"type": "string",
"value": "?",
"name": "Battery chemistry"
},
"criticalRawMaterials": {
"type": "string",
"value": "?",
"name": "Critical raw materials"
},
"nameOfTheCathodeAnodeElectrolyteMaterials": {
"type": "string",
"value": "?",
"name": "Materials used in cathode, anode and electrolyte"
},
"hazardousSubstances": {
"type": "string",
"value": "?",
"name": "Hazardous substances"
},
"impactSubstancesEnvironmentHumanHealthSafety": {
"type": "string",
"value": "?",
"name": "Impact of substances on environment, human health, safety, persons"
},
"manualForDisassemblyAndDismantlingOfTheBatteryPack": {
"type": "link",
"url": "?",
"name": "Dismantling information: Manuals for the removal and the disassembly of the battery pack"
},
"partNumbersForComponents": {
"type": "link",
"url": "?",
"name": "Part numbers for components"
},
"informationOnSourcesOfSpareParts": {
"type": "link",
"url": "?",
"name": "Information on sources of spare parts"
},
"safetyMeasures": {
"type": "link",
"url": "?",
"name": "Safety measures"
},
"preConsumerRecycledNickelShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled nickel share"
},
"preConsumerRecycledCobaltShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled cobalt share"
},
"preConsumerRecycledLithiumShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled lithium share"
},
"preConsumerRecycledLeadShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled lead share"
},
"postConsumerRecycledNickelShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled nickel share"
},
"postConsumerRecycledCobaltShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled cobalt share"
},
"postConsumerRecycledLithiumShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled lithium share"
},
"postConsumerRecycledLeadShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled lead share"
},
"renewableContentShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Renewable content share"
},
"informationOnTheRoleOfEndUsersInContributingToWastePrevention": {
"type": "link",
"url": "?",
"name": "Information on the role of end-users in contributing to waste prevention"
},
"informationOnTheRoleOfEndUsersInContributingToTheSeparateCollectionOfWasteBatteries": {
"type": "link",
"url": "?",
"name": "Information on the role of end-users in contributing to the separate collection of waste batteries"
},
"informationOnBatteryCollection": {
"type": "link",
"url": "?",
"name": "Information on battery collection, preparation for second life and on treatment at end of life"
},
"ratedCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Rated capacity"
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Remaining capacity"
},
"capacityFade": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Capacity fade "
},
"certifiedUsableBatteryEnergy": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Certified usable battery energy"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Remaining usable battery energy"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of certified energy (SOCE)"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of Charge (SoC)"
},
"minimumVoltage": {
"type": "uom",
"value": -1,
"uom": "V",
"name": "Minimum voltage "
},
"maximumVoltage": {
"type": "uom",
"value": -1,
"uom": "V",
"name": "Maximum voltage"
},
"nominalVoltage": {
"type": "uom",
"value": -1,
"uom": "V",
"name": "Nominal voltage"
},
"originalPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Original power capability"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Remaining power capability"
},
"powerFade": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Power fade"
},
"maximumPermittedBatteryPower": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Maximum permitted battery power"
},
"ratioBetweenNominalBatteryPowerAndBatteryEnergy": {
"type": "uom",
"value": -1,
"uom": "W/Wh",
"name": "Ratio between nominal battery power and battery energy"
},
"initialRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Initial round trip energy efficiency "
},
"energyRoundTripEfficiencyAt50OfCycleLife": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Round trip energy efficiency at 50% of cycle life"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Remaining round trip energy efficiency "
},
"energyRoundTripEfficiencyFade": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Energy round trip efficiency fade"
},
"initialSelfDischargeRate": {
"type": "uom",
"value": -1,
"uom": "%/month",
"name": "Initial self-discharge rate"
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month",
"name": "Current self-discharge rate"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Evolution of self-discharge rates"
},
"moduleRecommended": {
"type": "uom",
"value": -1,
"uom": "Ohm",
"name": "Initial internal resistance of battery cell and pack (module recommended)"
},
"cellAndModuleRecommended": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Internal resistance increase of pack (cell and module recommended)"
},
"expectedLifetimeInCalendarYears": {
"type": "uom",
"value": -1,
"uom": "years",
"name": "Expected lifetime in calendar years "
},
"expectedLifetimeNumberOfChargeDischargeCycles": {
"type": "numeric",
"value": -1,
"name": "Expected lifetime: Number of charge-discharge cycles"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1,
"name": "Number of full charging and discharging cycles"
},
"cycleLifeReferenceTest": {
"type": "string",
"value": "?",
"name": "Cycle-life reference test"
},
"cRateOfRelevantCycleLifeTest": {
"type": "uom",
"value": -1,
"uom": "A/Ah",
"name": "C-rate of relevant cycle-life test"
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Energy throughput "
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Capacity throughput "
},
"capacityThresholdForExhaustion": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Capacity threshold for exhaustion"
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature information"
},
"temperatureRangeIdleStateLowerBoundary": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature range idle state, lower boundary"
},
"temperatureRangeIdleStateUpperBoundary": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature range idle state, upper boundary"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures above boundary"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures below boundary"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures above boundary"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures below boundary"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of deep discharge events"
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of overcharge events"
},
"informationOnAccidents": {
"type": "string",
"value": "?",
"name": "Information on accidents"
}
},
"version": 0
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductModel"
},
"example": {
"key": "batteryPack001",
"properties": {
"batteryIdentifier": {
"type": "string",
"value": "?",
"name": "Battery identifier"
},
"operatorIdentifierAndInformation": {
"type": "string",
"value": "?",
"name": "Operator identifier and information"
},
"manufacturerIdentifierAndInformation": {
"type": "string",
"value": "?",
"name": "Manufacturer identifier and information"
},
"manufacturingPlace": {
"type": "string",
"value": "?",
"name": "Manufacturing place"
},
"manufacturingDate": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Manufacturing date"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Date of putting the battery into service"
},
"warrantyPeriodOfTheBattery": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Warranty period of the battery"
},
"batteryCategory": {
"type": "string",
"value": "?",
"name": "Battery category"
},
"batteryMass": {
"type": "uom",
"value": -1,
"uom": "kg",
"name": "Battery mass"
},
"batteryStatus": {
"type": "oneOf",
"value": "",
"oneOf": [
"Original",
"Re-Used",
"Re-Manufacture",
"Waste"
],
"name": "Battery status"
},
"separateCollectionSymbol": {
"type": "link",
"url": "?",
"name": "Separate collection symbol"
},
"symbolsForCadmiumAndLead": {
"type": "link",
"url": "?",
"name": "Symbols for cadmium and lead"
},
"carbonFootprintLabel": {
"type": "link",
"url": "?",
"name": "Carbon footprint label"
},
"extinguishingAgent": {
"type": "string",
"value": "?",
"name": "Extinguishing agent"
},
"meaningOfLabelsAndSymbols": {
"type": "string",
"value": "?",
"name": "Meaning of labels and symbols"
},
"euDeclarationOfConformity": {
"type": "link",
"url": "?",
"name": "EU declaration of conformity"
},
"resultsOfTestReportsProvingCompliance": {
"type": "link",
"url": "?",
"name": "Results of test reports proving compliance"
},
"batteryCarbonFootprintPerFunctionalUnit": {
"type": "uom",
"value": -1,
"uom": "kgCO2e/kWh",
"name": "Battery carbon footprint per Functional Unit"
},
"contributionOfRawMaterialAcquisitionAndPreProcessingLifecycleStage": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of raw material acquisition and pre-processing lifecycle stage"
},
"shareBcfMainProductProduction": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of main product production/manufacturing lifecycle stage"
},
"contributionOfDistributionLifecycleStage": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of distribution lifecycle stage"
},
"contributionOfEndOfLifeAndRecyclingLifecycleStage": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of end of life and recycling lifecycle stage"
},
"carbonFootprintPerformanceClass": {
"type": "string",
"value": "?",
"name": "Carbon footprint performance class"
},
"webLinkToPublicCarbonFootprintStudy": {
"type": "link",
"url": "?",
"name": "Web link to public carbon footprint study"
},
"generalBatteryAndManufacturerInformation": {
"type": "link",
"url": "?",
"name": "General battery and manufacturer information"
},
"absoluteBatteryCarbonFootprint": {
"type": "uom",
"value": -1,
"uom": "tCO2e",
"name": "Absolute battery carbon footprint"
},
"informationOfDueDiligenceReport": {
"type": "link",
"url": "?",
"name": "Information of due diligence report"
},
"thirdPartyAssurancesOfRecognisedSchemes": {
"type": "string",
"value": "?",
"name": "Third party assurances of recognised schemes"
},
"supplyChainIndices": {
"type": "string",
"value": "?",
"name": "Supply chain indices"
},
"batteryChemistry": {
"type": "string",
"value": "?",
"name": "Battery chemistry"
},
"criticalRawMaterials": {
"type": "string",
"value": "?",
"name": "Critical raw materials"
},
"nameOfTheCathodeAnodeElectrolyteMaterials": {
"type": "string",
"value": "?",
"name": "Materials used in cathode, anode and electrolyte"
},
"hazardousSubstances": {
"type": "string",
"value": "?",
"name": "Hazardous substances"
},
"impactSubstancesEnvironmentHumanHealthSafety": {
"type": "string",
"value": "?",
"name": "Impact of substances on environment, human health, safety, persons"
},
"manualForDisassemblyAndDismantlingOfTheBatteryPack": {
"type": "link",
"url": "?",
"name": "Dismantling information: Manuals for the removal and the disassembly of the battery pack"
},
"partNumbersForComponents": {
"type": "link",
"url": "?",
"name": "Part numbers for components"
},
"informationOnSourcesOfSpareParts": {
"type": "link",
"url": "?",
"name": "Information on sources of spare parts"
},
"safetyMeasures": {
"type": "link",
"url": "?",
"name": "Safety measures"
},
"preConsumerRecycledNickelShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled nickel share"
},
"preConsumerRecycledCobaltShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled cobalt share"
},
"preConsumerRecycledLithiumShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled lithium share"
},
"preConsumerRecycledLeadShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled lead share"
},
"postConsumerRecycledNickelShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled nickel share"
},
"postConsumerRecycledCobaltShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled cobalt share"
},
"postConsumerRecycledLithiumShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled lithium share"
},
"postConsumerRecycledLeadShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled lead share"
},
"renewableContentShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Renewable content share"
},
"informationOnTheRoleOfEndUsersInContributingToWastePrevention": {
"type": "link",
"url": "?",
"name": "Information on the role of end-users in contributing to waste prevention"
},
"informationOnTheRoleOfEndUsersInContributingToTheSeparateCollectionOfWasteBatteries": {
"type": "link",
"url": "?",
"name": "Information on the role of end-users in contributing to the separate collection of waste batteries"
},
"informationOnBatteryCollection": {
"type": "link",
"url": "?",
"name": "Information on battery collection, preparation for second life and on treatment at end of life"
},
"ratedCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Rated capacity"
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Remaining capacity"
},
"capacityFade": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Capacity fade "
},
"certifiedUsableBatteryEnergy": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Certified usable battery energy"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Remaining usable battery energy"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of certified energy (SOCE)"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of Charge (SoC)"
},
"minimumVoltage": {
"type": "uom",
"value": -1,
"uom": "V",
"name": "Minimum voltage "
},
"maximumVoltage": {
"type": "uom",
"value": -1,
"uom": "V",
"name": "Maximum voltage"
},
"nominalVoltage": {
"type": "uom",
"value": -1,
"uom": "V",
"name": "Nominal voltage"
},
"originalPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Original power capability"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Remaining power capability"
},
"powerFade": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Power fade"
},
"maximumPermittedBatteryPower": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Maximum permitted battery power"
},
"ratioBetweenNominalBatteryPowerAndBatteryEnergy": {
"type": "uom",
"value": -1,
"uom": "W/Wh",
"name": "Ratio between nominal battery power and battery energy"
},
"initialRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Initial round trip energy efficiency "
},
"energyRoundTripEfficiencyAt50OfCycleLife": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Round trip energy efficiency at 50% of cycle life"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Remaining round trip energy efficiency "
},
"energyRoundTripEfficiencyFade": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Energy round trip efficiency fade"
},
"initialSelfDischargeRate": {
"type": "uom",
"value": -1,
"uom": "%/month",
"name": "Initial self-discharge rate"
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month",
"name": "Current self-discharge rate"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Evolution of self-discharge rates"
},
"moduleRecommended": {
"type": "uom",
"value": -1,
"uom": "Ohm",
"name": "Initial internal resistance of battery cell and pack (module recommended)"
},
"cellAndModuleRecommended": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Internal resistance increase of pack (cell and module recommended)"
},
"expectedLifetimeInCalendarYears": {
"type": "uom",
"value": -1,
"uom": "years",
"name": "Expected lifetime in calendar years "
},
"expectedLifetimeNumberOfChargeDischargeCycles": {
"type": "numeric",
"value": -1,
"name": "Expected lifetime: Number of charge-discharge cycles"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1,
"name": "Number of full charging and discharging cycles"
},
"cycleLifeReferenceTest": {
"type": "string",
"value": "?",
"name": "Cycle-life reference test"
},
"cRateOfRelevantCycleLifeTest": {
"type": "uom",
"value": -1,
"uom": "A/Ah",
"name": "C-rate of relevant cycle-life test"
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Energy throughput "
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Capacity throughput "
},
"capacityThresholdForExhaustion": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Capacity threshold for exhaustion"
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature information"
},
"temperatureRangeIdleStateLowerBoundary": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature range idle state, lower boundary"
},
"temperatureRangeIdleStateUpperBoundary": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature range idle state, upper boundary"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures above boundary"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures below boundary"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures above boundary"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures below boundary"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of deep discharge events"
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of overcharge events"
},
"informationOnAccidents": {
"type": "string",
"value": "?",
"name": "Information on accidents"
}
},
"version": 0
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductModel"
},
"example": {
"key": "batteryPack001",
"properties": {
"batteryIdentifier": {
"type": "string",
"value": "?",
"name": "Battery identifier"
},
"operatorIdentifierAndInformation": {
"type": "string",
"value": "?",
"name": "Operator identifier and information"
},
"manufacturerIdentifierAndInformation": {
"type": "string",
"value": "?",
"name": "Manufacturer identifier and information"
},
"manufacturingPlace": {
"type": "string",
"value": "?",
"name": "Manufacturing place"
},
"manufacturingDate": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Manufacturing date"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Date of putting the battery into service"
},
"warrantyPeriodOfTheBattery": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Warranty period of the battery"
},
"batteryCategory": {
"type": "string",
"value": "?",
"name": "Battery category"
},
"batteryMass": {
"type": "uom",
"value": -1,
"uom": "kg",
"name": "Battery mass"
},
"batteryStatus": {
"type": "oneOf",
"value": "",
"oneOf": [
"Original",
"Re-Used",
"Re-Manufacture",
"Waste"
],
"name": "Battery status"
},
"separateCollectionSymbol": {
"type": "link",
"url": "?",
"name": "Separate collection symbol"
},
"symbolsForCadmiumAndLead": {
"type": "link",
"url": "?",
"name": "Symbols for cadmium and lead"
},
"carbonFootprintLabel": {
"type": "link",
"url": "?",
"name": "Carbon footprint label"
},
"extinguishingAgent": {
"type": "string",
"value": "?",
"name": "Extinguishing agent"
},
"meaningOfLabelsAndSymbols": {
"type": "string",
"value": "?",
"name": "Meaning of labels and symbols"
},
"euDeclarationOfConformity": {
"type": "link",
"url": "?",
"name": "EU declaration of conformity"
},
"resultsOfTestReportsProvingCompliance": {
"type": "link",
"url": "?",
"name": "Results of test reports proving compliance"
},
"batteryCarbonFootprintPerFunctionalUnit": {
"type": "uom",
"value": -1,
"uom": "kgCO2e/kWh",
"name": "Battery carbon footprint per Functional Unit"
},
"contributionOfRawMaterialAcquisitionAndPreProcessingLifecycleStage": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of raw material acquisition and pre-processing lifecycle stage"
},
"shareBcfMainProductProduction": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of main product production/manufacturing lifecycle stage"
},
"contributionOfDistributionLifecycleStage": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of distribution lifecycle stage"
},
"contributionOfEndOfLifeAndRecyclingLifecycleStage": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Contribution of end of life and recycling lifecycle stage"
},
"carbonFootprintPerformanceClass": {
"type": "string",
"value": "?",
"name": "Carbon footprint performance class"
},
"webLinkToPublicCarbonFootprintStudy": {
"type": "link",
"url": "?",
"name": "Web link to public carbon footprint study"
},
"generalBatteryAndManufacturerInformation": {
"type": "link",
"url": "?",
"name": "General battery and manufacturer information"
},
"absoluteBatteryCarbonFootprint": {
"type": "uom",
"value": -1,
"uom": "tCO2e",
"name": "Absolute battery carbon footprint"
},
"informationOfDueDiligenceReport": {
"type": "link",
"url": "?",
"name": "Information of due diligence report"
},
"thirdPartyAssurancesOfRecognisedSchemes": {
"type": "string",
"value": "?",
"name": "Third party assurances of recognised schemes"
},
"supplyChainIndices": {
"type": "string",
"value": "?",
"name": "Supply chain indices"
},
"batteryChemistry": {
"type": "string",
"value": "?",
"name": "Battery chemistry"
},
"criticalRawMaterials": {
"type": "string",
"value": "?",
"name": "Critical raw materials"
},
"nameOfTheCathodeAnodeElectrolyteMaterials": {
"type": "string",
"value": "?",
"name": "Materials used in cathode, anode and electrolyte"
},
"hazardousSubstances": {
"type": "string",
"value": "?",
"name": "Hazardous substances"
},
"impactSubstancesEnvironmentHumanHealthSafety": {
"type": "string",
"value": "?",
"name": "Impact of substances on environment, human health, safety, persons"
},
"manualForDisassemblyAndDismantlingOfTheBatteryPack": {
"type": "link",
"url": "?",
"name": "Dismantling information: Manuals for the removal and the disassembly of the battery pack"
},
"partNumbersForComponents": {
"type": "link",
"url": "?",
"name": "Part numbers for components"
},
"informationOnSourcesOfSpareParts": {
"type": "link",
"url": "?",
"name": "Information on sources of spare parts"
},
"safetyMeasures": {
"type": "link",
"url": "?",
"name": "Safety measures"
},
"preConsumerRecycledNickelShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled nickel share"
},
"preConsumerRecycledCobaltShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled cobalt share"
},
"preConsumerRecycledLithiumShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled lithium share"
},
"preConsumerRecycledLeadShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Pre-consumer recycled lead share"
},
"postConsumerRecycledNickelShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled nickel share"
},
"postConsumerRecycledCobaltShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled cobalt share"
},
"postConsumerRecycledLithiumShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled lithium share"
},
"postConsumerRecycledLeadShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Post-consumer recycled lead share"
},
"renewableContentShare": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Renewable content share"
},
"informationOnTheRoleOfEndUsersInContributingToWastePrevention": {
"type": "link",
"url": "?",
"name": "Information on the role of end-users in contributing to waste prevention"
},
"informationOnTheRoleOfEndUsersInContributingToTheSeparateCollectionOfWasteBatteries": {
"type": "link",
"url": "?",
"name": "Information on the role of end-users in contributing to the separate collection of waste batteries"
},
"informationOnBatteryCollection": {
"type": "link",
"url": "?",
"name": "Information on battery collection, preparation for second life and on treatment at end of life"
},
"ratedCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Rated capacity"
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Remaining capacity"
},
"capacityFade": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Capacity fade "
},
"certifiedUsableBatteryEnergy": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Certified usable battery energy"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Remaining usable battery energy"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of certified energy (SOCE)"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of Charge (SoC)"
},
"minimumVoltage": {
"type": "uom",
"value": -1,
"uom": "V",
"name": "Minimum voltage "
},
"maximumVoltage": {
"type": "uom",
"value": -1,
"uom": "V",
"name": "Maximum voltage"
},
"nominalVoltage": {
"type": "uom",
"value": -1,
"uom": "V",
"name": "Nominal voltage"
},
"originalPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Original power capability"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Remaining power capability"
},
"powerFade": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Power fade"
},
"maximumPermittedBatteryPower": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Maximum permitted battery power"
},
"ratioBetweenNominalBatteryPowerAndBatteryEnergy": {
"type": "uom",
"value": -1,
"uom": "W/Wh",
"name": "Ratio between nominal battery power and battery energy"
},
"initialRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Initial round trip energy efficiency "
},
"energyRoundTripEfficiencyAt50OfCycleLife": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Round trip energy efficiency at 50% of cycle life"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Remaining round trip energy efficiency "
},
"energyRoundTripEfficiencyFade": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Energy round trip efficiency fade"
},
"initialSelfDischargeRate": {
"type": "uom",
"value": -1,
"uom": "%/month",
"name": "Initial self-discharge rate"
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month",
"name": "Current self-discharge rate"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Evolution of self-discharge rates"
},
"moduleRecommended": {
"type": "uom",
"value": -1,
"uom": "Ohm",
"name": "Initial internal resistance of battery cell and pack (module recommended)"
},
"cellAndModuleRecommended": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Internal resistance increase of pack (cell and module recommended)"
},
"expectedLifetimeInCalendarYears": {
"type": "uom",
"value": -1,
"uom": "years",
"name": "Expected lifetime in calendar years "
},
"expectedLifetimeNumberOfChargeDischargeCycles": {
"type": "numeric",
"value": -1,
"name": "Expected lifetime: Number of charge-discharge cycles"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1,
"name": "Number of full charging and discharging cycles"
},
"cycleLifeReferenceTest": {
"type": "string",
"value": "?",
"name": "Cycle-life reference test"
},
"cRateOfRelevantCycleLifeTest": {
"type": "uom",
"value": -1,
"uom": "A/Ah",
"name": "C-rate of relevant cycle-life test"
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Energy throughput "
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Capacity throughput "
},
"capacityThresholdForExhaustion": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Capacity threshold for exhaustion"
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature information"
},
"temperatureRangeIdleStateLowerBoundary": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature range idle state, lower boundary"
},
"temperatureRangeIdleStateUpperBoundary": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature range idle state, upper boundary"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures above boundary"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures below boundary"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures above boundary"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures below boundary"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of deep discharge events"
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of overcharge events"
},
"informationOnAccidents": {
"type": "string",
"value": "?",
"name": "Information on accidents"
}
},
"version": 0
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/products/{productKey}/scaffolding": {
"get": {
"tags": [
"Product"
],
"summary": "Generates scaffolding for a given product. Scaffolded values are based on the product properties. This call includes\nall properties, including those that are not required.",
"parameters": [
{
"name": "productKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModel"
}
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "RWD Battery Pack",
"name": "Name"
},
"homePage": {
"type": "link",
"url": "https://batteryPacks.com",
"name": "Home Page Url"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-01-29T04:05:06Z",
"name": "Date of release"
},
"version": {
"type": "numeric",
"value": 10,
"name": "Version"
},
"nominalVoltage": {
"type": "uom",
"value": 10,
"uom": "V",
"name": "Nominal voltage"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"Li-ion",
"NiMH"
],
"oneOrMoreOf": [
"Li-ion",
"NiMH",
"Lead Acid",
"NiCd"
],
"name": "Battery Type"
},
"configuration": {
"type": "oneOf",
"value": "Series",
"oneOf": [
"Series",
"Parallel",
"Series-Parallel"
],
"name": "Configuration"
},
"location": {
"type": "location",
"countryCodes": [
"US"
],
"name": "Location"
}
},
"version": 1
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModel"
}
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "RWD Battery Pack",
"name": "Name"
},
"homePage": {
"type": "link",
"url": "https://batteryPacks.com",
"name": "Home Page Url"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-01-29T04:05:06Z",
"name": "Date of release"
},
"version": {
"type": "numeric",
"value": 10,
"name": "Version"
},
"nominalVoltage": {
"type": "uom",
"value": 10,
"uom": "V",
"name": "Nominal voltage"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"Li-ion",
"NiMH"
],
"oneOrMoreOf": [
"Li-ion",
"NiMH",
"Lead Acid",
"NiCd"
],
"name": "Battery Type"
},
"configuration": {
"type": "oneOf",
"value": "Series",
"oneOf": [
"Series",
"Parallel",
"Series-Parallel"
],
"name": "Configuration"
},
"location": {
"type": "location",
"countryCodes": [
"US"
],
"name": "Location"
}
},
"version": 1
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModel"
}
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "RWD Battery Pack",
"name": "Name"
},
"homePage": {
"type": "link",
"url": "https://batteryPacks.com",
"name": "Home Page Url"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-01-29T04:05:06Z",
"name": "Date of release"
},
"version": {
"type": "numeric",
"value": 10,
"name": "Version"
},
"nominalVoltage": {
"type": "uom",
"value": 10,
"uom": "V",
"name": "Nominal voltage"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"Li-ion",
"NiMH"
],
"oneOrMoreOf": [
"Li-ion",
"NiMH",
"Lead Acid",
"NiCd"
],
"name": "Battery Type"
},
"configuration": {
"type": "oneOf",
"value": "Series",
"oneOf": [
"Series",
"Parallel",
"Series-Parallel"
],
"name": "Configuration"
},
"location": {
"type": "location",
"countryCodes": [
"US"
],
"name": "Location"
}
},
"version": 1
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/products/{productKey}/latestValues": {
"get": {
"tags": [
"Product"
],
"summary": "Returns product with the current values (Including Draft), as they were last set. This includes only properties that have been set. Use\nthe product status call to ensure that all required values are set.",
"parameters": [
{
"name": "productKey",
"in": "path",
"description": "Use the key provided in the v3/products call",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModel"
}
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "RWD Battery Pack",
"name": "Name"
},
"homePage": {
"type": "link",
"url": "https://batteryPacks.com",
"name": "Home Page Url"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-01-29T04:05:06Z",
"name": "Date of release"
},
"version": {
"type": "numeric",
"value": 10,
"name": "Version"
},
"nominalVoltage": {
"type": "uom",
"value": 10,
"uom": "V",
"name": "Nominal voltage"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"Li-ion",
"NiMH"
],
"oneOrMoreOf": [
"Li-ion",
"NiMH",
"Lead Acid",
"NiCd"
],
"name": "Battery Type"
},
"configuration": {
"type": "oneOf",
"value": "Series",
"oneOf": [
"Series",
"Parallel",
"Series-Parallel"
],
"name": "Configuration"
},
"location": {
"type": "location",
"countryCodes": [
"US"
],
"name": "Location"
}
},
"version": 1
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModel"
}
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "RWD Battery Pack",
"name": "Name"
},
"homePage": {
"type": "link",
"url": "https://batteryPacks.com",
"name": "Home Page Url"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-01-29T04:05:06Z",
"name": "Date of release"
},
"version": {
"type": "numeric",
"value": 10,
"name": "Version"
},
"nominalVoltage": {
"type": "uom",
"value": 10,
"uom": "V",
"name": "Nominal voltage"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"Li-ion",
"NiMH"
],
"oneOrMoreOf": [
"Li-ion",
"NiMH",
"Lead Acid",
"NiCd"
],
"name": "Battery Type"
},
"configuration": {
"type": "oneOf",
"value": "Series",
"oneOf": [
"Series",
"Parallel",
"Series-Parallel"
],
"name": "Configuration"
},
"location": {
"type": "location",
"countryCodes": [
"US"
],
"name": "Location"
}
},
"version": 1
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModel"
}
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "RWD Battery Pack",
"name": "Name"
},
"homePage": {
"type": "link",
"url": "https://batteryPacks.com",
"name": "Home Page Url"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-01-29T04:05:06Z",
"name": "Date of release"
},
"version": {
"type": "numeric",
"value": 10,
"name": "Version"
},
"nominalVoltage": {
"type": "uom",
"value": 10,
"uom": "V",
"name": "Nominal voltage"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"Li-ion",
"NiMH"
],
"oneOrMoreOf": [
"Li-ion",
"NiMH",
"Lead Acid",
"NiCd"
],
"name": "Battery Type"
},
"configuration": {
"type": "oneOf",
"value": "Series",
"oneOf": [
"Series",
"Parallel",
"Series-Parallel"
],
"name": "Configuration"
},
"location": {
"type": "location",
"countryCodes": [
"US"
],
"name": "Location"
}
},
"version": 1
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/products/{productKey}/lastIssuedValues": {
"get": {
"tags": [
"Product"
],
"summary": "Returns a product with the latest issued (published) values. Only returns products that have been issued.",
"parameters": [
{
"name": "productKey",
"in": "path",
"description": "Use the key provided in the v3/products call",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModel"
}
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "RWD Battery Pack",
"name": "Name"
},
"homePage": {
"type": "link",
"url": "https://batteryPacks.com",
"name": "Home Page Url"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-01-29T04:05:06Z",
"name": "Date of release"
},
"version": {
"type": "numeric",
"value": 10,
"name": "Version"
},
"nominalVoltage": {
"type": "uom",
"value": 10,
"uom": "V",
"name": "Nominal voltage"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"Li-ion",
"NiMH"
],
"oneOrMoreOf": [
"Li-ion",
"NiMH",
"Lead Acid",
"NiCd"
],
"name": "Battery Type"
},
"configuration": {
"type": "oneOf",
"value": "Series",
"oneOf": [
"Series",
"Parallel",
"Series-Parallel"
],
"name": "Configuration"
},
"location": {
"type": "location",
"countryCodes": [
"US"
],
"name": "Location"
}
},
"version": 1
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModel"
}
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "RWD Battery Pack",
"name": "Name"
},
"homePage": {
"type": "link",
"url": "https://batteryPacks.com",
"name": "Home Page Url"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-01-29T04:05:06Z",
"name": "Date of release"
},
"version": {
"type": "numeric",
"value": 10,
"name": "Version"
},
"nominalVoltage": {
"type": "uom",
"value": 10,
"uom": "V",
"name": "Nominal voltage"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"Li-ion",
"NiMH"
],
"oneOrMoreOf": [
"Li-ion",
"NiMH",
"Lead Acid",
"NiCd"
],
"name": "Battery Type"
},
"configuration": {
"type": "oneOf",
"value": "Series",
"oneOf": [
"Series",
"Parallel",
"Series-Parallel"
],
"name": "Configuration"
},
"location": {
"type": "location",
"countryCodes": [
"US"
],
"name": "Location"
}
},
"version": 1
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductModel"
}
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "RWD Battery Pack",
"name": "Name"
},
"homePage": {
"type": "link",
"url": "https://batteryPacks.com",
"name": "Home Page Url"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-01-29T04:05:06Z",
"name": "Date of release"
},
"version": {
"type": "numeric",
"value": 10,
"name": "Version"
},
"nominalVoltage": {
"type": "uom",
"value": 10,
"uom": "V",
"name": "Nominal voltage"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"Li-ion",
"NiMH"
],
"oneOrMoreOf": [
"Li-ion",
"NiMH",
"Lead Acid",
"NiCd"
],
"name": "Battery Type"
},
"configuration": {
"type": "oneOf",
"value": "Series",
"oneOf": [
"Series",
"Parallel",
"Series-Parallel"
],
"name": "Configuration"
},
"location": {
"type": "location",
"countryCodes": [
"US"
],
"name": "Location"
}
},
"version": 1
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/products/data": {
"post": {
"tags": [
"Product"
],
"summary": "Request static values to be updated for a product. Please use the scaffolding endpoint to get the required keys. The\ncall does support sending partial data, so only the values that need to be updated should be sent.",
"requestBody": {
"description": "The product data model containing the values to update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticDataModel"
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "42"
},
"homePage": {
"type": "link",
"url": "https://example.com"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-02-03T04:09:06Z"
},
"version": {
"type": "numeric",
"value": 42
},
"nominalVoltage": {
"type": "uom",
"value": 42,
"uom": "V"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
]
},
"configuration": {
"type": "oneOf",
"value": "Series-Parallel"
},
"location": {
"type": "location",
"countryCodes": [
"GB"
]
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StaticDataModel"
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "42"
},
"homePage": {
"type": "link",
"url": "https://example.com"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-02-03T04:09:06Z"
},
"version": {
"type": "numeric",
"value": 42
},
"nominalVoltage": {
"type": "uom",
"value": 42,
"uom": "V"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
]
},
"configuration": {
"type": "oneOf",
"value": "Series-Parallel"
},
"location": {
"type": "location",
"countryCodes": [
"GB"
]
}
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/StaticDataModel"
},
"example": {
"key": "battery_0001",
"properties": {
"name": {
"type": "string",
"value": "42"
},
"homePage": {
"type": "link",
"url": "https://example.com"
},
"releaseDate": {
"type": "dateTime",
"dateTime": "2001-02-03T04:09:06Z"
},
"version": {
"type": "numeric",
"value": 42
},
"nominalVoltage": {
"type": "uom",
"value": 42,
"uom": "V"
},
"batteryType": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
]
},
"configuration": {
"type": "oneOf",
"value": "Series-Parallel"
},
"location": {
"type": "location",
"countryCodes": [
"GB"
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 42
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 42
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 42
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/products/data/{requestId}/status": {
"get": {
"tags": [
"Product"
],
"summary": "Get the status of a product update request",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "RequestId comes from the response of the POST v3/data call.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
},
"example": {
"requestId": 42,
"state": "Success",
"failures": []
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
},
"example": {
"requestId": 42,
"state": "Success",
"failures": []
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
},
"example": {
"requestId": 42,
"state": "Success",
"failures": []
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/products/{productKey}/status": {
"get": {
"tags": [
"Product"
],
"summary": "Get the current status of a product. The status plus the missing required data will be returned.",
"parameters": [
{
"name": "productKey",
"in": "path",
"description": "Use the key provided in the v3/products call",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationResponse"
},
"example": {
"key": "battery_0001",
"state": "Draft",
"version": 1,
"propertiesRequiringValue": [
"missingKey"
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationResponse"
},
"example": {
"key": "battery_0001",
"state": "Draft",
"version": 1,
"propertiesRequiringValue": [
"missingKey"
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidationResponse"
},
"example": {
"key": "battery_0001",
"state": "Draft",
"version": 1,
"propertiesRequiringValue": [
"missingKey"
]
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/products/static/upload/image": {
"post": {
"tags": [
"Product"
],
"summary": "Allows user to upload an image (.jpeg, .jpg, .png). This call returns a link that can then be used in the product\ndata under the link type.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "The image file to upload",
"format": "binary"
}
}
},
"encoding": {
"image": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UploadResult"
},
"example": {
"url": "https://example.com/name/file_name"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadResult"
},
"example": {
"url": "https://example.com/name/file_name"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UploadResult"
},
"example": {
"url": "https://example.com/name/file_name"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/products/static/upload/file": {
"post": {
"tags": [
"Product"
],
"summary": "Allows user to upload a files (.pdf). This call returns a link that can then be used in the product data under the\nlink type.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "The file to upload",
"format": "binary"
}
}
},
"encoding": {
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UploadResult"
},
"example": {
"url": "https://example.com/name/file_name"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadResult"
},
"example": {
"url": "https://example.com/name/file_name"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UploadResult"
},
"example": {
"url": "https://example.com/name/file_name"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/products/{productKey}/issue": {
"post": {
"tags": [
"Product"
],
"summary": "[WIP] Issue the current draft version of the product. This will create a new version of the product which will be used for future product creation.",
"parameters": [
{
"name": "productKey",
"in": "path",
"description": "The key of the product to issue",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductModel"
},
"example": {
"key": "batteryPack001",
"state": "Issued",
"version": 1,
"propertiesRequiringValue": [],
"validationIssues": []
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductModel"
},
"example": {
"key": "batteryPack001",
"state": "Issued",
"version": 1,
"propertiesRequiringValue": [],
"validationIssues": []
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductModel"
},
"example": {
"key": "batteryPack001",
"state": "Issued",
"version": 1,
"propertiesRequiringValue": [],
"validationIssues": []
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IssueProductResponse"
},
"example": {
"key": "batteryPack001",
"state": "Draft",
"version": 0,
"propertiesRequiringValue": [
"batteryStatus"
],
"validationIssues": [
{
"propertyKey": "batteryStatus",
"description": "Battery status can only be one of \"Original\", \"Re-Used\", \"Re-Manufacture\", \"Waste\" "
}
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IssueProductResponse"
},
"example": {
"key": "batteryPack001",
"state": "Draft",
"version": 0,
"propertiesRequiringValue": [
"batteryStatus"
],
"validationIssues": [
{
"propertyKey": "batteryStatus",
"description": "Battery status can only be one of \"Original\", \"Re-Used\", \"Re-Manufacture\", \"Waste\" "
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IssueProductResponse"
},
"example": {
"key": "batteryPack001",
"state": "Draft",
"version": 0,
"propertiesRequiringValue": [
"batteryStatus"
],
"validationIssues": [
{
"propertyKey": "batteryStatus",
"description": "Battery status can only be one of \"Original\", \"Re-Used\", \"Re-Manufacture\", \"Waste\" "
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/items/dynamic-data": {
"post": {
"tags": [
"Product Item"
],
"summary": "Store product item level dynamic data for multiple items",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicData"
}
},
"example": [
{
"itemReference": "sample",
"properties": {
"batteryStatus": {
"type": "oneOf",
"value": ""
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%"
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1
},
"informationOnAccidents": {
"type": "string",
"value": "?"
}
}
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicData"
}
},
"example": [
{
"itemReference": "sample",
"properties": {
"batteryStatus": {
"type": "oneOf",
"value": ""
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%"
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1
},
"informationOnAccidents": {
"type": "string",
"value": "?"
}
}
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicData"
}
},
"example": [
{
"itemReference": "sample",
"properties": {
"batteryStatus": {
"type": "oneOf",
"value": ""
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%"
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1
},
"informationOnAccidents": {
"type": "string",
"value": "?"
}
}
}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 42
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 42
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 42
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/items/dynamic-data/scaffolding": {
"get": {
"tags": [
"Product Item"
],
"summary": "Retrieve scaffolding for allowed dynamic data fields for a product item",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicData"
}
},
"example": [
{
"itemReference": "sample",
"properties": {
"batteryStatus": {
"type": "oneOf",
"value": ""
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%"
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1
},
"informationOnAccidents": {
"type": "string",
"value": "?"
}
}
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicData"
}
},
"example": [
{
"itemReference": "sample",
"properties": {
"batteryStatus": {
"type": "oneOf",
"value": ""
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%"
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1
},
"informationOnAccidents": {
"type": "string",
"value": "?"
}
}
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicData"
}
},
"example": [
{
"itemReference": "sample",
"properties": {
"batteryStatus": {
"type": "oneOf",
"value": ""
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%"
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh"
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah"
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1
},
"informationOnAccidents": {
"type": "string",
"value": "?"
}
}
}
]
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/items/dynamic-data/{itemReference}": {
"get": {
"tags": [
"Product Item"
],
"summary": "Retrieve product item level dynamic data",
"parameters": [
{
"name": "itemReference",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DynamicModel"
},
"example": {
"productReference": "battery_0001",
"properties": {
"name_dynamic": {
"type": "string",
"value": "42",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"homePage_dynamic": {
"type": "link",
"url": "https://example.com",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"releaseDate_dynamic": {
"type": "dateTime",
"dateTime": "2001-02-03T04:10:06Z",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"version_dynamic": {
"type": "numeric",
"value": 42,
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"nominalVoltage_dynamic": {
"type": "uom",
"value": 42,
"uom": "V",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"batteryType_dynamic": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
],
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"configuration_dynamic": {
"type": "oneOf",
"value": "Series-Parallel",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"location_dynamic": {
"type": "location",
"countryCodes": [
"GB"
],
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
}
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DynamicModel"
},
"example": {
"productReference": "battery_0001",
"properties": {
"name_dynamic": {
"type": "string",
"value": "42",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"homePage_dynamic": {
"type": "link",
"url": "https://example.com",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"releaseDate_dynamic": {
"type": "dateTime",
"dateTime": "2001-02-03T04:10:06Z",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"version_dynamic": {
"type": "numeric",
"value": 42,
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"nominalVoltage_dynamic": {
"type": "uom",
"value": 42,
"uom": "V",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"batteryType_dynamic": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
],
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"configuration_dynamic": {
"type": "oneOf",
"value": "Series-Parallel",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"location_dynamic": {
"type": "location",
"countryCodes": [
"GB"
],
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DynamicModel"
},
"example": {
"productReference": "battery_0001",
"properties": {
"name_dynamic": {
"type": "string",
"value": "42",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"homePage_dynamic": {
"type": "link",
"url": "https://example.com",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"releaseDate_dynamic": {
"type": "dateTime",
"dateTime": "2001-02-03T04:10:06Z",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"version_dynamic": {
"type": "numeric",
"value": 42,
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"nominalVoltage_dynamic": {
"type": "uom",
"value": 42,
"uom": "V",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"batteryType_dynamic": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
],
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"configuration_dynamic": {
"type": "oneOf",
"value": "Series-Parallel",
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
},
"location_dynamic": {
"type": "location",
"countryCodes": [
"GB"
],
"effectiveFrom": "2001-01-29T04:05:06Z",
"lastUpdated": "2001-01-29T04:05:06Z"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/items/dynamic-data/{itemReference}/history": {
"get": {
"tags": [
"Product Item"
],
"summary": "Retrieve product item level dynamic data with history",
"parameters": [
{
"name": "itemReference",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DynamicModelWithHistory"
},
"example": {
"productReference": "battery_0005",
"properties": {
"name": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "string",
"value": "42",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "string",
"value": "42",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"homePage": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "link",
"url": "https://example.com",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "link",
"url": "https://example.com",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"releaseDate": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "dateTime",
"dateTime": "2001-02-03T04:08:06Z",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "dateTime",
"dateTime": "2001-02-03T04:08:06Z",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"version": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "numeric",
"value": 42,
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "numeric",
"value": 42,
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"nominalVoltage": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "uom",
"value": 42,
"uom": "V",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "uom",
"value": 42,
"uom": "V",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"batteryType": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"configuration": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOf",
"value": "Series-Parallel",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOf",
"value": "Series-Parallel",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"location": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "location",
"countryCodes": [
"GB"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "location",
"countryCodes": [
"GB"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
]
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DynamicModelWithHistory"
},
"example": {
"productReference": "battery_0005",
"properties": {
"name": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "string",
"value": "42",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "string",
"value": "42",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"homePage": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "link",
"url": "https://example.com",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "link",
"url": "https://example.com",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"releaseDate": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "dateTime",
"dateTime": "2001-02-03T04:08:06Z",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "dateTime",
"dateTime": "2001-02-03T04:08:06Z",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"version": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "numeric",
"value": 42,
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "numeric",
"value": 42,
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"nominalVoltage": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "uom",
"value": 42,
"uom": "V",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "uom",
"value": 42,
"uom": "V",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"batteryType": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"configuration": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOf",
"value": "Series-Parallel",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOf",
"value": "Series-Parallel",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"location": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "location",
"countryCodes": [
"GB"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "location",
"countryCodes": [
"GB"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
]
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DynamicModelWithHistory"
},
"example": {
"productReference": "battery_0005",
"properties": {
"name": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "string",
"value": "42",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "string",
"value": "42",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"homePage": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "link",
"url": "https://example.com",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "link",
"url": "https://example.com",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"releaseDate": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "dateTime",
"dateTime": "2001-02-03T04:08:06Z",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "dateTime",
"dateTime": "2001-02-03T04:08:06Z",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"version": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "numeric",
"value": 42,
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "numeric",
"value": 42,
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"nominalVoltage": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "uom",
"value": 42,
"uom": "V",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "uom",
"value": 42,
"uom": "V",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"batteryType": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOrMoreOf",
"values": [
"NiMH",
"Lead Acid"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"configuration": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOf",
"value": "Series-Parallel",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "oneOf",
"value": "Series-Parallel",
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
],
"location": [
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "location",
"countryCodes": [
"GB"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
},
{
"timeStamp": "2001-01-29T04:05:06Z",
"value": {
"type": "location",
"countryCodes": [
"GB"
],
"effectiveFrom": "2001-01-29T04:05:06Z"
}
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/items/dynamic-data/{requestId}/status": {
"get": {
"tags": [
"Product Item"
],
"summary": "Retrieve status of a dynamic data update request",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
},
"example": {
"requestId": 42,
"state": "Success",
"failures": []
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
},
"example": {
"requestId": 42,
"state": "Success",
"failures": []
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
},
"example": {
"requestId": 42,
"state": "Success",
"failures": []
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/items/life-cycle": {
"post": {
"tags": [
"Product Item"
],
"summary": "[WIP] Store product item level life-cycle events",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LifeCycleData"
}
},
"example": [
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "InstallBatteryInVehicle",
"properties": {
"vehicleReference": {
"type": "string",
"value": "4Y1-SL658-4-8-Z-41-0000"
},
"batteryReference": {
"type": "string",
"value": "battery01"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "RemoveBatteryFromVehicle",
"properties": {
"vehicleReference": {
"type": "string",
"value": "4Y1-SL658-4-8-Z-41-0000"
},
"batteryReference": {
"type": "string",
"value": "battery01"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "RepurposeBattery",
"properties": {
"batteryReferences": {
"type": "oneOrMoreOf",
"values": [
"battery01"
]
},
"newBatteryReference": {
"type": "string",
"value": "battery01-repurposed"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "ReManufactureBattery",
"properties": {
"batteryReferences": {
"type": "oneOrMoreOf",
"values": [
"battery01"
]
},
"newBatteryReference": {
"type": "string",
"value": "battery01-re-manufactured"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "WasteBattery",
"properties": {
"batteryReference": {
"type": "string",
"value": "battery04"
}
}
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LifeCycleData"
}
},
"example": [
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "InstallBatteryInVehicle",
"properties": {
"vehicleReference": {
"type": "string",
"value": "4Y1-SL658-4-8-Z-41-0000"
},
"batteryReference": {
"type": "string",
"value": "battery01"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "RemoveBatteryFromVehicle",
"properties": {
"vehicleReference": {
"type": "string",
"value": "4Y1-SL658-4-8-Z-41-0000"
},
"batteryReference": {
"type": "string",
"value": "battery01"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "RepurposeBattery",
"properties": {
"batteryReferences": {
"type": "oneOrMoreOf",
"values": [
"battery01"
]
},
"newBatteryReference": {
"type": "string",
"value": "battery01-repurposed"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "ReManufactureBattery",
"properties": {
"batteryReferences": {
"type": "oneOrMoreOf",
"values": [
"battery01"
]
},
"newBatteryReference": {
"type": "string",
"value": "battery01-re-manufactured"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "WasteBattery",
"properties": {
"batteryReference": {
"type": "string",
"value": "battery04"
}
}
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LifeCycleData"
}
},
"example": [
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "InstallBatteryInVehicle",
"properties": {
"vehicleReference": {
"type": "string",
"value": "4Y1-SL658-4-8-Z-41-0000"
},
"batteryReference": {
"type": "string",
"value": "battery01"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "RemoveBatteryFromVehicle",
"properties": {
"vehicleReference": {
"type": "string",
"value": "4Y1-SL658-4-8-Z-41-0000"
},
"batteryReference": {
"type": "string",
"value": "battery01"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "RepurposeBattery",
"properties": {
"batteryReferences": {
"type": "oneOrMoreOf",
"values": [
"battery01"
]
},
"newBatteryReference": {
"type": "string",
"value": "battery01-repurposed"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "ReManufactureBattery",
"properties": {
"batteryReferences": {
"type": "oneOrMoreOf",
"values": [
"battery01"
]
},
"newBatteryReference": {
"type": "string",
"value": "battery01-re-manufactured"
}
}
},
{
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "WasteBattery",
"properties": {
"batteryReference": {
"type": "string",
"value": "battery04"
}
}
}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 42
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 42
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 42
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/items/life-cycle/{requestId}/status": {
"get": {
"tags": [
"Product Item"
],
"summary": "[WIP] Retrieve status of a product item level life-cycle update event request",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
},
"example": {
"requestId": 42,
"state": "Success",
"failures": []
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
},
"example": {
"requestId": 42,
"state": "Success",
"failures": []
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
},
"example": {
"requestId": 42,
"state": "Success",
"failures": []
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/product/v3/items/life-cycle/{itemReference}": {
"get": {
"tags": [
"Product Item"
],
"summary": "[WIP] Retrieve product item level life-cycle events",
"parameters": [
{
"name": "itemReference",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LifeCycleData"
},
"example": {
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "InstallBatteryInVehicle",
"properties": {
"vehicleReference": {
"type": "string",
"value": "4Y1-SL658-4-8-Z-41-0000"
},
"batteryReference": {
"type": "string",
"value": "battery01"
}
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LifeCycleData"
},
"example": {
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "InstallBatteryInVehicle",
"properties": {
"vehicleReference": {
"type": "string",
"value": "4Y1-SL658-4-8-Z-41-0000"
},
"batteryReference": {
"type": "string",
"value": "battery01"
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LifeCycleData"
},
"example": {
"effectiveFrom": "2001-01-29T04:05:06Z",
"eventType": "InstallBatteryInVehicle",
"properties": {
"vehicleReference": {
"type": "string",
"value": "4Y1-SL658-4-8-Z-41-0000"
},
"batteryReference": {
"type": "string",
"value": "battery01"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/dpp/v3/create/fromTraceability": {
"post": {
"tags": [
"Product Passport"
],
"summary": "Trigger a DPP to be built from traceability data. Providing scan reference will be used to generate and trigger scans",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFromTraceabilityRequest"
},
"example": {
"productKey": "BatteryPack001",
"dcpKey": "GoodsOut001",
"templateKey": "EU-BatteryPass",
"references": [
"BatteryPack001-020202",
"BatteryPack001-000003"
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateFromTraceabilityRequest"
},
"example": {
"productKey": "BatteryPack001",
"dcpKey": "GoodsOut001",
"templateKey": "EU-BatteryPass",
"references": [
"BatteryPack001-020202",
"BatteryPack001-000003"
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateFromTraceabilityRequest"
},
"example": {
"productKey": "BatteryPack001",
"dcpKey": "GoodsOut001",
"templateKey": "EU-BatteryPass",
"references": [
"BatteryPack001-020202",
"BatteryPack001-000003"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 89787987
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 89787987
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 89787987
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/dpp/v3/create/{requestId}/status": {
"get": {
"tags": [
"Product Passport"
],
"summary": "Return the result of a trigger request",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "The request ID to check status for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StatusGuidResponse"
},
"example": {
"requestId": "LJKHASLKDJH",
"state": "Failed",
"failures": [
{
"reference": "BatteryPack001-000003",
"reason": "Could not find the reference at GoodsOut001.",
"code": "NOT-FOUND"
}
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusGuidResponse"
},
"example": {
"requestId": "LJKHASLKDJH",
"state": "Failed",
"failures": [
{
"reference": "BatteryPack001-000003",
"reason": "Could not find the reference at GoodsOut001.",
"code": "NOT-FOUND"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StatusGuidResponse"
},
"example": {
"requestId": "LJKHASLKDJH",
"state": "Failed",
"failures": [
{
"reference": "BatteryPack001-000003",
"reason": "Could not find the reference at GoodsOut001.",
"code": "NOT-FOUND"
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/dpp/v3/create/fromData": {
"post": {
"tags": [
"Product Passport"
],
"summary": "Create product item with a DPP. Please use the scaffold call to see what item data is required. This call will generate a DPP.",
"requestBody": {
"description": "The dynamic data for creating the product item",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFromDynamicDataRequest"
}
},
"example": [
{
"itemReference": "BatteryPack001-000003",
"productKey": "BatteryPack001",
"templateKey": "template_001",
"properties": {
"batteryIdentifier": {
"type": "string",
"value": "97a33541-6"
},
"operatorIdentifierAndInformation": {
"type": "string",
"value": "17364e1c-5"
},
"manufacturingDate": {
"type": "dateTime",
"dateTime": "2023-01-05T12:01:05"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "dateTime",
"dateTime": "2023-01-05T12:01:05"
},
"batteryStatus": {
"type": "oneOf",
"value": "Lipsum"
},
"extinguishingAgent": {
"type": "string",
"value": "Lipsum"
},
"remainingCapacity": {
"type": "uom",
"value": 42,
"uom": "Ah"
},
"ubeMeasured": {
"type": "uom",
"value": 42,
"uom": "kWh"
},
"soce": {
"type": "uom",
"value": 42,
"uom": "%"
},
"soc": {
"type": "uom",
"value": 42,
"uom": "%"
},
"remainingPowerCapability": {
"type": "uom",
"value": 42,
"uom": "W"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": 42,
"uom": "%"
},
"selfDischargingRate": {
"type": "uom",
"value": 42,
"uom": "%/month"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": 42,
"uom": "%"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": 42
},
"energyThroughput": {
"type": "uom",
"value": 42,
"uom": "kWh"
},
"capacityThroughput": {
"type": "uom",
"value": 42,
"uom": "Ah"
},
"temperatureInformation": {
"type": "uom",
"value": 42,
"uom": "°C"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": 42
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": 42
},
"informationOnAccidents": {
"type": "string",
"value": "f93cd23f-c"
}
}
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFromDynamicDataRequest"
}
},
"example": [
{
"itemReference": "BatteryPack001-000003",
"productKey": "BatteryPack001",
"templateKey": "template_001",
"properties": {
"batteryIdentifier": {
"type": "string",
"value": "97a33541-6"
},
"operatorIdentifierAndInformation": {
"type": "string",
"value": "17364e1c-5"
},
"manufacturingDate": {
"type": "dateTime",
"dateTime": "2023-01-05T12:01:05"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "dateTime",
"dateTime": "2023-01-05T12:01:05"
},
"batteryStatus": {
"type": "oneOf",
"value": "Lipsum"
},
"extinguishingAgent": {
"type": "string",
"value": "Lipsum"
},
"remainingCapacity": {
"type": "uom",
"value": 42,
"uom": "Ah"
},
"ubeMeasured": {
"type": "uom",
"value": 42,
"uom": "kWh"
},
"soce": {
"type": "uom",
"value": 42,
"uom": "%"
},
"soc": {
"type": "uom",
"value": 42,
"uom": "%"
},
"remainingPowerCapability": {
"type": "uom",
"value": 42,
"uom": "W"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": 42,
"uom": "%"
},
"selfDischargingRate": {
"type": "uom",
"value": 42,
"uom": "%/month"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": 42,
"uom": "%"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": 42
},
"energyThroughput": {
"type": "uom",
"value": 42,
"uom": "kWh"
},
"capacityThroughput": {
"type": "uom",
"value": 42,
"uom": "Ah"
},
"temperatureInformation": {
"type": "uom",
"value": 42,
"uom": "°C"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": 42
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": 42
},
"informationOnAccidents": {
"type": "string",
"value": "f93cd23f-c"
}
}
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFromDynamicDataRequest"
}
},
"example": [
{
"itemReference": "BatteryPack001-000003",
"productKey": "BatteryPack001",
"templateKey": "template_001",
"properties": {
"batteryIdentifier": {
"type": "string",
"value": "97a33541-6"
},
"operatorIdentifierAndInformation": {
"type": "string",
"value": "17364e1c-5"
},
"manufacturingDate": {
"type": "dateTime",
"dateTime": "2023-01-05T12:01:05"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "dateTime",
"dateTime": "2023-01-05T12:01:05"
},
"batteryStatus": {
"type": "oneOf",
"value": "Lipsum"
},
"extinguishingAgent": {
"type": "string",
"value": "Lipsum"
},
"remainingCapacity": {
"type": "uom",
"value": 42,
"uom": "Ah"
},
"ubeMeasured": {
"type": "uom",
"value": 42,
"uom": "kWh"
},
"soce": {
"type": "uom",
"value": 42,
"uom": "%"
},
"soc": {
"type": "uom",
"value": 42,
"uom": "%"
},
"remainingPowerCapability": {
"type": "uom",
"value": 42,
"uom": "W"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": 42,
"uom": "%"
},
"selfDischargingRate": {
"type": "uom",
"value": 42,
"uom": "%/month"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": 42,
"uom": "%"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": 42
},
"energyThroughput": {
"type": "uom",
"value": 42,
"uom": "kWh"
},
"capacityThroughput": {
"type": "uom",
"value": 42,
"uom": "Ah"
},
"temperatureInformation": {
"type": "uom",
"value": 42,
"uom": "°C"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": 42,
"uom": "Minutes"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": 42
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": 42
},
"informationOnAccidents": {
"type": "string",
"value": "f93cd23f-c"
}
}
}
]
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 89787987
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 89787987
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PostResponse"
},
"example": {
"requestId": 89787987
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/dpp/v3/create/fromData/valid/productTemplates": {
"get": {
"tags": [
"Product Passport"
],
"summary": "Returns a list of product keys and their associated template keys.",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PassportConfiguration"
}
},
"example": [
{
"passportName": "Batter Pack",
"passportVersion": 1,
"templateKey": "batteryPackTemplate",
"productKey": "batteryPack001"
},
{
"passportName": "Battery Cell",
"passportVersion": 2,
"templateKey": "batteryCellTemplate",
"productKey": "batteryCell001"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PassportConfiguration"
}
},
"example": [
{
"passportName": "Batter Pack",
"passportVersion": 1,
"templateKey": "batteryPackTemplate",
"productKey": "batteryPack001"
},
{
"passportName": "Battery Cell",
"passportVersion": 2,
"templateKey": "batteryCellTemplate",
"productKey": "batteryCell001"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PassportConfiguration"
}
},
"example": [
{
"passportName": "Batter Pack",
"passportVersion": 1,
"templateKey": "batteryPackTemplate",
"productKey": "batteryPack001"
},
{
"passportName": "Battery Cell",
"passportVersion": 2,
"templateKey": "batteryCellTemplate",
"productKey": "batteryCell001"
}
]
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/dpp/v3/create/fromData/scaffold/{templateKey}": {
"get": {
"tags": [
"Product Passport"
],
"summary": "Returns the required scaffolding for a product item based on the template key.",
"parameters": [
{
"name": "templateKey",
"in": "path",
"description": "The template key to get scaffolding for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductItemScaffoldResponse"
},
"example": {
"key": "battery_0001",
"properties": {
"batteryIdentifier": {
"type": "string",
"value": "?",
"name": "Battery identifier"
},
"operatorIdentifierAndInformation": {
"type": "string",
"value": "?",
"name": "Operator identifier and information"
},
"manufacturingDate": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Manufacturing date"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Date of putting the battery into service"
},
"batteryStatus": {
"type": "oneOf",
"value": "",
"oneOf": [
"Original",
"Re-Used",
"Re-Manufacture",
"Waste"
],
"name": "Battery status"
},
"extinguishingAgent": {
"type": "string",
"value": "?",
"name": "Extinguishing agent"
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Remaining capacity"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Remaining usable battery energy"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of certified energy (SOCE)"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of Charge (SoC)"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Remaining power capability"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Remaining round trip energy efficiency "
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month",
"name": "Current self-discharge rate"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Evolution of self-discharge rates"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1,
"name": "Number of full charging and discharging cycles"
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Energy throughput "
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Capacity throughput "
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature information"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures above boundary"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures below boundary"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures above boundary"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures below boundary"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of deep discharge events"
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of overcharge events"
},
"informationOnAccidents": {
"type": "string",
"value": "?",
"name": "Information on accidents"
}
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductItemScaffoldResponse"
},
"example": {
"key": "battery_0001",
"properties": {
"batteryIdentifier": {
"type": "string",
"value": "?",
"name": "Battery identifier"
},
"operatorIdentifierAndInformation": {
"type": "string",
"value": "?",
"name": "Operator identifier and information"
},
"manufacturingDate": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Manufacturing date"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Date of putting the battery into service"
},
"batteryStatus": {
"type": "oneOf",
"value": "",
"oneOf": [
"Original",
"Re-Used",
"Re-Manufacture",
"Waste"
],
"name": "Battery status"
},
"extinguishingAgent": {
"type": "string",
"value": "?",
"name": "Extinguishing agent"
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Remaining capacity"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Remaining usable battery energy"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of certified energy (SOCE)"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of Charge (SoC)"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Remaining power capability"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Remaining round trip energy efficiency "
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month",
"name": "Current self-discharge rate"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Evolution of self-discharge rates"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1,
"name": "Number of full charging and discharging cycles"
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Energy throughput "
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Capacity throughput "
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature information"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures above boundary"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures below boundary"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures above boundary"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures below boundary"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of deep discharge events"
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of overcharge events"
},
"informationOnAccidents": {
"type": "string",
"value": "?",
"name": "Information on accidents"
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductItemScaffoldResponse"
},
"example": {
"key": "battery_0001",
"properties": {
"batteryIdentifier": {
"type": "string",
"value": "?",
"name": "Battery identifier"
},
"operatorIdentifierAndInformation": {
"type": "string",
"value": "?",
"name": "Operator identifier and information"
},
"manufacturingDate": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Manufacturing date"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "dateTime",
"dateTime": "1970-01-01T00:00:00",
"name": "Date of putting the battery into service"
},
"batteryStatus": {
"type": "oneOf",
"value": "",
"oneOf": [
"Original",
"Re-Used",
"Re-Manufacture",
"Waste"
],
"name": "Battery status"
},
"extinguishingAgent": {
"type": "string",
"value": "?",
"name": "Extinguishing agent"
},
"remainingCapacity": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Remaining capacity"
},
"ubeMeasured": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Remaining usable battery energy"
},
"soce": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of certified energy (SOCE)"
},
"soc": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "State of Charge (SoC)"
},
"remainingPowerCapability": {
"type": "uom",
"value": -1,
"uom": "W",
"name": "Remaining power capability"
},
"remainingRoundTripEnergyEfficiency": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Remaining round trip energy efficiency "
},
"selfDischargingRate": {
"type": "uom",
"value": -1,
"uom": "%/month",
"name": "Current self-discharge rate"
},
"evolutionOfSelfDischargingRates": {
"type": "uom",
"value": -1,
"uom": "%",
"name": "Evolution of self-discharge rates"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "numeric",
"value": -1,
"name": "Number of full charging and discharging cycles"
},
"energyThroughput": {
"type": "uom",
"value": -1,
"uom": "kWh",
"name": "Energy throughput "
},
"capacityThroughput": {
"type": "uom",
"value": -1,
"uom": "Ah",
"name": "Capacity throughput "
},
"temperatureInformation": {
"type": "uom",
"value": -1,
"uom": "°C",
"name": "Temperature information"
},
"timeSpentInExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures above boundary"
},
"timeSpentInExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent in extreme temperatures below boundary"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures above boundary"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundary": {
"type": "uom",
"value": -1,
"uom": "Minutes",
"name": "Time spent charging during extreme temperatures below boundary"
},
"numberOfDeepDischargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of deep discharge events"
},
"numberOfOverchargeEvents": {
"type": "numeric",
"value": -1,
"name": "Number of overcharge events"
},
"informationOnAccidents": {
"type": "string",
"value": "?",
"name": "Information on accidents"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/prove/v3/scans": {
"post": {
"tags": [
"Traceability"
],
"summary": "Post batch of scans to the API for async processing.",
"requestBody": {
"description": "Array of scan requests to process",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScanRequestV3"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScanRequestV3"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScanRequestV3"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ScanStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScanStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ScanStatus"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/prove/v3/scans/preSignedUrl": {
"get": {
"tags": [
"Traceability"
],
"summary": "Get url that will allow uploading of large files directly to storage using a pre-signed url.",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PreSignedUrlResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreSignedUrlResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PreSignedUrlResult"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/prove/v3/scans/batched": {
"post": {
"tags": [
"Traceability"
],
"summary": "Post batches of scans with similar metadata to the API for async processing.",
"requestBody": {
"description": "Array of batched scan requests",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchedRequestV3"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchedRequestV3"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchedRequestV3"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ScanStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScanStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ScanStatus"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/prove/v3/scans/batched/preSignedUrl": {
"get": {
"tags": [
"Traceability"
],
"summary": "Get url that will allow uploading of large files directly to storage using a pre-signed url. Format of this file needs to be in batch format",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PreSignedUrlResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreSignedUrlResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PreSignedUrlResult"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/prove/v3/scans/{requestId}/status": {
"get": {
"tags": [
"Traceability"
],
"summary": "Use the requestId from the scans call to determine the current state of the scans batch",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "The request ID returned from the scan upload",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ScanStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScanStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ScanStatus"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
}
},
"components": {
"schemas": {
"AllowedStates": {
"enum": [
"Received",
"InProgress",
"Success",
"Failed"
],
"type": "string"
},
"Attribute": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BatchedRequestV3": {
"type": "object",
"properties": {
"timeStamp": {
"type": "string",
"format": "date-time"
},
"dcpKey": {
"type": "string"
},
"productModelKey": {
"type": "string"
},
"scans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartialScan"
}
},
"supplierKey": {
"type": "string",
"nullable": true
},
"clientKey": {
"type": "string",
"nullable": true
},
"parents": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attribute"
},
"nullable": true
}
},
"additionalProperties": false
},
"BatteryStatusValues": {
"enum": [
"Original",
"ReUsed",
"ReManufacture",
"Waste"
],
"type": "string"
},
"CreateFromDynamicDataRequest": {
"type": "object",
"properties": {
"itemReference": {
"type": "string"
},
"productKey": {
"type": "string"
},
"templateKey": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/SectionValue"
},
{
"$ref": "#/components/schemas/StringSectionValue"
},
{
"$ref": "#/components/schemas/UomSectionValue"
},
{
"$ref": "#/components/schemas/LinkSectionValue"
},
{
"$ref": "#/components/schemas/DateTimeSectionValue"
},
{
"$ref": "#/components/schemas/NumericSectionValue"
},
{
"$ref": "#/components/schemas/SelectManySectionValue"
},
{
"$ref": "#/components/schemas/SelectOneSectionValue"
},
{
"$ref": "#/components/schemas/LocationSectionValue"
}
]
}
}
},
"additionalProperties": false
},
"CreateFromTraceabilityRequest": {
"type": "object",
"properties": {
"productKey": {
"type": "string"
},
"dcpKey": {
"type": "string"
},
"templateKey": {
"type": "string"
},
"references": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"CreateProductRequest": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"ofType": {
"$ref": "#/components/schemas/CreateProductType"
}
},
"additionalProperties": false
},
"CreateProductType": {
"enum": [
"BatteryPack"
],
"type": "string"
},
"DateTimeSection": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionBase"
}
],
"properties": {
"dateTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"DateTimeSectionValue": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueBase"
}
],
"properties": {
"dateTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"DateTimeSet": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithEffectiveFrom"
}
],
"properties": {
"dateTime": {
"type": "string",
"format": "date-time"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"DateTimeVal": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithTimestamp"
}
],
"properties": {
"dateTime": {
"type": "string",
"format": "date-time"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUpdated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"DynamicData": {
"type": "object",
"properties": {
"itemReference": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/StringSet"
},
{
"$ref": "#/components/schemas/UomSet"
},
{
"$ref": "#/components/schemas/LinkSet"
},
{
"$ref": "#/components/schemas/DateTimeSet"
},
{
"$ref": "#/components/schemas/NumericSet"
},
{
"$ref": "#/components/schemas/SelectManySet"
},
{
"$ref": "#/components/schemas/SelectOneSet"
},
{
"$ref": "#/components/schemas/LocationSet"
}
]
}
}
},
"additionalProperties": false
},
"DynamicModel": {
"type": "object",
"properties": {
"productReference": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/StringVal"
},
{
"$ref": "#/components/schemas/UomVal"
},
{
"$ref": "#/components/schemas/LinkVal"
},
{
"$ref": "#/components/schemas/DateTimeVal"
},
{
"$ref": "#/components/schemas/NumericVal"
},
{
"$ref": "#/components/schemas/SelectManyVal"
},
{
"$ref": "#/components/schemas/SelectOneVal"
},
{
"$ref": "#/components/schemas/LocationVal"
}
]
}
}
},
"additionalProperties": false
},
"DynamicModelWithHistory": {
"type": "object",
"properties": {
"productReference": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WithDate"
}
}
}
},
"additionalProperties": false
},
"EuBatteryPassItem": {
"type": "object",
"properties": {
"batteryIdentifier": {
"type": "string"
},
"operatorIdentifierAndInformation": {
"type": "string"
},
"manufacturingDate": {
"type": "string",
"format": "date-time"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "string",
"format": "date-time"
},
"batteryStatus": {
"$ref": "#/components/schemas/BatteryStatusValues"
},
"extinguishingAgent": {
"type": "string"
},
"remainingCapacityAh": {
"type": "number",
"format": "double"
},
"ubeMeasuredKWh": {
"type": "number",
"format": "double"
},
"socePercent": {
"type": "number",
"format": "double"
},
"socPercent": {
"type": "number",
"format": "double"
},
"remainingPowerCapabilityW": {
"type": "number",
"format": "double"
},
"remainingRoundTripEnergyEfficiencyPercent": {
"type": "number",
"format": "double"
},
"selfDischargingRatePercentPerMonth": {
"type": "number",
"format": "double"
},
"evolutionOfSelfDischargingRatesPercent": {
"type": "number",
"format": "double"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "number",
"format": "double"
},
"energyThroughputKWh": {
"type": "number",
"format": "double"
},
"capacityThroughputAh": {
"type": "number",
"format": "double"
},
"temperatureInformationCelsius": {
"type": "number",
"format": "double"
},
"timeSpentInExtremeTemperaturesAboveBoundaryMinutes": {
"type": "number",
"format": "double"
},
"timeSpentInExtremeTemperaturesBelowBoundaryMinutes": {
"type": "number",
"format": "double"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundaryMinutes": {
"type": "number",
"format": "double"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundaryMinutes": {
"type": "number",
"format": "double"
},
"numberOfDeepDischargeEvents": {
"type": "number",
"format": "double"
},
"numberOfOverchargeEvents": {
"type": "number",
"format": "double"
},
"informationOnAccidents": {
"type": "string"
}
},
"additionalProperties": false
},
"EuBatteryPassport": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"batteryIdentifier": {
"type": "string"
},
"operatorIdentifierAndInformation": {
"type": "string"
},
"manufacturerIdentifierAndInformation": {
"type": "string"
},
"manufacturingPlace": {
"type": "string"
},
"manufacturingDate": {
"type": "string",
"format": "date-time"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "string",
"format": "date-time"
},
"warrantyPeriodOfTheBattery": {
"type": "string",
"format": "date-time"
},
"batteryCategory": {
"type": "string"
},
"batteryMassKg": {
"type": "number",
"format": "double"
},
"batteryStatus": {
"$ref": "#/components/schemas/BatteryStatusValues"
},
"separateCollectionSymbol": {
"type": "string"
},
"symbolsForCadmiumAndLead": {
"type": "string"
},
"carbonFootprintLabel": {
"type": "string"
},
"extinguishingAgent": {
"type": "string"
},
"meaningOfLabelsAndSymbols": {
"type": "string"
},
"euDeclarationOfConformity": {
"type": "string"
},
"resultsOfTestReportsProvingCompliance": {
"type": "string"
},
"batteryCarbonFootprintPerFunctionalUnitKgCO2ePerkWh": {
"type": "number",
"format": "double"
},
"contributionOfRawMaterialAcquisitionAndPreProcessingLifecycleStagePercent": {
"type": "number",
"format": "double"
},
"shareBcfMainProductProductionPercent": {
"type": "number",
"format": "double"
},
"contributionOfDistributionLifecycleStagePercent": {
"type": "number",
"format": "double"
},
"contributionOfEndOfLifeAndRecyclingLifecycleStagePercent": {
"type": "number",
"format": "double"
},
"carbonFootprintPerformanceClass": {
"type": "string"
},
"webLinkToPublicCarbonFootprintStudy": {
"type": "string"
},
"generalBatteryAndManufacturerInformation": {
"type": "string"
},
"absoluteBatteryCarbonFootprintTCO2e": {
"type": "number",
"format": "double"
},
"informationOfDueDiligenceReport": {
"type": "string"
},
"thirdPartyAssurancesOfRecognisedSchemes": {
"type": "string"
},
"supplyChainIndices": {
"type": "string"
},
"batteryChemistry": {
"type": "string"
},
"criticalRawMaterials": {
"type": "string"
},
"nameOfTheCathodeAnodeElectrolyteMaterials": {
"type": "string"
},
"hazardousSubstances": {
"type": "string"
},
"impactSubstancesEnvironmentHumanHealthSafety": {
"type": "string"
},
"manualForDisassemblyAndDismantlingOfTheBatteryPack": {
"type": "string"
},
"partNumbersForComponents": {
"type": "string"
},
"informationOnSourcesOfSpareParts": {
"type": "string"
},
"safetyMeasures": {
"type": "string"
},
"preConsumerRecycledNickelSharePercent": {
"type": "number",
"format": "double"
},
"preConsumerRecycledCobaltSharePercent": {
"type": "number",
"format": "double"
},
"preConsumerRecycledLithiumSharePercent": {
"type": "number",
"format": "double"
},
"preConsumerRecycledLeadSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledNickelSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledCobaltSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledLithiumSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledLeadSharePercent": {
"type": "number",
"format": "double"
},
"renewableContentSharePercent": {
"type": "number",
"format": "double"
},
"informationOnTheRoleOfEndUsersInContributingToWastePrevention": {
"type": "string"
},
"informationOnTheRoleOfEndUsersInContributingToTheSeparateCollectionOfWasteBatteries": {
"type": "string"
},
"informationOnBatteryCollection": {
"type": "string"
},
"ratedCapacityAh": {
"type": "number",
"format": "double"
},
"remainingCapacityAh": {
"type": "number",
"format": "double"
},
"capacityFadePercent": {
"type": "number",
"format": "double"
},
"certifiedUsableBatteryEnergyKWh": {
"type": "number",
"format": "double"
},
"ubeMeasuredKWh": {
"type": "number",
"format": "double"
},
"socePercent": {
"type": "number",
"format": "double"
},
"socPercent": {
"type": "number",
"format": "double"
},
"minimumVoltageV": {
"type": "number",
"format": "double"
},
"maximumVoltageV": {
"type": "number",
"format": "double"
},
"nominalVoltageV": {
"type": "number",
"format": "double"
},
"originalPowerCapabilityW": {
"type": "number",
"format": "double"
},
"remainingPowerCapabilityW": {
"type": "number",
"format": "double"
},
"powerFadePercent": {
"type": "number",
"format": "double"
},
"maximumPermittedBatteryPowerW": {
"type": "number",
"format": "double"
},
"ratioBetweenNominalBatteryPowerAndBatteryEnergyWPerWh": {
"type": "number",
"format": "double"
},
"initialRoundTripEnergyEfficiencyPercent": {
"type": "number",
"format": "double"
},
"energyRoundTripEfficiencyAt50OfCycleLifePercent": {
"type": "number",
"format": "double"
},
"remainingRoundTripEnergyEfficiencyPercent": {
"type": "number",
"format": "double"
},
"energyRoundTripEfficiencyFadePercent": {
"type": "number",
"format": "double"
},
"initialSelfDischargeRatePercentPerMonth": {
"type": "number",
"format": "double"
},
"selfDischargingRatePercentPerMonth": {
"type": "number",
"format": "double"
},
"evolutionOfSelfDischargingRatesPercent": {
"type": "number",
"format": "double"
},
"moduleRecommendedOhm": {
"type": "number",
"format": "double"
},
"cellAndModuleRecommendedPercent": {
"type": "number",
"format": "double"
},
"expectedLifetimeInCalendarYearsYears": {
"type": "number",
"format": "double"
},
"expectedLifetimeNumberOfChargeDischargeCycles": {
"type": "number",
"format": "double"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "number",
"format": "double"
},
"cycleLifeReferenceTest": {
"type": "string"
},
"cRateOfRelevantCycleLifeTestAPerAh": {
"type": "number",
"format": "double"
},
"energyThroughputKWh": {
"type": "number",
"format": "double"
},
"capacityThroughputAh": {
"type": "number",
"format": "double"
},
"capacityThresholdForExhaustionPercent": {
"type": "number",
"format": "double"
},
"temperatureInformationCelsius": {
"type": "number",
"format": "double"
},
"temperatureRangeIdleStateLowerBoundaryCelsius": {
"type": "number",
"format": "double"
},
"temperatureRangeIdleStateUpperBoundaryCelsius": {
"type": "number",
"format": "double"
},
"timeSpentInExtremeTemperaturesAboveBoundaryMinutes": {
"type": "number",
"format": "double"
},
"timeSpentInExtremeTemperaturesBelowBoundaryMinutes": {
"type": "number",
"format": "double"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundaryMinutes": {
"type": "number",
"format": "double"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundaryMinutes": {
"type": "number",
"format": "double"
},
"numberOfDeepDischargeEvents": {
"type": "number",
"format": "double"
},
"numberOfOverchargeEvents": {
"type": "number",
"format": "double"
},
"informationOnAccidents": {
"type": "string"
}
},
"additionalProperties": false
},
"EuBatteryPassportCreate": {
"type": "object",
"properties": {
"batteryIdentifier": {
"type": "string"
},
"operatorIdentifierAndInformation": {
"type": "string"
},
"manufacturerIdentifierAndInformation": {
"type": "string"
},
"manufacturingPlace": {
"type": "string"
},
"manufacturingDate": {
"type": "string",
"format": "date-time"
},
"dateOfPuttingTheBatteryIntoService": {
"type": "string",
"format": "date-time"
},
"warrantyPeriodOfTheBattery": {
"type": "string",
"format": "date-time"
},
"batteryCategory": {
"type": "string"
},
"batteryMassKg": {
"type": "number",
"format": "double"
},
"batteryStatus": {
"$ref": "#/components/schemas/BatteryStatusValues"
},
"separateCollectionSymbol": {
"type": "string"
},
"symbolsForCadmiumAndLead": {
"type": "string"
},
"carbonFootprintLabel": {
"type": "string"
},
"extinguishingAgent": {
"type": "string"
},
"meaningOfLabelsAndSymbols": {
"type": "string"
},
"euDeclarationOfConformity": {
"type": "string"
},
"resultsOfTestReportsProvingCompliance": {
"type": "string"
},
"batteryCarbonFootprintPerFunctionalUnitKgCO2ePerkWh": {
"type": "number",
"format": "double"
},
"contributionOfRawMaterialAcquisitionAndPreProcessingLifecycleStagePercent": {
"type": "number",
"format": "double"
},
"shareBcfMainProductProductionPercent": {
"type": "number",
"format": "double"
},
"contributionOfDistributionLifecycleStagePercent": {
"type": "number",
"format": "double"
},
"contributionOfEndOfLifeAndRecyclingLifecycleStagePercent": {
"type": "number",
"format": "double"
},
"carbonFootprintPerformanceClass": {
"type": "string"
},
"webLinkToPublicCarbonFootprintStudy": {
"type": "string"
},
"generalBatteryAndManufacturerInformation": {
"type": "string"
},
"absoluteBatteryCarbonFootprintTCO2e": {
"type": "number",
"format": "double"
},
"informationOfDueDiligenceReport": {
"type": "string"
},
"thirdPartyAssurancesOfRecognisedSchemes": {
"type": "string"
},
"supplyChainIndices": {
"type": "string"
},
"batteryChemistry": {
"type": "string"
},
"criticalRawMaterials": {
"type": "string"
},
"nameOfTheCathodeAnodeElectrolyteMaterials": {
"type": "string"
},
"hazardousSubstances": {
"type": "string"
},
"impactSubstancesEnvironmentHumanHealthSafety": {
"type": "string"
},
"manualForDisassemblyAndDismantlingOfTheBatteryPack": {
"type": "string"
},
"partNumbersForComponents": {
"type": "string"
},
"informationOnSourcesOfSpareParts": {
"type": "string"
},
"safetyMeasures": {
"type": "string"
},
"preConsumerRecycledNickelSharePercent": {
"type": "number",
"format": "double"
},
"preConsumerRecycledCobaltSharePercent": {
"type": "number",
"format": "double"
},
"preConsumerRecycledLithiumSharePercent": {
"type": "number",
"format": "double"
},
"preConsumerRecycledLeadSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledNickelSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledCobaltSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledLithiumSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledLeadSharePercent": {
"type": "number",
"format": "double"
},
"renewableContentSharePercent": {
"type": "number",
"format": "double"
},
"informationOnTheRoleOfEndUsersInContributingToWastePrevention": {
"type": "string"
},
"informationOnTheRoleOfEndUsersInContributingToTheSeparateCollectionOfWasteBatteries": {
"type": "string"
},
"informationOnBatteryCollection": {
"type": "string"
},
"ratedCapacityAh": {
"type": "number",
"format": "double"
},
"remainingCapacityAh": {
"type": "number",
"format": "double"
},
"capacityFadePercent": {
"type": "number",
"format": "double"
},
"certifiedUsableBatteryEnergyKWh": {
"type": "number",
"format": "double"
},
"ubeMeasuredKWh": {
"type": "number",
"format": "double"
},
"socePercent": {
"type": "number",
"format": "double"
},
"socPercent": {
"type": "number",
"format": "double"
},
"minimumVoltageV": {
"type": "number",
"format": "double"
},
"maximumVoltageV": {
"type": "number",
"format": "double"
},
"nominalVoltageV": {
"type": "number",
"format": "double"
},
"originalPowerCapabilityW": {
"type": "number",
"format": "double"
},
"remainingPowerCapabilityW": {
"type": "number",
"format": "double"
},
"powerFadePercent": {
"type": "number",
"format": "double"
},
"maximumPermittedBatteryPowerW": {
"type": "number",
"format": "double"
},
"ratioBetweenNominalBatteryPowerAndBatteryEnergyWPerWh": {
"type": "number",
"format": "double"
},
"initialRoundTripEnergyEfficiencyPercent": {
"type": "number",
"format": "double"
},
"energyRoundTripEfficiencyAt50OfCycleLifePercent": {
"type": "number",
"format": "double"
},
"remainingRoundTripEnergyEfficiencyPercent": {
"type": "number",
"format": "double"
},
"energyRoundTripEfficiencyFadePercent": {
"type": "number",
"format": "double"
},
"initialSelfDischargeRatePercentPerMonth": {
"type": "number",
"format": "double"
},
"selfDischargingRatePercentPerMonth": {
"type": "number",
"format": "double"
},
"evolutionOfSelfDischargingRatesPercent": {
"type": "number",
"format": "double"
},
"moduleRecommendedOhm": {
"type": "number",
"format": "double"
},
"cellAndModuleRecommendedPercent": {
"type": "number",
"format": "double"
},
"expectedLifetimeInCalendarYearsYears": {
"type": "number",
"format": "double"
},
"expectedLifetimeNumberOfChargeDischargeCycles": {
"type": "number",
"format": "double"
},
"numberOfFullChargingAndDischargingCycles": {
"type": "number",
"format": "double"
},
"cycleLifeReferenceTest": {
"type": "string"
},
"cRateOfRelevantCycleLifeTestAPerAh": {
"type": "number",
"format": "double"
},
"energyThroughputKWh": {
"type": "number",
"format": "double"
},
"capacityThroughputAh": {
"type": "number",
"format": "double"
},
"capacityThresholdForExhaustionPercent": {
"type": "number",
"format": "double"
},
"temperatureInformationCelsius": {
"type": "number",
"format": "double"
},
"temperatureRangeIdleStateLowerBoundaryCelsius": {
"type": "number",
"format": "double"
},
"temperatureRangeIdleStateUpperBoundaryCelsius": {
"type": "number",
"format": "double"
},
"timeSpentInExtremeTemperaturesAboveBoundaryMinutes": {
"type": "number",
"format": "double"
},
"timeSpentInExtremeTemperaturesBelowBoundaryMinutes": {
"type": "number",
"format": "double"
},
"timeSpentChargingDuringExtremeTemperaturesAboveBoundaryMinutes": {
"type": "number",
"format": "double"
},
"timeSpentChargingDuringExtremeTemperaturesBelowBoundaryMinutes": {
"type": "number",
"format": "double"
},
"numberOfDeepDischargeEvents": {
"type": "number",
"format": "double"
},
"numberOfOverchargeEvents": {
"type": "number",
"format": "double"
},
"informationOnAccidents": {
"type": "string"
}
},
"additionalProperties": false
},
"EuBatteryPassportModel": {
"type": "object",
"properties": {
"manufacturerIdentifierAndInformation": {
"type": "string"
},
"manufacturingPlace": {
"type": "string"
},
"warrantyPeriodOfTheBattery": {
"type": "string",
"format": "date-time"
},
"batteryCategory": {
"type": "string"
},
"batteryMassKg": {
"type": "number",
"format": "double"
},
"separateCollectionSymbol": {
"type": "string"
},
"symbolsForCadmiumAndLead": {
"type": "string"
},
"carbonFootprintLabel": {
"type": "string"
},
"meaningOfLabelsAndSymbols": {
"type": "string"
},
"euDeclarationOfConformity": {
"type": "string"
},
"resultsOfTestReportsProvingCompliance": {
"type": "string"
},
"batteryCarbonFootprintPerFunctionalUnitKgCO2ePerkWh": {
"type": "number",
"format": "double"
},
"contributionOfRawMaterialAcquisitionAndPreProcessingLifecycleStagePercent": {
"type": "number",
"format": "double"
},
"shareBcfMainProductProductionPercent": {
"type": "number",
"format": "double"
},
"contributionOfDistributionLifecycleStagePercent": {
"type": "number",
"format": "double"
},
"contributionOfEndOfLifeAndRecyclingLifecycleStagePercent": {
"type": "number",
"format": "double"
},
"carbonFootprintPerformanceClass": {
"type": "string"
},
"webLinkToPublicCarbonFootprintStudy": {
"type": "string"
},
"generalBatteryAndManufacturerInformation": {
"type": "string"
},
"absoluteBatteryCarbonFootprintTCO2e": {
"type": "number",
"format": "double"
},
"informationOfDueDiligenceReport": {
"type": "string"
},
"thirdPartyAssurancesOfRecognisedSchemes": {
"type": "string"
},
"supplyChainIndices": {
"type": "string"
},
"batteryChemistry": {
"type": "string"
},
"criticalRawMaterials": {
"type": "string"
},
"nameOfTheCathodeAnodeElectrolyteMaterials": {
"type": "string"
},
"hazardousSubstances": {
"type": "string"
},
"impactSubstancesEnvironmentHumanHealthSafety": {
"type": "string"
},
"manualForDisassemblyAndDismantlingOfTheBatteryPack": {
"type": "string"
},
"partNumbersForComponents": {
"type": "string"
},
"informationOnSourcesOfSpareParts": {
"type": "string"
},
"safetyMeasures": {
"type": "string"
},
"preConsumerRecycledNickelSharePercent": {
"type": "number",
"format": "double"
},
"preConsumerRecycledCobaltSharePercent": {
"type": "number",
"format": "double"
},
"preConsumerRecycledLithiumSharePercent": {
"type": "number",
"format": "double"
},
"preConsumerRecycledLeadSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledNickelSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledCobaltSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledLithiumSharePercent": {
"type": "number",
"format": "double"
},
"postConsumerRecycledLeadSharePercent": {
"type": "number",
"format": "double"
},
"renewableContentSharePercent": {
"type": "number",
"format": "double"
},
"informationOnTheRoleOfEndUsersInContributingToWastePrevention": {
"type": "string"
},
"informationOnTheRoleOfEndUsersInContributingToTheSeparateCollectionOfWasteBatteries": {
"type": "string"
},
"informationOnBatteryCollection": {
"type": "string"
},
"ratedCapacityAh": {
"type": "number",
"format": "double"
},
"capacityFadePercent": {
"type": "number",
"format": "double"
},
"certifiedUsableBatteryEnergyKWh": {
"type": "number",
"format": "double"
},
"minimumVoltageV": {
"type": "number",
"format": "double"
},
"maximumVoltageV": {
"type": "number",
"format": "double"
},
"nominalVoltageV": {
"type": "number",
"format": "double"
},
"originalPowerCapabilityW": {
"type": "number",
"format": "double"
},
"powerFadePercent": {
"type": "number",
"format": "double"
},
"maximumPermittedBatteryPowerW": {
"type": "number",
"format": "double"
},
"ratioBetweenNominalBatteryPowerAndBatteryEnergyWPerWh": {
"type": "number",
"format": "double"
},
"initialRoundTripEnergyEfficiencyPercent": {
"type": "number",
"format": "double"
},
"energyRoundTripEfficiencyAt50OfCycleLifePercent": {
"type": "number",
"format": "double"
},
"energyRoundTripEfficiencyFadePercent": {
"type": "number",
"format": "double"
},
"initialSelfDischargeRatePercentPerMonth": {
"type": "number",
"format": "double"
},
"moduleRecommendedOhm": {
"type": "number",
"format": "double"
},
"cellAndModuleRecommendedPercent": {
"type": "number",
"format": "double"
},
"expectedLifetimeInCalendarYearsYears": {
"type": "number",
"format": "double"
},
"expectedLifetimeNumberOfChargeDischargeCycles": {
"type": "number",
"format": "double"
},
"cycleLifeReferenceTest": {
"type": "string"
},
"cRateOfRelevantCycleLifeTestAPerAh": {
"type": "number",
"format": "double"
},
"capacityThresholdForExhaustionPercent": {
"type": "number",
"format": "double"
},
"temperatureRangeIdleStateLowerBoundaryCelsius": {
"type": "number",
"format": "double"
},
"temperatureRangeIdleStateUpperBoundaryCelsius": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"EventTypes": {
"enum": [
"InstallBatteryInVehicle",
"RemoveBatteryFromVehicle",
"RepurposeBattery",
"ReManufactureBattery",
"WasteBattery"
],
"type": "string",
"description": "Represents the different event types for a battery's life cycle."
},
"FailedReason": {
"type": "object",
"properties": {
"reference": {
"type": "string"
},
"reason": {
"type": "string"
},
"code": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FailureDetail": {
"type": "object",
"properties": {
"propertyKey": {
"type": "string"
},
"description": {
"type": "string"
},
"code": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"IssueProductResponse": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"state": {
"$ref": "#/components/schemas/ProductIssuedState"
},
"version": {
"type": "integer",
"format": "int32"
},
"propertiesRequiringValue": {
"type": "array",
"items": {
"type": "string"
}
},
"validationIssues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FailureDetail"
}
}
},
"additionalProperties": false
},
"LifeCycleData": {
"type": "object",
"properties": {
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eventType": {
"$ref": "#/components/schemas/EventTypes"
},
"properties": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/StringSet"
},
{
"$ref": "#/components/schemas/UomSet"
},
{
"$ref": "#/components/schemas/LinkSet"
},
{
"$ref": "#/components/schemas/DateTimeSet"
},
{
"$ref": "#/components/schemas/NumericSet"
},
{
"$ref": "#/components/schemas/SelectManySet"
},
{
"$ref": "#/components/schemas/SelectOneSet"
},
{
"$ref": "#/components/schemas/LocationSet"
}
]
}
}
},
"additionalProperties": false
},
"LinkSection": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionBase"
}
],
"properties": {
"url": {
"type": "string"
}
},
"additionalProperties": false
},
"LinkSectionValue": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueBase"
}
],
"properties": {
"url": {
"type": "string"
}
},
"additionalProperties": false
},
"LinkSet": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithEffectiveFrom"
}
],
"properties": {
"url": {
"type": "string"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"LinkVal": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithTimestamp"
}
],
"properties": {
"url": {
"type": "string"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUpdated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"LocationSection": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionBase"
}
],
"properties": {
"countryCodes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"LocationSectionValue": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueBase"
}
],
"properties": {
"countryCodes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"LocationSet": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithEffectiveFrom"
}
],
"properties": {
"countryCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"LocationVal": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithTimestamp"
}
],
"properties": {
"countryCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUpdated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"NumericSection": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionBase"
}
],
"properties": {
"value": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"NumericSectionValue": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueBase"
}
],
"properties": {
"value": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"NumericSet": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithEffectiveFrom"
}
],
"properties": {
"value": {
"type": "number",
"format": "double"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"NumericVal": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithTimestamp"
}
],
"properties": {
"value": {
"type": "number",
"format": "double"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUpdated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"PartialScan": {
"type": "object",
"properties": {
"reference": {
"type": "string"
}
},
"additionalProperties": false
},
"PassportConfiguration": {
"type": "object",
"properties": {
"passportName": {
"type": "string"
},
"passportVersion": {
"type": "integer",
"format": "int32"
},
"templateKey": {
"type": "string"
},
"productKey": {
"type": "string"
}
},
"additionalProperties": false
},
"PostResponse": {
"type": "object",
"properties": {
"requestId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PreSignedUrlResult": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"method": {
"type": "string"
},
"requestId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": {}
},
"ProductIssuedState": {
"enum": [
"Draft",
"Issued"
],
"type": "string"
},
"ProductItemScaffoldResponse": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/Section"
},
{
"$ref": "#/components/schemas/UomSection"
},
{
"$ref": "#/components/schemas/StringSection"
},
{
"$ref": "#/components/schemas/LinkSection"
},
{
"$ref": "#/components/schemas/DateTimeSection"
},
{
"$ref": "#/components/schemas/NumericSection"
},
{
"$ref": "#/components/schemas/SelectManySection"
},
{
"$ref": "#/components/schemas/SelectOneSection"
},
{
"$ref": "#/components/schemas/LocationSection"
}
]
}
}
},
"additionalProperties": false
},
"ProductModel": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/Section"
},
{
"$ref": "#/components/schemas/UomSection"
},
{
"$ref": "#/components/schemas/StringSection"
},
{
"$ref": "#/components/schemas/LinkSection"
},
{
"$ref": "#/components/schemas/DateTimeSection"
},
{
"$ref": "#/components/schemas/NumericSection"
},
{
"$ref": "#/components/schemas/SelectManySection"
},
{
"$ref": "#/components/schemas/SelectOneSection"
},
{
"$ref": "#/components/schemas/LocationSection"
}
]
}
},
"version": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProductModelKeyAndName": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "",
"example": "battery_0001"
},
"name": {
"type": "string",
"description": "",
"example": "RWD Battery Pack"
}
},
"additionalProperties": false,
"description": "Key and name of a product model"
},
"RecordFailure": {
"type": "object",
"properties": {
"reference": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"additionalProperties": false
},
"ScanRequestV3": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "The unique identifier for the scan.",
"example": "ABC0000101010"
},
"timeStamp": {
"type": "string",
"description": "Date and time of the current scan in ISO 8601 format",
"format": "date-time"
},
"dcpKey": {
"type": "string",
"description": "Specific data collection point key",
"example": "GIN_1001000"
},
"productModelKey": {
"type": "string",
"description": "Each product has a specific product model key. Please use this key here. Keys will be provided my circulor",
"example": "PRD_0001"
},
"supplierKey": {
"type": "string",
"description": "Company key for whom the material are processed (when known). This field is required for all \"goods out\" scans.",
"nullable": true,
"example": "CMP_0001"
},
"clientKey": {
"type": "string",
"description": "Company key for whom the material are processed (when known). This field is generally required for all \"goods in\" scans.",
"nullable": true,
"example": "CMP_0002"
},
"parents": {
"type": "array",
"items": {
"type": "string"
},
"description": "The scanReference of the parent material or constituent components (single or multiple) from the immediately\npreceding process Step.",
"nullable": true,
"example": [
"ABC000010000"
]
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attribute"
},
"description": "Additional attributes of the scanReference item or parentReference item. Defined as an array of Key Value pairs -\neg. Gross Weight, Material Content (eg. Nickel / Cobalt / Lithium Content: percentage or weight value), Part Number,\nPart Description, Serial Number, etc.",
"nullable": true,
"example": [
{
"key": "Gross Weight",
"value": "12.1"
}
]
}
},
"additionalProperties": false,
"description": "Contains all scan date for single scan."
},
"ScanStatus": {
"type": "object",
"properties": {
"state": {
"$ref": "#/components/schemas/States"
},
"requestId": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string",
"nullable": true
},
"processed": {
"type": "integer",
"format": "int32",
"nullable": true
},
"failed": {
"type": "integer",
"format": "int32",
"nullable": true
},
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordFailure"
},
"nullable": true
}
},
"additionalProperties": false
},
"Section": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionBase"
}
],
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/Section"
},
{
"$ref": "#/components/schemas/UomSection"
},
{
"$ref": "#/components/schemas/StringSection"
},
{
"$ref": "#/components/schemas/LinkSection"
},
{
"$ref": "#/components/schemas/DateTimeSection"
},
{
"$ref": "#/components/schemas/NumericSection"
},
{
"$ref": "#/components/schemas/SelectManySection"
},
{
"$ref": "#/components/schemas/SelectOneSection"
},
{
"$ref": "#/components/schemas/LocationSection"
}
]
}
}
},
"additionalProperties": false
},
"SectionBase": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "type",
"mapping": {
"section": "#/components/schemas/Section",
"uom": "#/components/schemas/UomSection",
"string": "#/components/schemas/StringSection",
"link": "#/components/schemas/LinkSection",
"dateTime": "#/components/schemas/DateTimeSection",
"numeric": "#/components/schemas/NumericSection",
"oneOrMoreOf": "#/components/schemas/SelectManySection",
"oneOf": "#/components/schemas/SelectOneSection",
"location": "#/components/schemas/LocationSection"
}
}
},
"SectionValue": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueBase"
}
],
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/SectionValue"
},
{
"$ref": "#/components/schemas/StringSectionValue"
},
{
"$ref": "#/components/schemas/UomSectionValue"
},
{
"$ref": "#/components/schemas/LinkSectionValue"
},
{
"$ref": "#/components/schemas/DateTimeSectionValue"
},
{
"$ref": "#/components/schemas/NumericSectionValue"
},
{
"$ref": "#/components/schemas/SelectManySectionValue"
},
{
"$ref": "#/components/schemas/SelectOneSectionValue"
},
{
"$ref": "#/components/schemas/LocationSectionValue"
}
]
}
}
},
"additionalProperties": false
},
"SectionValueBase": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "type",
"mapping": {
"section": "#/components/schemas/SectionValue",
"string": "#/components/schemas/StringSectionValue",
"uom": "#/components/schemas/UomSectionValue",
"link": "#/components/schemas/LinkSectionValue",
"dateTime": "#/components/schemas/DateTimeSectionValue",
"numeric": "#/components/schemas/NumericSectionValue",
"oneOrMoreOf": "#/components/schemas/SelectManySectionValue",
"oneOf": "#/components/schemas/SelectOneSectionValue",
"location": "#/components/schemas/LocationSectionValue"
}
}
},
"SectionValueWithEffectiveFrom": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "type",
"mapping": {
"string": "#/components/schemas/StringSet",
"uom": "#/components/schemas/UomSet",
"link": "#/components/schemas/LinkSet",
"dateTime": "#/components/schemas/DateTimeSet",
"numeric": "#/components/schemas/NumericSet",
"oneOrMoreOf": "#/components/schemas/SelectManySet",
"oneOf": "#/components/schemas/SelectOneSet",
"location": "#/components/schemas/LocationSet"
}
}
},
"SectionValueWithTimestamp": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUpdated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "type",
"mapping": {
"string": "#/components/schemas/StringVal",
"uom": "#/components/schemas/UomVal",
"link": "#/components/schemas/LinkVal",
"dateTime": "#/components/schemas/DateTimeVal",
"numeric": "#/components/schemas/NumericVal",
"oneOrMoreOf": "#/components/schemas/SelectManyVal",
"oneOf": "#/components/schemas/SelectOneVal",
"location": "#/components/schemas/LocationVal"
}
}
},
"SelectManySection": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionBase"
}
],
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"oneOrMoreOf": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"SelectManySectionValue": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueBase"
}
],
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"SelectManySet": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithEffectiveFrom"
}
],
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"SelectManyVal": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithTimestamp"
}
],
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUpdated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"SelectOneSection": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionBase"
}
],
"properties": {
"value": {
"type": "string"
},
"oneOf": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"SelectOneSectionValue": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueBase"
}
],
"properties": {
"value": {
"type": "string"
}
},
"additionalProperties": false
},
"SelectOneSet": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithEffectiveFrom"
}
],
"properties": {
"value": {
"type": "string"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"SelectOneVal": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithTimestamp"
}
],
"properties": {
"value": {
"type": "string"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUpdated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"States": {
"enum": [
"Received",
"InProgress",
"Success",
"Failed",
"HasFailures",
"NotFound"
],
"type": "string"
},
"StaticDataModel": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/SectionValue"
},
{
"$ref": "#/components/schemas/StringSectionValue"
},
{
"$ref": "#/components/schemas/UomSectionValue"
},
{
"$ref": "#/components/schemas/LinkSectionValue"
},
{
"$ref": "#/components/schemas/DateTimeSectionValue"
},
{
"$ref": "#/components/schemas/NumericSectionValue"
},
{
"$ref": "#/components/schemas/SelectManySectionValue"
},
{
"$ref": "#/components/schemas/SelectOneSectionValue"
},
{
"$ref": "#/components/schemas/LocationSectionValue"
}
]
}
}
},
"additionalProperties": false
},
"StatusGuidResponse": {
"type": "object",
"properties": {
"state": {
"$ref": "#/components/schemas/AllowedStates"
},
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FailedReason"
},
"nullable": true
},
"requestId": {
"type": "string"
}
},
"additionalProperties": false
},
"StatusResponse": {
"type": "object",
"properties": {
"state": {
"$ref": "#/components/schemas/AllowedStates"
},
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FailedReason"
},
"nullable": true
},
"requestId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"StringSection": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionBase"
}
],
"properties": {
"value": {
"type": "string"
}
},
"additionalProperties": false
},
"StringSectionValue": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueBase"
}
],
"properties": {
"value": {
"type": "string"
}
},
"additionalProperties": false
},
"StringSet": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithEffectiveFrom"
}
],
"properties": {
"value": {
"type": "string"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"StringVal": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithTimestamp"
}
],
"properties": {
"value": {
"type": "string"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUpdated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"UomSection": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionBase"
}
],
"properties": {
"value": {
"type": "number",
"format": "double"
},
"uom": {
"type": "string"
},
"valueReference": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UomSectionValue": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueBase"
}
],
"properties": {
"value": {
"type": "number",
"format": "double"
},
"uom": {
"type": "string"
},
"detail": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UomSet": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithEffectiveFrom"
}
],
"properties": {
"value": {
"type": "number",
"format": "double"
},
"uom": {
"type": "string"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UomVal": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SectionValueWithTimestamp"
}
],
"properties": {
"value": {
"type": "number",
"format": "double"
},
"uom": {
"type": "string"
},
"effectiveFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUpdated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"UploadResult": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"additionalProperties": false
},
"ValidationResponse": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"state": {
"$ref": "#/components/schemas/ProductIssuedState"
},
"version": {
"type": "integer",
"format": "int32"
},
"propertiesRequiringValue": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"WithDate": {
"type": "object",
"properties": {
"timeStamp": {
"type": "string",
"format": "date-time"
},
"value": {
"oneOf": [
{
"$ref": "#/components/schemas/StringSet"
},
{
"$ref": "#/components/schemas/UomSet"
},
{
"$ref": "#/components/schemas/LinkSet"
},
{
"$ref": "#/components/schemas/DateTimeSet"
},
{
"$ref": "#/components/schemas/NumericSet"
},
{
"$ref": "#/components/schemas/SelectManySet"
},
{
"$ref": "#/components/schemas/SelectOneSet"
},
{
"$ref": "#/components/schemas/LocationSet"
}
]
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://uat.auth.circulor.io/oauth2/token",
"scopes": {}
}
}
}
}
},
"servers": [
{
"url": "https://uat.api.circulor.io",
"description": "Development server"
},
{
"url": "https://uat.api.circulor.io",
"description": "UAT server"
},
{
"url": "https://demo.api.circulor.io",
"description": "Demo server"
},
{
"url": "https://api.circulor.io",
"description": "Production server"
}
]
}