AEMO WEMDE DispatchCase V2
AEMO WEMDE DispatchCase V2 from AEMO — 3 path(s) described in OpenAPI.
OpenAPI Specification
openapi: 3.0.1
info:
title: WEMDE DispatchCase V2
version: '3.0'
x-origin:
- format: openapi
source: AEMO API Management developer portal
url: https://dev.aemo.com.au/developer/apis/wemde-dispatchcase-external-v2/operations?api-version=2022-04-01-preview
servers:
- url: https://api-gwy-prd.aemo.local/WEM/v2/dispatchCase
- url: https://api-prd.aemo.local/WEM/v2/dispatchCase
paths:
/preDispatchData?primaryDispatchInterval={primaryDispatchInterval}:
get:
operationId: retrievesCaseDataFromTheCentralDispatchProcessThroughARangeOfPastPrimaryDispatchIntervals
summary: Retrieves Case Data from the Central Dispatch Process through a range of past Primary Dispatch
Intervals
tags:
- WEMDE DispatchCase V2
description: Retrieves Case Data from the Central Dispatch Process through a range of past Primary
Dispatch Intervals
parameters:
- name: primaryDispatchInterval
in: path
required: true
schema:
type: string
description: 'Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is
optional - api will by default treat incoming time as +08:00'
- name: categories
in: query
required: false
schema:
type: string
description: Possible Values are parameters,constraintViolationParameters,scada,constraintLookUp,constraints,dfcmData,unconstrainedForecast,registrationData,facilityLossFactors,markets,rcmData,marketServicesPriceFlag
- name: dispatchScenario
in: query
required: false
schema:
type: string
description: Possible values are Reference, ForecastHigh, ForecastLow, InServiceCapacityOnly,
AvailableCapacity. Default value is Reference.
- name: dispatchIntervalStartDate
in: query
required: false
schema:
type: string
description: 'Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is
optional - api will by default treat incoming time as +08:00'
- name: dispatchIntervalEndDate
in: query
required: false
schema:
type: string
description: 'Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is
optional - api will by default treat incoming time as +08:00'
- name: dispatchIntervalScope
in: query
required: false
schema:
type: string
default: Latest
description: Possible values are Latest,Original
- name: accept-encoding
in: header
required: false
schema:
type: string
default: gzip
- name: x-initiatingParticipantId
in: header
required: true
schema:
type: string
description: The id of the Initiating Participant
- name: x-market
in: header
required: true
schema:
type: string
description: The id of the market
responses:
'200':
description: Success
content:
text/plain:
example: ''
application/json:
example:
data:
primaryDispatchInterval: string
dispatchDataIssueID: string
caseData:
- runId: string
status: string
dispatchType: string
scenario: string
intervalLength: 0
dispatchInterval: string
dispatchRunId: string
parameters:
- name: string
value: 0
constraintViolationParameters:
- variable: string
price: 0
scada:
- tag: string
value: string
valueDataType: string
qualityFlag: string
dataSource: string
asAtTimeStamp: string
constraintLookUp:
forecastRegionalForecastSouthWestGreatSouthernRegionBaseLoadExpected: 0
forecastRegionalForecastSouthWestGreatSouthernRegionLoadExpected: 0
forecastRegionalForecastNorthCountryRegionLoadExpected: 0
forecastEnergyForecastDPVExpected: 0
forecastEssContingencyLowerOffsetExpected: 0
forecastEssRegulationRaiseExpected: 0
forecastEssRegulationLowerExpected: 0
forecastEssContingencyLowerExpected: 0
forecastEnergyForecastOperationalDemandExpected: 0
forecastEnergyForecastOperationalDemandHigh: 0
forecastEnergyForecastOperationalDemandLow: 0
forecastNsgForecastAlbanyWindFarmBomAccessAExpected: 0
forecastNsgForecastAlbanyWindFarmBomAccessAHigh: 0
forecastNsgForecastAlbanyWindFarmBomAccessALow: 0
forecastRegionalForecastEasternGoldfieldsExpected: 0
forecastRegionalForecastNorthOfThreeSpringsExpected: 0
forecastRegionalForecastNorthCountryRegionBaseLoadExpected: 0
solverMinutesSincePrimary: 0
constraints:
constraintSet:
- id: string
constraintEquations:
- string
version: 0
description: string
comments: string
dfcmData:
dfcmId: string
dfcmSchemaVersion: string
frequencyLimits:
rocofMax: 0
rocofMin: 0
fmin: 0
fmax: 0
fss: 0
marginForOperationCRR: 0
tauValuesforCRPerformanceFactors:
- 0
dfcmValidationDetails:
inertiaRangeMinimum: 0
inertiaRangeMaximum: 0
inertiaRangeStep: 0
largestContingencySizeMinimum: 0
largestContingencySizeMaximum: 0
largestContingencySizeStep: 0
underlyingDemandMinimum: 0
underlyingDemandMaximum: 0
underlyingDemandStep: 0
loadReliefValues:
- 0
dpvMinimum: 0
dpvMaximum: 0
dpvStep: 0
unconstrainedForecast:
- facilityCode: string
unconstrainedInjectionForecastMw: 0
unconstrainedWithdrawalForecastMw: 0
registrationData:
- facilityCode: string
nol: true
facilityStandingData:
facilityRegistrationStatus: string
facilityClass: string
storageConstraints: true
inertia: 0
tauFactor: 0
effectiveDispatchIntervalFrom: string
unconstrainedForecastSource: string
facilityLossFactors:
- facilityCode: string
distributionLossFactor: 0
transmissionLossFactor: 0
markets:
energy:
marketService: string
baseForecastRequirement: 0
overrideForecastRequirement: {}
facilities:
- maxInjectionCapacity: 0
maxWithdrawalCapacity: 0
unconstrainedInjectionForecast: 0
unconstrainedWithdrawalForecast: 0
inflexibleFlag: true
maxUpwardRampRate: 0
downwardsRampRateValueUsed: 0
maxDownwardRampRate: 0
upwardsRampRateValueUsed: 0
fsip:
t1: 0
t2: 0
t3: 0
t4: 0
minimumLoad: 0
facilityCode: string
submissionId: string
submissionCode: string
tranches:
- tranche: 0
fuelType: string
quantity: 0
submittedPrice: 0
lfaPrice: 0
capacityType: string
noticeTime: 0
enablementMinimum: 0
enablementMinimumValueUsed: 0
lowBreakpoint: 0
lowBreakpointValueUsed: 0
highBreakpoint: 0
highBreakpointValueUsed: 0
enablementMaximum: 0
enablementMaximumValueUsed: 0
maximumCapacity: 0
regulationRaise:
marketService: string
baseForecastRequirement: 0
overrideForecastRequirement: {}
facilities:
- maxInjectionCapacity: 0
maxWithdrawalCapacity: 0
unconstrainedInjectionForecast: 0
unconstrainedWithdrawalForecast: 0
inflexibleFlag: true
maxUpwardRampRate: 0
downwardsRampRateValueUsed: 0
maxDownwardRampRate: 0
upwardsRampRateValueUsed: 0
fsip:
t1: 0
t2: 0
t3: 0
t4: 0
minimumLoad: 0
facilityCode: string
submissionId: string
submissionCode: string
tranches:
- tranche: 0
fuelType: string
quantity: 0
submittedPrice: 0
lfaPrice: 0
capacityType: string
noticeTime: 0
enablementMinimum: 0
enablementMinimumValueUsed: 0
lowBreakpoint: 0
lowBreakpointValueUsed: 0
highBreakpoint: 0
highBreakpointValueUsed: 0
enablementMaximum: 0
enablementMaximumValueUsed: 0
maximumCapacity: 0
regulationLower:
marketService: string
baseForecastRequirement: 0
overrideForecastRequirement: {}
facilities:
- maxInjectionCapacity: 0
maxWithdrawalCapacity: 0
unconstrainedInjectionForecast: 0
unconstrainedWithdrawalForecast: 0
inflexibleFlag: true
maxUpwardRampRate: 0
downwardsRampRateValueUsed: 0
maxDownwardRampRate: 0
upwardsRampRateValueUsed: 0
fsip:
t1: 0
t2: 0
t3: 0
t4: 0
minimumLoad: 0
facilityCode: string
submissionId: string
submissionCode: string
tranches:
- tranche: 0
fuelType: string
quantity: 0
submittedPrice: 0
lfaPrice: 0
capacityType: string
noticeTime: 0
enablementMinimum: 0
enablementMinimumValueUsed: 0
lowBreakpoint: 0
lowBreakpointValueUsed: 0
highBreakpoint: 0
highBreakpointValueUsed: 0
enablementMaximum: 0
enablementMaximumValueUsed: 0
maximumCapacity: 0
contingencyRaise:
marketService: string
baseForecastRequirement: 0
overrideForecastRequirement: {}
facilities:
- maxInjectionCapacity: 0
maxWithdrawalCapacity: 0
unconstrainedInjectionForecast: 0
unconstrainedWithdrawalForecast: 0
inflexibleFlag: true
maxUpwardRampRate: 0
downwardsRampRateValueUsed: 0
maxDownwardRampRate: 0
upwardsRampRateValueUsed: 0
fsip:
t1: 0
t2: 0
t3: 0
t4: 0
minimumLoad: 0
facilityCode: string
submissionId: string
submissionCode: string
tranches:
- tranche: 0
fuelType: string
quantity: 0
submittedPrice: 0
lfaPrice: 0
capacityType: string
noticeTime: 0
enablementMinimum: 0
enablementMinimumValueUsed: 0
lowBreakpoint: 0
lowBreakpointValueUsed: 0
highBreakpoint: 0
highBreakpointValueUsed: 0
enablementMaximum: 0
enablementMaximumValueUsed: 0
maximumCapacity: 0
contingencyLower:
marketService: string
baseForecastRequirement: 0
overrideForecastRequirement: {}
facilities:
- maxInjectionCapacity: 0
maxWithdrawalCapacity: 0
unconstrainedInjectionForecast: 0
unconstrainedWithdrawalForecast: 0
inflexibleFlag: true
maxUpwardRampRate: 0
downwardsRampRateValueUsed: 0
maxDownwardRampRate: 0
upwardsRampRateValueUsed: 0
fsip:
t1: 0
t2: 0
t3: 0
t4: 0
minimumLoad: 0
facilityCode: string
submissionId: string
submissionCode: string
tranches:
- tranche: 0
fuelType: string
quantity: 0
submittedPrice: 0
lfaPrice: 0
capacityType: string
noticeTime: 0
enablementMinimum: 0
enablementMinimumValueUsed: 0
lowBreakpoint: 0
lowBreakpointValueUsed: 0
highBreakpoint: 0
highBreakpointValueUsed: 0
enablementMaximum: 0
enablementMaximumValueUsed: 0
maximumCapacity: 0
rocof:
marketService: string
baseForecastRequirement: 0
overrideForecastRequirement: {}
facilities:
- maxInjectionCapacity: 0
maxWithdrawalCapacity: 0
unconstrainedInjectionForecast: 0
unconstrainedWithdrawalForecast: 0
inflexibleFlag: true
maxUpwardRampRate: 0
downwardsRampRateValueUsed: 0
maxDownwardRampRate: 0
upwardsRampRateValueUsed: 0
fsip:
t1: 0
t2: 0
t3: 0
t4: 0
minimumLoad: 0
facilityCode: string
submissionId: string
submissionCode: string
tranches:
- tranche: 0
fuelType: string
quantity: 0
submittedPrice: 0
lfaPrice: 0
capacityType: string
noticeTime: 0
enablementMinimum: 0
enablementMinimumValueUsed: 0
lowBreakpoint: 0
lowBreakpointValueUsed: 0
highBreakpoint: 0
highBreakpointValueUsed: 0
enablementMaximum: 0
enablementMaximumValueUsed: 0
maximumCapacity: 0
rcmData:
- facilityCode: string
rcoq: 0
marketServicesPriceFlag:
energyPriceAtCap: true
regulationRaisePriceAtCap: true
regulationLowerPriceAtCap: true
contingencyLowerPriceAtCap: true
contingencyRaisePriceAtCap: true
rocofPriceAtCap: true
errors:
- {}
warnings:
- {}
infos:
- {}
transactionId: string
text/json:
example:
data:
primaryDispatchInterval: string
dispatchDataIssueID: string
caseData:
- runId: string
status: string
dispatchType: string
scenario: string
intervalLength: 0
dispatchInterval: string
dispatchRunId: string
parameters:
- name: string
value: 0
constraintViolationParameters:
- variable: string
price: 0
scada:
- tag: string
value: string
valueDataType: string
qualityFlag: string
dataSource: string
asAtTimeStamp: string
constraintLookUp:
forecastRegionalForecastSouthWestGreatSouthernRegionBaseLoadExpected: 0
forecastRegionalForecastSouthWestGreatSouthernRegionLoadExpected: 0
forecastRegionalForecastNorthCountryRegionLoadExpected: 0
forecastEnergyForecastDPVExpected: 0
forecastEssContingencyLowerOffsetExpected: 0
forecastEssRegulationRaiseExpected: 0
forecastEssRegulationLowerExpected: 0
forecastEssContingencyLowerExpected: 0
forecastEnergyForecastOperationalDemandExpected: 0
forecastEnergyForecastOperationalDemandHigh: 0
forecastEnergyForecastOperationalDemandLow: 0
forecastNsgForecastAlbanyWindFarmBomAccessAExpected: 0
forecastNsgForecastAlbanyWindFarmBomAccessAHigh: 0
forecastNsgForecastAlbanyWindFarmBomAccessALow: 0
forecastRegionalForecastEasternGoldfieldsExpected: 0
forecastRegionalForecastNorthOfThreeSpringsExpected: 0
forecastRegionalForecastNorthCountryRegionBaseLoadExpected: 0
solverMinutesSincePrimary: 0
constraints:
constraintSet:
- id: string
constraintEquations:
- string
version: 0
description: string
comments: string
dfcmData:
dfcmId: string
dfcmSchemaVersion: string
frequencyLimits:
rocofMax: 0
rocofMin: 0
fmin: 0
fmax: 0
fss: 0
marginForOperationCRR: 0
tauValuesforCRPerformanceFactors:
- 0
dfcmValidationDetails:
inertiaRangeMinimum: 0
inertiaRangeMaximum: 0
inertiaRangeStep: 0
largestContingencySizeMinimum: 0
largestContingencySizeMaximum: 0
largestContingencySizeStep: 0
underlyingDemandMinimum: 0
underlyingDemandMaximum: 0
underlyingDemandStep: 0
loadReliefValues:
- 0
dpvMinimum: 0
dpvMaximum: 0
dpvStep: 0
unconstrainedForecast:
- facilityCode: string
unconstrainedInjectionForecastMw: 0
unconstrainedWithdrawalForecastMw: 0
registrationData:
- facilityCode: string
nol: true
facilityStandingData:
facilityRegistrationStatus: string
facilityClass: string
storageConstraints: true
inertia: 0
tauFactor: 0
effectiveDispatchIntervalFrom: string
unconstrainedForecastSource: string
facilityLossFactors:
- facilityCode: string
distributionLossFactor: 0
transmissionLossFactor: 0
markets:
energy:
marketService: string
baseForecastRequirement: 0
overrideForecastRequirement: {}
facilities:
- maxInjectionCapacity: 0
maxWithdrawalCapacity: 0
unconstrainedInjectionForecast: 0
unconstrainedWithdrawalForecast: 0
inflexibleFlag: true
maxUpwardRampRate: 0
downwardsRampRateValueUsed: 0
maxDownwardRampRate: 0
upwardsRampRateValueUsed: 0
fsip:
t1: 0
t2: 0
t3: 0
t4: 0
minimumLoad: 0
facilityCode: string
submissionId: string
submissionCode: string
tranches:
- tranche: 0
fuelType: string
quantity: 0
submittedPrice: 0
lfaPrice: 0
capacityType: string
noticeTime: 0
enablementMinimum: 0
enablementMinimumValueUsed: 0
lowBreakpoint: 0
lowBreakpointValueUsed: 0
highBreakpoint: 0
highBreakpointValueUsed: 0
enablementMaximum: 0
enablementMaximumValueUsed: 0
maximumCapacity: 0
regulationRaise:
marketService: string
baseForecastRequirement: 0
overrideForecastRequirement: {}
facilities:
- maxInjectionCapacity: 0
maxWithdrawalCapacity: 0
unconstrainedInjectionForecast: 0
unconstrainedWithdrawalForecast: 0
inflexibleFlag: true
maxUpwardRampRate: 0
downwardsRampRateValueUsed: 0
maxDownwardRampRate: 0
upwardsRampRateValueUsed: 0
fsip:
t1: 0
t2: 0
t3: 0
t4: 0
minimumLoad: 0
facilityCode: string
submissionId: string
submissionCode: string
tranches:
- tranche: 0
fuelType: string
quantity: 0
submittedPrice: 0
lfaPrice: 0
capacityType: string
noticeTime: 0
enablementMinimum: 0
enablementMinimumValueUsed: 0
lowBreakpoint: 0
lowBreakpointValueUsed: 0
highBreakpoint: 0
highBreakpointValueUsed: 0
enablementMaximum: 0
enablementMaximumValueUsed: 0
maximumCapacity: 0
regulationLower:
marketService: string
baseForecastRequirement: 0
overrideForecastRequirement: {}
facilities:
- maxInjectionCapacity: 0
maxWithdrawalCapacity: 0
unconstrainedInjectionForecast: 0
unconstrainedWithdrawalForecast: 0
inflexibleFlag: true
maxUpwardRampRate: 0
downwardsRampRateValueUsed: 0
maxDownwardRampRate: 0
upwardsRampRateValueUsed: 0
fsip:
t1: 0
t2: 0
t3: 0
t4: 0
minimumLoad: 0
facilityCode: string
submissionId: string
submissionCode: string
tranches:
- tranche: 0
fuelType: string
quantity: 0
submittedPrice: 0
lfaPrice: 0
capacityType: string
noticeTime: 0
enablementMinimum: 0
enablementMinimumValueUsed: 0
lowBreakpoint: 0
lowBreakpointValueUsed: 0
highBreakpoint: 0
highBreakpointValueUsed: 0
enablementMaximum: 0
enablementMaximumValueUsed: 0
maximumCapacity: 0
contingencyRaise:
marketService: string
baseForecastRequirement: 0
overrideForecastRequirement: {}
facilities:
- maxInjectionCapacity: 0
maxWithdrawalCapacity: 0
unconstrainedInjectionForecast: 0
unconstrainedWithdrawalForecast: 0
inflexibleFlag: true
maxUpwardRampRate: 0
downwardsRampRateValueUsed: 0
maxDownwardRampRate: 0
upwardsRampRateValueUsed: 0
fsip:
t1: 0
t2: 0
t3: 0
t4: 0
minimumLoad: 0
facilityCode: string
submissionId: string
submissionCode: string
tranches:
- tranche: 0
fuelType: string
quantity: 0
submittedPrice: 0
lfaPrice: 0
capacityType: string
noticeTime: 0
enablementMinimum: 0
enablementMinimumValueUsed: 0
lowBreakpoint: 0
lowBreakpointValueUsed: 0
highBreakpoint: 0
highBreakpointValueUsed: 0
enablementMaximum: 0
enablementMaximumValueUsed: 0
maximumCapacity: 0
contingencyLower:
marketService: string
baseForecastRequirement: 0
overrideForecastRequirement: {}
facilities:
- maxInjectionCapacity: 0
maxWithdrawalCapacity: 0
unconstrainedInjectionForecast: 0
unconstrainedWithdrawalForecast: 0
inflexibleFlag: true
maxUpwardRampRate: 0
downwardsRampRateValueUsed: 0
maxDownwardRampRate: 0
upwardsRampRateValueUsed: 0
fsip:
t1: 0
t2: 0
t3: 0
t4: 0
minimumLoad: 0
facilityCode: string
submissionId: string
submissionCode: string
tranches:
- tranche: 0
fuelType: string
quantity: 0
submittedPrice: 0
lfaPrice: 0
cap
# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aemo/refs/heads/main/openapi/aemo-wemde-dispatchcase-external-v2-openapi.yml