AEMO WEMDE DispatchSolution V2

AEMO's public API catalogue lists 3 operation(s) for this API, gateway-routed under the path prefix /WEM/v2/dispatchSolution. AEMO's own openapi-link export for this API is a shell — it declares paths: {} with zero operations and names an internal host — so the 3 operation(s) in the OpenAPI captured here were harvested from AEMO's developer-portal operations endpoints (https://dev.aemo.com.au/developer/apis/wemde-dispatchsolution-external-v2/operations?api-version=2022-04-01-preview), complete with parameters, headers, response codes and response examples. Harvested 2026-07-27 (HTTP 200).

OpenAPI Specification

aemo-wemde-dispatchsolution-external-v2-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: WEMDE DispatchSolution V2
  version: '3.0'
  x-origin:
  - format: openapi
    source: AEMO API Management developer portal
    url: https://dev.aemo.com.au/developer/apis/wemde-dispatchsolution-external-v2/operations?api-version=2022-04-01-preview
servers:
- url: https://api-gwy-prd.aemo.local/WEM/v2/dispatchSolution
- url: https://api-prd.aemo.local/WEM/v2/dispatchSolution
paths:
  /dispatchData:
    get:
      operationId: retrievesTheSolutionDataForDispatchRun
      summary: Retrieves the Solution Data for Dispatch Run
      tags:
      - WEMDE DispatchSolution V2
      description: Retrieves the Solution Data for Dispatch Run
      parameters:
      - name: categories
        in: query
        required: false
        schema:
          type: string
        description: Possible values are Schedule,DispatchCaps,TrapeziumAdjustments,FacilityScheduleDetails,DefinedContingency,Constraints,InServiceQuantities,AvailableQuantities,MarketShortfalls,Prices,DispatchTotal,RocofControlRequirements,ContingencySolution,PriceSetting,FcessMarketClearingPriceCeilings.
      - 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. The API treats incoming time as +08:00 by default.'
      - 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. The API treats incoming time as +08:00 by default.'
      - name: primaryDispatchInterval
        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. The API treats incoming time as +08:00 by default.'
      - 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
                  solutionData:
                  - categories: string
                    runId: string
                    status: string
                    dispatchType: string
                    scenario: string
                    dispatchInterval: string
                    dispatchRunId: string
                    solveSatus: string
                    objectiveFunctionValue: 0
                    runIterationInformation:
                      fastStart: true
                      intervention: true
                      ocd: true
                    solveStartAsAtTS: string
                    solveFinishAsAtTS: string
                    schedule:
                    - marketService: string
                      facilitySchedule:
                      - facilityCode: string
                        quantity: 0
                        essPreProcessingConditionFlag: true
                    dispatchCaps:
                    - facilityCode: string
                      dispatchCap: 0
                    trapeziumAdjustments:
                    - marketService: string
                      trapeziumAdjustmentDetails:
                      - facilityCode: string
                        enablementMinimumValueUsed: 0
                        lowBreakpointValueUsed: 0
                        highBreakpointValueUsed: 0
                        enablementMaximumValueUsed: 0
                        downwardsRampRateValueUsed: 0
                        upwardsRampRateValueUsed: 0
                    facilityScheduleDetails:
                    - facilityCode: string
                      contingencyRaisePF: 0
                      contingencyLowerPF: 0
                      regulationRaisePF: 0
                      regulationLowerPF: 0
                      rocofPF: 0
                      dispatchBindingFlag: true
                      contingency: 0
                      loadContingency: 0
                      initialMw: 0
                      fastStartFlag: true
                      fastStartInitialModeTime: 0
                      fastStartInitialMode: 0
                      whatIfInitialMw: 0
                      fastStartTargetMode: 0
                      fastStartTargetModeTime: 0
                      estimatedFcessUpliftPayment: 0
                      nolDemand: 0
                      congestionRental: 0
                      facilityRisk: 0
                      facilityLowerRisk: 0
                      projectedChargeLevel: 0
                      projectedDischargeLevel: 0
                    definedContingency:
                    - id: string
                      valueOfContingency: 0
                      loadContribution: 0
                      associatedFacilities:
                      - facilityCode: string
                        marketService: string
                        contribution: 0
                    constraints:
                    - id: string
                      description: string
                      leftHandSideValue: 0
                      operator: string
                      constraintType: string
                      rightHandSideValue: 0
                      defaultRhs: 0
                      bindingConstraintFlag: true
                      nearBindingConstraintFlag: true
                      shadowPrice: 0
                      isInterventionEvent: true
                      slackVariables:
                      - variable: string
                        value: 0
                    inServiceQuantities:
                      energyInjectionCapacity: 0
                      energyWithdrawalCapacity: 0
                      contingencyRaise: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                    availableQuantities:
                      energyInjectionCapacity: 0
                      energyWithdrawalCapacity: 0
                      contingencyRaise: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                    marketShortfalls:
                      energyDeficit: 0
                      regulationRaiseDeficit: 0
                      regulationLowerDeficit: 0
                      contingencyRaiseDeficit: 0
                      contingencyLowerDeficit: 0
                      rocofDeficit: 0
                    prices:
                      energy: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                      contingencyRaise: 0
                    dispatchTotal:
                      energyInjectionCapacity: 0
                      energyWithdrawalCapacity: 0
                      contingencyRaise: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                    rocofControlRequirements:
                      minimumRocofControlRequirement: 0
                      additionalRocofControlRequirement: 0
                      rocofControlRequirement: 0
                    contingencySolution:
                      solvedInertia: 0
                      solvedContingency: 0
                      contingencyRaiseRequirement: 0
                      contingencyLowerRequirement: 0
                      contingencyRaiseDeficit: 0
                      contingencyLowerDeficit: 0
                      demandLevel: 0
                      dpvLevel: 0
                      clearedContingencyRaise: 0
                      clearedContingencyLower: 0
                      largestContingency: 0
                      largestLoadContingency: 0
                      contingencyRaiseOffset: 0
                      contingencyLowerOffset: 0
                    priceSetting:
                    - marketService: string
                      isMarketServiceCapped: true
                      contributions:
                      - contributingVariable: string
                        byHowMuch: 0
                        objectiveCoefficient: 0
                    fcessMarketClearingPriceCeilings:
                    - fcessMarketService: string
                      priceCeiling: 0
                    marketServiceRequirements:
                      energy: 0
                      regulationRaise: 0
                      regulationLower: 0
                      contingencyRaise: 0
                      contingencyLower: 0
                      rocof: 0
                    definedLoadContingency:
                    - id: string
                      valueOfContingency: 0
                      loadContribution: 0
                      associatedFacilities:
                      - facilityCode: string
                        marketService: string
                        contribution: 0
                errors:
                - {}
                warnings:
                - {}
                infos:
                - {}
                transactionId: string
            text/json:
              example:
                data:
                  primaryDispatchInterval: string
                  dispatchDataIssueID: string
                  solutionData:
                  - categories: string
                    runId: string
                    status: string
                    dispatchType: string
                    scenario: string
                    dispatchInterval: string
                    dispatchRunId: string
                    solveSatus: string
                    objectiveFunctionValue: 0
                    runIterationInformation:
                      fastStart: true
                      intervention: true
                      ocd: true
                    solveStartAsAtTS: string
                    solveFinishAsAtTS: string
                    schedule:
                    - marketService: string
                      facilitySchedule:
                      - facilityCode: string
                        quantity: 0
                        essPreProcessingConditionFlag: true
                    dispatchCaps:
                    - facilityCode: string
                      dispatchCap: 0
                    trapeziumAdjustments:
                    - marketService: string
                      trapeziumAdjustmentDetails:
                      - facilityCode: string
                        enablementMinimumValueUsed: 0
                        lowBreakpointValueUsed: 0
                        highBreakpointValueUsed: 0
                        enablementMaximumValueUsed: 0
                        downwardsRampRateValueUsed: 0
                        upwardsRampRateValueUsed: 0
                    facilityScheduleDetails:
                    - facilityCode: string
                      contingencyRaisePF: 0
                      contingencyLowerPF: 0
                      regulationRaisePF: 0
                      regulationLowerPF: 0
                      rocofPF: 0
                      dispatchBindingFlag: true
                      contingency: 0
                      loadContingency: 0
                      initialMw: 0
                      fastStartFlag: true
                      fastStartInitialModeTime: 0
                      fastStartInitialMode: 0
                      whatIfInitialMw: 0
                      fastStartTargetMode: 0
                      fastStartTargetModeTime: 0
                      estimatedFcessUpliftPayment: 0
                      nolDemand: 0
                      congestionRental: 0
                      facilityRisk: 0
                      facilityLowerRisk: 0
                      projectedChargeLevel: 0
                      projectedDischargeLevel: 0
                    definedContingency:
                    - id: string
                      valueOfContingency: 0
                      loadContribution: 0
                      associatedFacilities:
                      - facilityCode: string
                        marketService: string
                        contribution: 0
                    constraints:
                    - id: string
                      description: string
                      leftHandSideValue: 0
                      operator: string
                      constraintType: string
                      rightHandSideValue: 0
                      defaultRhs: 0
                      bindingConstraintFlag: true
                      nearBindingConstraintFlag: true
                      shadowPrice: 0
                      isInterventionEvent: true
                      slackVariables:
                      - variable: string
                        value: 0
                    inServiceQuantities:
                      energyInjectionCapacity: 0
                      energyWithdrawalCapacity: 0
                      contingencyRaise: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                    availableQuantities:
                      energyInjectionCapacity: 0
                      energyWithdrawalCapacity: 0
                      contingencyRaise: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                    marketShortfalls:
                      energyDeficit: 0
                      regulationRaiseDeficit: 0
                      regulationLowerDeficit: 0
                      contingencyRaiseDeficit: 0
                      contingencyLowerDeficit: 0
                      rocofDeficit: 0
                    prices:
                      energy: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                      contingencyRaise: 0
                    dispatchTotal:
                      energyInjectionCapacity: 0
                      energyWithdrawalCapacity: 0
                      contingencyRaise: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                    rocofControlRequirements:
                      minimumRocofControlRequirement: 0
                      additionalRocofControlRequirement: 0
                      rocofControlRequirement: 0
                    contingencySolution:
                      solvedInertia: 0
                      solvedContingency: 0
                      contingencyRaiseRequirement: 0
                      contingencyLowerRequirement: 0
                      contingencyRaiseDeficit: 0
                      contingencyLowerDeficit: 0
                      demandLevel: 0
                      dpvLevel: 0
                      clearedContingencyRaise: 0
                      clearedContingencyLower: 0
                      largestContingency: 0
                      largestLoadContingency: 0
                      contingencyRaiseOffset: 0
                      contingencyLowerOffset: 0
                    priceSetting:
                    - marketService: string
                      isMarketServiceCapped: true
                      contributions:
                      - contributingVariable: string
                        byHowMuch: 0
                        objectiveCoefficient: 0
                    fcessMarketClearingPriceCeilings:
                    - fcessMarketService: string
                      priceCeiling: 0
                    marketServiceRequirements:
                      energy: 0
                      regulationRaise: 0
                      regulationLower: 0
                      contingencyRaise: 0
                      contingencyLower: 0
                      rocof: 0
                    definedLoadContingency:
                    - id: string
                      valueOfContingency: 0
                      loadContribution: 0
                      associatedFacilities:
                      - facilityCode: string
                        marketService: string
                        contribution: 0
                errors:
                - {}
                warnings:
                - {}
                infos:
                - {}
                transactionId: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                missingHeader:
                  summary: Missing mandatory HTTP header parameter
                  value:
                    transactionId: 61361d96-f20d-43a7-bkdf-59b35fab9b13
                    data: {}
                    errors:
                    - code: '400'
                      title: Missing mandatory HTTP header parameter
                      detail: Mandatory HTTP header <headerName> is missing
                      source: ''
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    transactionId: 9a8e902a-ed40-45f3-b075-7a644b12947f
                    data: {}
                    errors:
                    - code: '401'
                      title: Unauthorized
                      detail: Unauthorized
                      source: ''
                initiatingParticipantIdMismatch:
                  summary: x-initiatingParticipantId does not match participant ID associated with the
                    certificate
                  value:
                    transactionId: 9a8e902a-ed40-45f3-u475-7a644b12947f
                    data: {}
                    errors:
                    - code: '401'
                      title: Unauthorized
                      detail: x-initiatingParticipantId does not match participant ID associated with
                        the certificate
                      source: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '404':
          description: Not Found
          content:
            text/plain:
              example: ''
            application/json:
              examples:
                resourceNotFound:
                  summary: Resource not found
                  value:
                    transactionId: 61361d96-f09d-43a7-babf-59b35fab9b13
                    data: {}
                    errors:
                    - code: '404'
                      title: Not found
                      detail: Resources for the endpoint URI not found. Endpoint URI:<URI>
                      source: ''
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '405':
          description: Method not allowed
          content:
            application/json:
              examples:
                methodNotAllowed:
                  summary: Method not allowed
                  value:
                    transactionId: 61361d96-z20d-43a7-babf-59b35fab9b13
                    data: {}
                    errors:
                    - code: '405'
                      title: Method not allowed
                      detail: 'Input request HTTP method is <invokedMethod> but operation <operationURI>
                        accepts only: [<operationMethod>]'
                      source: ''
        '413':
          description: Payload too large
          content:
            application/json:
              examples:
                payloadTooLarge:
                  summary: Payload too large
                  value:
                    transactionId: dc6826bc-1c0d-498b-b474-2b231910860c
                    data: {}
                    errors:
                    - code: '413'
                      title: Payload too large
                      detail: Maximum allowed size for the <request/response> body is <payload size limit>
                        bytes (<size limit> MB). This <request/response> has a size of <number of bytes>
                        bytes
                      source: ''
        '422':
          description: Client error
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '429':
          description: Too many requests
          content:
            application/json:
              examples:
                tooManyRequests:
                  summary: Too many requests
                  value:
                    transactionId: 63361d96-f20d-43a7-babf-59b35fab9b13
                    data: {}
                    errors:
                    - code: '429'
                      title: Too many requests
                      detail: Number of inbound requests exceeds the throttling limits. Try again later
                      source: ''
        '500':
          description: Server error or application unavailable
          content:
            text/plain:
              example: ''
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application unavailable
                  value: ''
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
  /preDispatchData:
    get:
      operationId: retrievesTheSolutionDataForPreDispatchRun
      summary: Retrieves the Solution Data for Pre-Dispatch Run
      tags:
      - WEMDE DispatchSolution V2
      description: Retrieves the Solution Data for Pre-Dispatch Run
      parameters:
      - name: categories
        in: query
        required: false
        schema:
          type: string
        description: Possible values are Schedule,DispatchCaps,TrapeziumAdjustments,FacilityScheduleDetails,DefinedContingency,Constraints,InServiceQuantities,AvailableQuantities,MarketShortfalls,Prices,DispatchTotal,RocofControlRequirements,ContingencySolution,PriceSetting,FcessMarketClearingPriceCeilings.
      - 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. The API treats incoming time as +08:00 by default.'
      - 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. The API treats incoming time as +08:00 by default.'
      - name: primaryDispatchInterval
        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. The API treats incoming time as +08:00 by default.'
      - 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
                  solutionData:
                  - categories: string
                    runId: string
                    status: string
                    dispatchType: string
                    scenario: string
                    dispatchInterval: string
                    dispatchRunId: string
                    solveSatus: string
                    objectiveFunctionValue: 0
                    runIterationInformation:
                      fastStart: true
                      intervention: true
                      ocd: true
                    solveStartAsAtTS: string
                    solveFinishAsAtTS: string
                    schedule:
                    - marketService: string
                      facilitySchedule:
                      - facilityCode: string
                        quantity: 0
                        essPreProcessingConditionFlag: true
                    dispatchCaps:
                    - facilityCode: string
                      dispatchCap: 0
                    trapeziumAdjustments:
                    - marketService: string
                      trapeziumAdjustmentDetails:
                      - facilityCode: string
                        enablementMinimumValueUsed: 0
                        lowBreakpointValueUsed: 0
                        highBreakpointValueUsed: 0
                        enablementMaximumValueUsed: 0
                        downwardsRampRateValueUsed: 0
                        upwardsRampRateValueUsed: 0
                    facilityScheduleDetails:
                    - facilityCode: string
                      contingencyRaisePF: 0
                      contingencyLowerPF: 0
                      regulationRaisePF: 0
                      regulationLowerPF: 0
                      rocofPF: 0
                      dispatchBindingFlag: true
                      contingency: 0
                      loadContingency: 0
                      initialMw: 0
                      fastStartFlag: true
                      fastStartInitialModeTime: 0
                      fastStartInitialMode: 0
                      whatIfInitialMw: 0
                      fastStartTargetMode: 0
                      fastStartTargetModeTime: 0
                      estimatedFcessUpliftPayment: 0
                      nolDemand: 0
                      congestionRental: 0
                      facilityRisk: 0
                      facilityLowerRisk: 0
                      projectedChargeLevel: 0
                      projectedDischargeLevel: 0
                    definedContingency:
                    - id: string
                      valueOfContingency: 0
                      loadContribution: 0
                      associatedFacilities:
                      - facilityCode: string
                        marketService: string
                        contribution: 0
                    constraints:
                    - id: string
                      description: string
                      leftHandSideValue: 0
                      operator: string
                      constraintType: string
                      rightHandSideValue: 0
                      defaultRhs: 0
                      bindingConstraintFlag: true
                      nearBindingConstraintFlag: true
                      shadowPrice: 0
                      isInterventionEvent: true
                      slackVariables:
                      - variable: string
                        value: 0
                    inServiceQuantities:
                      energyInjectionCapacity: 0
                      energyWithdrawalCapacity: 0
                      contingencyRaise: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                    availableQuantities:
                      energyInjectionCapacity: 0
                      energyWithdrawalCapacity: 0
                      contingencyRaise: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                    marketShortfalls:
                      energyDeficit: 0
                      regulationRaiseDeficit: 0
                      regulationLowerDeficit: 0
                      contingencyRaiseDeficit: 0
                      contingencyLowerDeficit: 0
                      rocofDeficit: 0
                    prices:
                      energy: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                      contingencyRaise: 0
                    dispatchTotal:
                      energyInjectionCapacity: 0
                      energyWithdrawalCapacity: 0
                      contingencyRaise: 0
                      contingencyLower: 0
                      regulationRaise: 0
                      regulationLower: 0
                      rocof: 0
                    rocofControlRequirements:
                      minimumRocofControlRequirement: 0
                      additionalRocofControlRequirement: 0
                      rocofControlRequirement: 0
                    contingencySolution:
                      solvedInertia: 0
                      solvedContingency: 0
                      contingencyRaiseRequirement: 0
                      contingencyLowerRequirement: 0
                      contingencyRaiseDeficit: 0
                      contingencyLowerDeficit: 0
                      demandLevel: 0
                      dpvLevel: 0
                      clearedContingencyRaise: 0
                      clearedContingencyLower: 0
                      largestContingency: 0
                      largestLoadContingency: 0
                      contingencyRaiseOffset: 0
                      contingencyLowerOffset: 0
                    priceSetting:
                    - marketService: string
                      isMarketServiceCapped: true
                      contributions:
                      - contributingVariable: string
                        byHowMuch: 0
                        objectiveCoefficient: 0
    

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aemo/refs/heads/main/openapi/aemo-wemde-dispatchsolution-external-v2-openapi.yml