Getting started

About the Outage Management System API

The Outage Management System (OMS) manages outages (both planned and unplanned) in a constrained network environment. The system includes a single-step outage submission and approval process.  

The OMS API, an external-facing API is used by Market Participants (MPs) and the Network Operator (NO) to interact with the OMS through web services.  

For support, contact WA Operational Planning & Forecasting 
Email: wa.outages@aemo.com.au 

Navigating this reference 

This page contains overview information for the API. Read on for general details on how to use the API. 

The icons at the top of the page link to the following, more detailed information sources:  

• The API Reference describes the paths, headers, request body and responses for each of the endpoints in the API. 

• The Postman Collection contains examples of code that you can use in your testing. 

• The Swagger File shows the latest version of the swagger file for that API. 

API status 

Ready. The design is ready for participants to use. 

Assumed knowledge 

API and JSON or YAML basics. 

Prerequisites

Before you can use the OMS API you must:

Have a Participant ID and Facility Code. If your company is a Registered Participant, your ID is set up during the registration process. 

• Have a DigiCert TLS certificate. 

For more information, see the Reformer page Accessing our test environments. 

External documents

The following documents will give you more detail on the API: 

• OMS User Guide 

Non-functional requirements 

The following provisional non-functional requirements (NFR) are relevant to the project. These will be revised in subsequent versions of this document following consultation with the MPs. 

Request/response payload required limits 

For all APIs, there is an enforced 10 MB max limit. 

Certificate-based throttling  

A single participant is restricted to accessing 50 calls every minute, with a total of 200 calls in five minutes.

API details

Authentication methods

The OMS API uses the DigiCert TLS certificate authentication method. 

Base URLs

Below are the base URLs used for this API: