InControl v4.6 API Changelog

November 2024

Julian Ares

Last Update منذ ١٧ يومًا

This release includes schema updates to both the Management API and Driver API that improve accuracy, enable new features, and retire deprecated fields.

🔴 Breaking Changes (Action Required)


These changes may cause errors if your current integration relies on affected fields or data types. Please review and update accordingly.

Management API Breaking Changes
Object/Field/TypeChange Description
AggregatedStatisticsReportFilterType removed
AggregatedTransaction.totalCostChanged type from Decimal to Int
ChargerStatisticsFilter.datetimeRangeChanged type from Datetimerange! to DatetimerangeWithTimezone!
ConnectorModelParamsAdded input field liquidCooling
ConsumptionRateBandRemoved field displayName
ConsumptionRateBandInputRemoved input field displayName, Added input field fullDisplayName
FilterByChargerState.datetimeRangeChanged type from Datetimerange! to DatetimerangeWithTimezone!
FinancialReport.ocppTransactionIdChanged type from IntId to String
RootMutationType.chargerStatesStatisticsExport.filterChanged type from AggregatedStatisticsReportFilter! to ChargerStatisticsFilter!
RootMutationType.moveChargersHistoryRemoved argument includeRedshift: Boolean
RootQueryType.applicationsRemoved argument searchValue: String
RootQueryType.chargerStatesStatisticsReport.filterChanged type from AggregatedStatisticsReportFilter! to ChargerStatisticsFilter!
RootQueryType.transactionsReportRedshift.orderByChanged type from TransactionOrderByParams to TransactionRedshiftOrderByParams
RootQueryType.utilityRates.searchValueChanged type from String to TrimmedString
Transaction.ocppTransactionIdChanged type from Int! to String!
Transaction.siteChanged type from Site to VariedAccessSite!
Transaction.totalCostChanged type from Decimal to Int
TransactionReport.totalCostChanged type from Decimal to Int
UtilityRateConsumptionRateBandRequiredStringFields EnumRemoved enum value DISPLAY_NAME
Driver API Breaking Changes
Object/Field/TypeChange Description
Transaction.ocppTransactionIdChanged type from Int! to String!

⚠️ Potential Issues


These changes add new fields or enum values and may affect optional parameters or response structures.

Management API Potential Issues
Object/Field/TypeChange Description
ChargerExportColumn EnumAdded enum values CONFIG_TEMPLATE_NAME, POWER_CABINET_NAME
ChargerStatesExportColumn EnumAdded enum values CHARGER_NAME, CHARGER_SERIAL_NUMBER
ChargerType EnumAdded enum value DC_DISPENSER
ConsumptionRateBandInputAdded input field shortDisplayName
CreateTransactionAuthorizationArgValidationProblem UnionAdded members CreateTransactionAuthorizationNullForbidReasonForAllowCheckConstraintProblem, CreateTransactionAuthorizationNullGroupIdAuthorizationKeyForForbidCheckConstraintProblem
ExportType EnumAdded enum values EVE_TRANSACTIONS, POWER_CABINETS
FilterByApplication.withSubAccountsDefault value changed from undefined to true
FilterType EnumAdded enum value SPLIT_SYSTEM
IssueSectionVendor EnumAdded enum value ZEROVA
NotableType EnumAdded enum value POWER_CABINET
ObjectClases EnumAdded enum value POWER_CABINET
RootMutationType.chargersExportAdded argument powerCabinetSearchValue: TrimmedString
RootMutationType.createChargerAdded argument eveState: EveStateInput
RootMutationType.createTransactionAuthorizationAdded arguments forbidReason: TransactionAuthorizationForbidReason, groupIdAuthorizationKey: String
RootMutationType.createTransactionAuthorizationWithTypedErrorsAdded argument groupIdAuthorizationKey: String
RootMutationType.updateChargerAdded argument eveState: EveStateInput
RootMutationType.updateTransactionAuthorizationAdded arguments forbidReason: TransactionAuthorizationForbidReason, groupIdAuthorizationKey: String
RootMutationType.updateTransactionAuthorizationWithTypedErrorsAdded arguments forbidReason: TransactionAuthorizationForbidReason, groupIdAuthorizationKey: String
RootQueryType.applicationsAdded argument search: SearchByApplication
RootQueryType.chargersAdded argument powerCabinetSearchValue: TrimmedString
RootQueryType.clusteredChargersAdded argument powerCabinetSearchValue: TrimmedString
RootQueryType.transactionStatisticsAdded argument orderBy: TransactionStatisticOrderByParams
RootQueryType.utilityRatesAdded argument filter: FilterByUtilityRate
TagEntityModel UnionAdded member PowerCabinet
TransactionOrderByFields EnumAdded enum value PEAK_CHARGING_POWER
UpdateTransactionAuthorizationArgValidationProblem UnionAdded members UpdateTransactionAuthorizationNullForbidReasonForAllowCheckConstraintProblem, UpdateTransactionAuthorizationNullGroupIdAuthorizationKeyForForbidCheckConstraintProblem
UtilityRateConsumptionRateBandRequiredStringFields EnumAdded enum value FULL_DISPLAY_NAME

