| POST | /optimizer/ftm | ||
|---|---|---|---|
| POST | /optimizer/common |
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class CommonOptimizerRequest extends CommonOptimizerPortalRequestBase
{
}
public static class CommonOptimizerPortalRequestBase
{
public UUID projectId = null;
public Boolean isBatchSimulation = null;
public Boolean force = null;
public Boolean disableEBSSpot = null;
public Boolean isServerless = null;
public UUID apiActionId = null;
public Integer nodeId = null;
public Integer parallelProject = null;
public Integer parallelYears = null;
public Integer ensureExlusive = null;
public UUID getProjectId() { return projectId; }
public CommonOptimizerPortalRequestBase setProjectId(UUID value) { this.projectId = value; return this; }
public Boolean getIsBatchSimulation() { return isBatchSimulation; }
public CommonOptimizerPortalRequestBase setIsBatchSimulation(Boolean value) { this.isBatchSimulation = value; return this; }
public Boolean isForce() { return force; }
public CommonOptimizerPortalRequestBase setForce(Boolean value) { this.force = value; return this; }
public Boolean isDisableEBSSpot() { return disableEBSSpot; }
public CommonOptimizerPortalRequestBase setDisableEBSSpot(Boolean value) { this.disableEBSSpot = value; return this; }
public Boolean getIsServerless() { return isServerless; }
public CommonOptimizerPortalRequestBase setIsServerless(Boolean value) { this.isServerless = value; return this; }
public UUID getApiActionId() { return apiActionId; }
public CommonOptimizerPortalRequestBase setApiActionId(UUID value) { this.apiActionId = value; return this; }
public Integer getNodeId() { return nodeId; }
public CommonOptimizerPortalRequestBase setNodeId(Integer value) { this.nodeId = value; return this; }
public Integer getParallelProject() { return parallelProject; }
public CommonOptimizerPortalRequestBase setParallelProject(Integer value) { this.parallelProject = value; return this; }
public Integer getParallelYears() { return parallelYears; }
public CommonOptimizerPortalRequestBase setParallelYears(Integer value) { this.parallelYears = value; return this; }
public Integer getEnsureExlusive() { return ensureExlusive; }
public CommonOptimizerPortalRequestBase setEnsureExlusive(Integer value) { this.ensureExlusive = value; return this; }
}
public static class CommonOptimizerResponse
{
public ApiResponseStatus status = null;
public String message = null;
public UUID apiActionId = null;
public String detail = null;
public ArrayList<BatteryProjectForOptimizer> items = null;
public ApiResponseStatus getStatus() { return status; }
public CommonOptimizerResponse setStatus(ApiResponseStatus value) { this.status = value; return this; }
public String getMessage() { return message; }
public CommonOptimizerResponse setMessage(String value) { this.message = value; return this; }
public UUID getApiActionId() { return apiActionId; }
public CommonOptimizerResponse setApiActionId(UUID value) { this.apiActionId = value; return this; }
public String getDetail() { return detail; }
public CommonOptimizerResponse setDetail(String value) { this.detail = value; return this; }
public ArrayList<BatteryProjectForOptimizer> getItems() { return items; }
public CommonOptimizerResponse setItems(ArrayList<BatteryProjectForOptimizer> value) { this.items = value; return this; }
}
public static enum ApiResponseStatus
{
Undefined(0),
Success(1),
Pending(10),
Failed(100);
private final int value;
ApiResponseStatus(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static class BatteryProjectForOptimizer
{
public UUID projectId = null;
public String version = null;
public UUID baseId = null;
public Integer altId = null;
public BatterySimulationType simulationType = null;
public BatteryProjectGroup projectGroup = null;
public BatteryProjectAction projectAction = null;
public DataProvider iso = null;
public String name = null;
public Integer baseNodeId = null;
public Integer orgNodeId = null;
public Integer baseZoneId = null;
public BatteryDataSoruce dataSource = null;
public PriceMarketType baseMarket = null;
public TimeGranularity priceGranularity = null;
public Date startDate = null;
public Date endDate = null;
public BigDecimal batteryCapacity = null;
public BigDecimal interconnectionLimit = null;
public BigDecimal namepaletCapacity = null;
@Ignore()
public BigDecimal chargeDischargeLimit = null;
@Ignore()
public BigDecimal baseCapacityRate = null;
@Ignore()
public BigDecimal capacityRate = null;
public BigDecimal chargeEfficiency = null;
public BigDecimal disChargeEfficiency = null;
public BigDecimal paraciticLossesOperation = null;
public BigDecimal paraciticLossesResting = null;
public BigDecimal hvacLosses = null;
public BigDecimal acCablingLosses = null;
public BigDecimal transformatorLosses = null;
public BigDecimal thermalLosses = null;
public BigDecimal otherLosses = null;
public BooleanValue useEnergy = null;
public BooleanValue useCapacity = null;
public CapacityMethod capacityBasis = null;
public BigDecimal capacityPayment = null;
public BigDecimal netCapacityFactor = null;
public BooleanValue useAncillary = null;
public BatteryProductionDataSource productionDataSource = null;
public PowerPlantType powerPlantType = null;
public BigDecimal solarAcCapacity = null;
public BigDecimal solarDcCapacity = null;
public BigDecimal windAcCapacity = null;
@Ignore()
public BigDecimal solarCapacityRate = null;
@Ignore()
public BigDecimal windCapacityRate = null;
public Integer status = null;
public Integer simulationStatus = null;
public Date lastSimulationDate = null;
public Date dataStartDate = null;
public Date dataEndDate = null;
public Integer solarId = null;
public Integer windId = null;
public Integer lmpFileId = null;
public Integer productionFileId = null;
public Integer loadFileId = null;
public Integer capacityFileId = null;
public Integer nodeAltId = null;
public Integer nodeRefId = null;
public BigDecimal useRegup = null;
public BigDecimal useRegdown = null;
public BigDecimal useSpinning = null;
public BigDecimal useNonSpinning = null;
public BigDecimal solarDegredation = null;
public BigDecimal batteryDegredation = null;
public BigDecimal augmentation = null;
public BigDecimal augmentationFrequency = null;
public BigDecimal energyIncrement = null;
public BigDecimal ancillaryIncrement = null;
public Integer enableGridArbitrage = null;
public Integer incrementReferanceYear = null;
public Integer representativeYear = null;
public Integer useFutureData = null;
public BigDecimal maxDailyCycle = null;
public BigDecimal minDailyProfitPerMw = null;
public Integer ancillaryFileId = null;
public BigDecimal maxChargingPriceCap = null;
public BigDecimal maxDischargingPriceCap = null;
public BigDecimal maxAncillaryPriceCap = null;
public RevenueStackingMode revenueStackingMode = null;
public Integer optimizationQuality = null;
public Boolean useInternalSolver = null;
public UUID getProjectId() { return projectId; }
public BatteryProjectForOptimizer setProjectId(UUID value) { this.projectId = value; return this; }
public String getVersion() { return version; }
public BatteryProjectForOptimizer setVersion(String value) { this.version = value; return this; }
public UUID getBaseId() { return baseId; }
public BatteryProjectForOptimizer setBaseId(UUID value) { this.baseId = value; return this; }
public Integer getAltId() { return altId; }
public BatteryProjectForOptimizer setAltId(Integer value) { this.altId = value; return this; }
public BatterySimulationType getSimulationType() { return simulationType; }
public BatteryProjectForOptimizer setSimulationType(BatterySimulationType value) { this.simulationType = value; return this; }
public BatteryProjectGroup getProjectGroup() { return projectGroup; }
public BatteryProjectForOptimizer setProjectGroup(BatteryProjectGroup value) { this.projectGroup = value; return this; }
public BatteryProjectAction getProjectAction() { return projectAction; }
public BatteryProjectForOptimizer setProjectAction(BatteryProjectAction value) { this.projectAction = value; return this; }
public DataProvider getIso() { return iso; }
public BatteryProjectForOptimizer setIso(DataProvider value) { this.iso = value; return this; }
public String getName() { return name; }
public BatteryProjectForOptimizer setName(String value) { this.name = value; return this; }
public Integer getBaseNodeId() { return baseNodeId; }
public BatteryProjectForOptimizer setBaseNodeId(Integer value) { this.baseNodeId = value; return this; }
public Integer getOrgNodeId() { return orgNodeId; }
public BatteryProjectForOptimizer setOrgNodeId(Integer value) { this.orgNodeId = value; return this; }
public Integer getBaseZoneId() { return baseZoneId; }
public BatteryProjectForOptimizer setBaseZoneId(Integer value) { this.baseZoneId = value; return this; }
public BatteryDataSoruce getDataSource() { return dataSource; }
public BatteryProjectForOptimizer setDataSource(BatteryDataSoruce value) { this.dataSource = value; return this; }
public PriceMarketType getBaseMarket() { return baseMarket; }
public BatteryProjectForOptimizer setBaseMarket(PriceMarketType value) { this.baseMarket = value; return this; }
public TimeGranularity getPriceGranularity() { return priceGranularity; }
public BatteryProjectForOptimizer setPriceGranularity(TimeGranularity value) { this.priceGranularity = value; return this; }
public Date getStartDate() { return startDate; }
public BatteryProjectForOptimizer setStartDate(Date value) { this.startDate = value; return this; }
public Date getEndDate() { return endDate; }
public BatteryProjectForOptimizer setEndDate(Date value) { this.endDate = value; return this; }
public BigDecimal getBatteryCapacity() { return batteryCapacity; }
public BatteryProjectForOptimizer setBatteryCapacity(BigDecimal value) { this.batteryCapacity = value; return this; }
public BigDecimal getInterconnectionLimit() { return interconnectionLimit; }
public BatteryProjectForOptimizer setInterconnectionLimit(BigDecimal value) { this.interconnectionLimit = value; return this; }
public BigDecimal getNamepaletCapacity() { return namepaletCapacity; }
public BatteryProjectForOptimizer setNamepaletCapacity(BigDecimal value) { this.namepaletCapacity = value; return this; }
public BigDecimal getChargeDischargeLimit() { return chargeDischargeLimit; }
public BatteryProjectForOptimizer setChargeDischargeLimit(BigDecimal value) { this.chargeDischargeLimit = value; return this; }
public BigDecimal getBaseCapacityRate() { return baseCapacityRate; }
public BatteryProjectForOptimizer setBaseCapacityRate(BigDecimal value) { this.baseCapacityRate = value; return this; }
public BigDecimal getCapacityRate() { return capacityRate; }
public BatteryProjectForOptimizer setCapacityRate(BigDecimal value) { this.capacityRate = value; return this; }
public BigDecimal getChargeEfficiency() { return chargeEfficiency; }
public BatteryProjectForOptimizer setChargeEfficiency(BigDecimal value) { this.chargeEfficiency = value; return this; }
public BigDecimal getDisChargeEfficiency() { return disChargeEfficiency; }
public BatteryProjectForOptimizer setDisChargeEfficiency(BigDecimal value) { this.disChargeEfficiency = value; return this; }
public BigDecimal getParaciticLossesOperation() { return paraciticLossesOperation; }
public BatteryProjectForOptimizer setParaciticLossesOperation(BigDecimal value) { this.paraciticLossesOperation = value; return this; }
public BigDecimal getParaciticLossesResting() { return paraciticLossesResting; }
public BatteryProjectForOptimizer setParaciticLossesResting(BigDecimal value) { this.paraciticLossesResting = value; return this; }
public BigDecimal getHvacLosses() { return hvacLosses; }
public BatteryProjectForOptimizer setHvacLosses(BigDecimal value) { this.hvacLosses = value; return this; }
public BigDecimal getAcCablingLosses() { return acCablingLosses; }
public BatteryProjectForOptimizer setAcCablingLosses(BigDecimal value) { this.acCablingLosses = value; return this; }
public BigDecimal getTransformatorLosses() { return transformatorLosses; }
public BatteryProjectForOptimizer setTransformatorLosses(BigDecimal value) { this.transformatorLosses = value; return this; }
public BigDecimal getThermalLosses() { return thermalLosses; }
public BatteryProjectForOptimizer setThermalLosses(BigDecimal value) { this.thermalLosses = value; return this; }
public BigDecimal getOtherLosses() { return otherLosses; }
public BatteryProjectForOptimizer setOtherLosses(BigDecimal value) { this.otherLosses = value; return this; }
public BooleanValue isUseEnergy() { return useEnergy; }
public BatteryProjectForOptimizer setUseEnergy(BooleanValue value) { this.useEnergy = value; return this; }
public BooleanValue isUseCapacity() { return useCapacity; }
public BatteryProjectForOptimizer setUseCapacity(BooleanValue value) { this.useCapacity = value; return this; }
public CapacityMethod getCapacityBasis() { return capacityBasis; }
public BatteryProjectForOptimizer setCapacityBasis(CapacityMethod value) { this.capacityBasis = value; return this; }
public BigDecimal getCapacityPayment() { return capacityPayment; }
public BatteryProjectForOptimizer setCapacityPayment(BigDecimal value) { this.capacityPayment = value; return this; }
public BigDecimal getNetCapacityFactor() { return netCapacityFactor; }
public BatteryProjectForOptimizer setNetCapacityFactor(BigDecimal value) { this.netCapacityFactor = value; return this; }
public BooleanValue isUseAncillary() { return useAncillary; }
public BatteryProjectForOptimizer setUseAncillary(BooleanValue value) { this.useAncillary = value; return this; }
public BatteryProductionDataSource getProductionDataSource() { return productionDataSource; }
public BatteryProjectForOptimizer setProductionDataSource(BatteryProductionDataSource value) { this.productionDataSource = value; return this; }
public PowerPlantType getPowerPlantType() { return powerPlantType; }
public BatteryProjectForOptimizer setPowerPlantType(PowerPlantType value) { this.powerPlantType = value; return this; }
public BigDecimal getSolarAcCapacity() { return solarAcCapacity; }
public BatteryProjectForOptimizer setSolarAcCapacity(BigDecimal value) { this.solarAcCapacity = value; return this; }
public BigDecimal getSolarDcCapacity() { return solarDcCapacity; }
public BatteryProjectForOptimizer setSolarDcCapacity(BigDecimal value) { this.solarDcCapacity = value; return this; }
public BigDecimal getWindAcCapacity() { return windAcCapacity; }
public BatteryProjectForOptimizer setWindAcCapacity(BigDecimal value) { this.windAcCapacity = value; return this; }
public BigDecimal getSolarCapacityRate() { return solarCapacityRate; }
public BatteryProjectForOptimizer setSolarCapacityRate(BigDecimal value) { this.solarCapacityRate = value; return this; }
public BigDecimal getWindCapacityRate() { return windCapacityRate; }
public BatteryProjectForOptimizer setWindCapacityRate(BigDecimal value) { this.windCapacityRate = value; return this; }
public Integer getStatus() { return status; }
public BatteryProjectForOptimizer setStatus(Integer value) { this.status = value; return this; }
public Integer getSimulationStatus() { return simulationStatus; }
public BatteryProjectForOptimizer setSimulationStatus(Integer value) { this.simulationStatus = value; return this; }
public Date getLastSimulationDate() { return lastSimulationDate; }
public BatteryProjectForOptimizer setLastSimulationDate(Date value) { this.lastSimulationDate = value; return this; }
public Date getDataStartDate() { return dataStartDate; }
public BatteryProjectForOptimizer setDataStartDate(Date value) { this.dataStartDate = value; return this; }
public Date getDataEndDate() { return dataEndDate; }
public BatteryProjectForOptimizer setDataEndDate(Date value) { this.dataEndDate = value; return this; }
public Integer getSolarId() { return solarId; }
public BatteryProjectForOptimizer setSolarId(Integer value) { this.solarId = value; return this; }
public Integer getWindId() { return windId; }
public BatteryProjectForOptimizer setWindId(Integer value) { this.windId = value; return this; }
public Integer getLmpFileId() { return lmpFileId; }
public BatteryProjectForOptimizer setLmpFileId(Integer value) { this.lmpFileId = value; return this; }
public Integer getProductionFileId() { return productionFileId; }
public BatteryProjectForOptimizer setProductionFileId(Integer value) { this.productionFileId = value; return this; }
public Integer getLoadFileId() { return loadFileId; }
public BatteryProjectForOptimizer setLoadFileId(Integer value) { this.loadFileId = value; return this; }
public Integer getCapacityFileId() { return capacityFileId; }
public BatteryProjectForOptimizer setCapacityFileId(Integer value) { this.capacityFileId = value; return this; }
public Integer getNodeAltId() { return nodeAltId; }
public BatteryProjectForOptimizer setNodeAltId(Integer value) { this.nodeAltId = value; return this; }
public Integer getNodeRefId() { return nodeRefId; }
public BatteryProjectForOptimizer setNodeRefId(Integer value) { this.nodeRefId = value; return this; }
public BigDecimal getUseRegup() { return useRegup; }
public BatteryProjectForOptimizer setUseRegup(BigDecimal value) { this.useRegup = value; return this; }
public BigDecimal getUseRegdown() { return useRegdown; }
public BatteryProjectForOptimizer setUseRegdown(BigDecimal value) { this.useRegdown = value; return this; }
public BigDecimal getUseSpinning() { return useSpinning; }
public BatteryProjectForOptimizer setUseSpinning(BigDecimal value) { this.useSpinning = value; return this; }
public BigDecimal getUseNonSpinning() { return useNonSpinning; }
public BatteryProjectForOptimizer setUseNonSpinning(BigDecimal value) { this.useNonSpinning = value; return this; }
public BigDecimal getSolarDegredation() { return solarDegredation; }
public BatteryProjectForOptimizer setSolarDegredation(BigDecimal value) { this.solarDegredation = value; return this; }
public BigDecimal getBatteryDegredation() { return batteryDegredation; }
public BatteryProjectForOptimizer setBatteryDegredation(BigDecimal value) { this.batteryDegredation = value; return this; }
public BigDecimal getAugmentation() { return augmentation; }
public BatteryProjectForOptimizer setAugmentation(BigDecimal value) { this.augmentation = value; return this; }
public BigDecimal getAugmentationFrequency() { return augmentationFrequency; }
public BatteryProjectForOptimizer setAugmentationFrequency(BigDecimal value) { this.augmentationFrequency = value; return this; }
public BigDecimal getEnergyIncrement() { return energyIncrement; }
public BatteryProjectForOptimizer setEnergyIncrement(BigDecimal value) { this.energyIncrement = value; return this; }
public BigDecimal getAncillaryIncrement() { return ancillaryIncrement; }
public BatteryProjectForOptimizer setAncillaryIncrement(BigDecimal value) { this.ancillaryIncrement = value; return this; }
public Integer getEnableGridArbitrage() { return enableGridArbitrage; }
public BatteryProjectForOptimizer setEnableGridArbitrage(Integer value) { this.enableGridArbitrage = value; return this; }
public Integer getIncrementReferanceYear() { return incrementReferanceYear; }
public BatteryProjectForOptimizer setIncrementReferanceYear(Integer value) { this.incrementReferanceYear = value; return this; }
public Integer getRepresentativeYear() { return representativeYear; }
public BatteryProjectForOptimizer setRepresentativeYear(Integer value) { this.representativeYear = value; return this; }
public Integer getUseFutureData() { return useFutureData; }
public BatteryProjectForOptimizer setUseFutureData(Integer value) { this.useFutureData = value; return this; }
public BigDecimal getMaxDailyCycle() { return maxDailyCycle; }
public BatteryProjectForOptimizer setMaxDailyCycle(BigDecimal value) { this.maxDailyCycle = value; return this; }
public BigDecimal getMinDailyProfitPerMw() { return minDailyProfitPerMw; }
public BatteryProjectForOptimizer setMinDailyProfitPerMw(BigDecimal value) { this.minDailyProfitPerMw = value; return this; }
public Integer getAncillaryFileId() { return ancillaryFileId; }
public BatteryProjectForOptimizer setAncillaryFileId(Integer value) { this.ancillaryFileId = value; return this; }
public BigDecimal getMaxChargingPriceCap() { return maxChargingPriceCap; }
public BatteryProjectForOptimizer setMaxChargingPriceCap(BigDecimal value) { this.maxChargingPriceCap = value; return this; }
public BigDecimal getMaxDischargingPriceCap() { return maxDischargingPriceCap; }
public BatteryProjectForOptimizer setMaxDischargingPriceCap(BigDecimal value) { this.maxDischargingPriceCap = value; return this; }
public BigDecimal getMaxAncillaryPriceCap() { return maxAncillaryPriceCap; }
public BatteryProjectForOptimizer setMaxAncillaryPriceCap(BigDecimal value) { this.maxAncillaryPriceCap = value; return this; }
public RevenueStackingMode getRevenueStackingMode() { return revenueStackingMode; }
public BatteryProjectForOptimizer setRevenueStackingMode(RevenueStackingMode value) { this.revenueStackingMode = value; return this; }
public Integer getOptimizationQuality() { return optimizationQuality; }
public BatteryProjectForOptimizer setOptimizationQuality(Integer value) { this.optimizationQuality = value; return this; }
public Boolean isUseInternalSolver() { return useInternalSolver; }
public BatteryProjectForOptimizer setUseInternalSolver(Boolean value) { this.useInternalSolver = value; return this; }
}
public static enum BatterySimulationType
{
Undefined(0),
SingleRun(1),
BatchSimulation(2),
BatchSub(21),
Siting(100);
private final int value;
BatterySimulationType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static enum BatteryProjectGroup
{
Undefined,
StandAlone,
Ftm,
Btm;
}
public static enum BatteryProjectAction
{
Undefined,
Arbitrage,
PeakShaving,
Smooting,
Firming;
}
public static enum DataProvider
{
Undefined(0),
Spp(1),
Ercot(2),
Miso(3),
Caiso(4),
Pjm(5),
Isone(6),
Nyiso(7),
Nw(8),
Sw(9),
Se(10),
Aeso(11),
Ieso(12),
Cenace(20),
Noniso(99),
Eia(100),
Pnm(150),
Nrel(200),
Noaa(210),
Entsoe(1000),
Epias(1010),
Self(10000);
private final int value;
DataProvider(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static enum BatteryDataSoruce
{
Undefined,
Merchant,
Future,
Tod;
}
public static enum PriceMarketType
{
Undefined(0),
Realtime(1),
DayAhead(10),
Dart(101);
private final int value;
PriceMarketType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static enum TimeGranularity
{
Undefined(0),
Hourly(1),
Daily(2),
Weekly(3),
Monthy(4),
Yearly(5),
Fivemin(10),
Tenmin(11),
Fifteenmin(12),
Halfhour(13),
Quarterly(14),
Twohours(21),
Threehours(22),
Fourhours(24),
Sixhours(26),
Eighthours(28),
Twelvehours(32),
Irregular(100);
private final int value;
TimeGranularity(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static enum BooleanValue
{
Undefined,
Yes,
No,
Custom;
}
public static enum CapacityMethod
{
Undefined,
Annual,
Tod,
Schedule;
}
public static enum BatteryProductionDataSource
{
Undefined,
SetClosest,
UploadedFile;
}
public static enum PowerPlantType
{
Undefined,
Solar,
Wind,
Hybrid;
}
public static enum RevenueStackingMode
{
SolveWithoutAncillary,
SolveWithAncillary;
}
}
Java CommonOptimizerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /optimizer/ftm HTTP/1.1
Host: dev-optimization.power.dev
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"projectId":"00000000000000000000000000000000","isBatchSimulation":false,"force":false,"disableEBSSpot":false,"isServerless":false,"apiActionId":"00000000000000000000000000000000","nodeId":0,"parallelProject":0,"parallelYears":0,"ensureExlusive":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"status":"Undefined","message":"String","apiActionId":"00000000000000000000000000000000","detail":"String"}