Allows you to view the Current and Historical Instruction records in the Enablement Instructions screen along with the pre-populated drop down from the Instruction table.

API status

Draft for review. The design is not ready for participants’ builds.

Audience

The primary audience is implementers and maintainers of APIs in participant organisations.

The secondary audience is BAs and other interested parties.

Related resources

For additional information, see:

• https://markets-portal-help.docs.public.aemo.com.au/Content/TOC_web-topics/webTitlePage.htm?tocpath=System%20Security%20Scheduler%7C_____0

• API Reference

• Connecting to Markets Systems

• Guide to User Rights Management

• National Electricity Rules Glossary

• Industry Terminology

• OpenAPI Specification v3.0.1

Related rules and procedures

• https://markets-portal-help.docs.public.aemo.com.au/Content/System_Security_Scheduler/RulesProcedures.htm?tocpath=System%20Security%20Scheduler%7CNeed%20to%20Know%7C_____1

OpenAPI Specification

You can download the OpenAPI Specification for the following environments:

• Pre-production: Enablement Instruction OpenAPI specification (TBC)

• Production: Enablement Instruction OpenAPI specification (TBC)

Prerequisites

Before using the Enablement instructions, see API Requirements in Markets Portal Help. You must also:

• <List other prerequisites specific for the API>

Payload format

This API supports a JSON format payload. <This is an example. Some APIs support csv and JSON>

Parameters

The enablementInstruction-v1 API uses query parameters with Current or Historical.

Participants can connect to the AEMO API Gateway through the internet or MarketNet. See URL format in the API Reference.

All communications between AEMO’s API gateway and participants’ gateways use HTTPS. AEMO APIs do not support HTTP.

User rights access

Participant administrators provide access to the Enablement instructions API using the entity:

• MMS_SSM_AVAIL_WRITE

• MMS_SSM_INST_VIEW

For more information, see Guide to User Rights Management.

Authorisation

API requests are authorised by Basic HTTP authentication (Basic Auth) using a Base64-encoded username and password. The credentials are assigned by your company’s participant administrator.

In an API request, include the Base64-encoded string in a HTTPS Authorization header. For more information, see Authorisation in the API Reference.

Compression

You can submit your API compressed or uncompressed. Compression protocols are gzip or deflate.

Throttling

To control traffic, AEMO implements a throttling limit of TBC.

If requests exceed the throttling limit, the API responds with a HTTP 429 or 422 status.

Participants systems must manage throttling limits. AEMO can also reject multiple API requests for the same participantId at the same time.

Response codes

See Codes in the API Reference.

Submission rules

A submission API request times out at 60 seconds.

Submission interfaces

In addition to the API, you can use the following interfaces: https://markets-portal-help.docs.public.aemo.com.au/Content/System_Security_Scheduler/HowDoYouUse.htm?tocpath=System%20Security%20Scheduler%7CAbout%7C_____3.

Submission size

A submission request or response has a payload limit of 100 KB (compressed or uncompressed).

Submission processing

TBC

Submission response

TBC

Validation

TBC