✅ Safe Changes


These changes include additions, deprecations, or description updates that are backward-compatible and should not break existing implementations.

Management API Safe Changes
Object/Field/TypeChange Description
ApplicationSearchableFieldsType added
AssetUpdatesParamsType added
ChargerAdded fields eveState, powerCabinet
ChargerConnector.lastTransactionDescription updated for clarity
ChargerEveSettingType added
ChargerEveStateType added
ChargerModelAdded field ocppVersion
ChargerPowerCabinetType added
ChargerPowerCabinetDispenserType added
ChargerResetTypeType added 
ChargerStatisticsFilterDescription updated for clarification
ChargingStationOnboardingModeType added
ConnectorModelChargerModelAdded field liquidCooling
ConsumptionRateBandAdded fields fullDisplayName, shortDisplayName
CreatePowerCabinetInputType added
CreateTransactionAuthorizationNullForbidReasonForAllowCheckConstraintProblemType added
CreateTransactionAuthorizationNullGroupIdAuthorizationKeyForForbidCheckConstraintProblemType added
EssentialChargerAssetType added
EssentialChargerConnectorType added
EssentialEvccidType added
EssentialTransaction Type added 
EssentialVehicleAssetType added
EveChargerTransactionsRefreshType added
EveSetting Type added
EveSettingsInputType added 
EveStateType added 
EveStateInputType added 
EveTransactionType added 
EveTransactionExportColumnType added 
EveTransactionOrderByFieldsType added
EveTransactionOrderByParamsType added 
FilterByEveTransactionType added 
FilterByPowerCabinetType added 
FilterByUtilityRateType added 
InaccessibleSiteType added
InputUpdatableLinkType added
ModelPowerRangeType added
OcppVersionType added 
PaginatedEveTransactionsType added 
PaginatedPowerCabinetModelsType added 
PaginatedPowerCabinetsType added 
PowerCabinetType added 
PowerCabinetExportColumnType added 
PowerCabinetModelType added 
PowerCabinetOrderByFieldsType added
PowerCabinetOrderByParamsType added
PowerCabinetWarrantyType added
PowerCabinetWarrantyInputType added 
RootMutationTypeAdded fields: createPowerCabinet, createPowerCabinetModel, deletePowerCabinet, deletePowerCabinetModel, eveTransactionsExport, fetchEveState, fetchEveTransactions, forceSetSecurityProfile, linkDispenserToPowerCabinet, powerCabinetsExport, resetCharger, resetOnboardingStatus, unlinkDispenserFromPowerCabinet, updateEveSetting, updateEveState, updatePowerCabinet, updatePowerCabinetModel
RootQueryTypeAdded fields: eveTransactions, powerCabinet, powerCabinetModel, powerCabinetModels, powerCabinets
RootSubscriptionType.assetUpdatesField deprecated with reason: “Please use chargerAssetUpdates and vehicleAssetUpdates instead”
RootSubscriptionTypeAdded fields: chargerAssetUpdates, eveTransactionAdded, vehicleAssetUpdates
SearchByApplicationType added
SettingUpdateResultType added
SiteAdded field powerCabinets
TransactionAuthorizationAdded fields: forbidReason, groupIdAuthorizationKey
TransactionAuthorizationForbidReasonType added
TransactionRedshiftOrderByFieldsType added
TransactionRedshiftOrderByParamsType added
TransactionStatisticOrderByFieldsType added
TransactionStatisticOrderByParamsType added
TrimmedStringType added
UpdatePowerCabinetInputType added
UpdateTransactionAuthorizationNullForbidReasonForAllowCheckConstraintProblemType added 
UpdateTransactionAuthorizationNullGroupIdAuthorizationKeyForForbidCheckConstraintProblem Type added 
VariedAccessSiteType added
Driver API Safe Changes
Object/Field/TypeChange Description
ChargerAdded field commonStatus
CommonStatusType added

Was this article helpful?

0 out of 0 liked this article

Still need help? Message Us