API docs by Redocly

Business Function Information API (1.0.0)

Download OpenAPI specification:

Business Function Information

This api provides access to Business Function information and their associated Resources within the Industry Data Exchange (IDX) platform. It provides the catalogue and metadata for IDX Business Functions and their resources. It exposes endpoints to retrieve Business Function configurations, returning details such as schema versions, payload types, retention settings, and identifiers.

Throttling and quotas

To control traffic, AEMO implements throttling on all api Endpoint requests. Some endpoints may also have a specific quota of requests. If a Participant ID request exceeds the throttling limit a HTTP 429 response returns. For more details, see the examples under each request.

Endpoint Limits
All endpoints 1440 requests per participantId per day

Business Functions

Get basic information about all Business Functions

Get basic information about all Business Functions

query Parameters
expand
boolean
Default: false
header Parameters
x-initiatingParticipantId
required
string [ 1 .. 10 ] characters ^[A-Z0-9]+$
Example: NEMMCO
x-market
required
string
Default: NEM
Enum: "AATELEC" "ACTELEC" "NEM" "NSWELEC" "NTELEC" "QLDELEC" "SAELEC" "TASELEC" "VICELEC" "WAELEC" "AATGAS" "ACTGAS" "NSWGAS" "NTGAS" "QLDGAS" "SAGAS" "TASGAS" "VICGAS" "WAGAS" "NSWACTGAS"
Accept
string
Example: application/json
x-ss-id
string
Example: 8F4B617F09BC0B2D13B790ABCD3A3D22C238736DF5D42E3F44C85A48FE07E42A

The ss-id (SessionId) of the user in either long or short format. This is usually found in the ss-id cookie.

Responses

Response samples

Content type
application/json
Example
{
  • "businessFunctions": [
    ]
}

Get detailed information about the input Business

Get detailed information about the input Business Function

path Parameters
businessFunctionId
required
string
header Parameters
x-initiatingParticipantId
required
string [ 1 .. 10 ] characters ^[A-Z0-9]+$
Example: NEMMCO
x-market
required
string
Default: NEM
Enum: "AATELEC" "ACTELEC" "NEM" "NSWELEC" "NTELEC" "QLDELEC" "SAELEC" "TASELEC" "VICELEC" "WAELEC" "AATGAS" "ACTGAS" "NSWGAS" "NTGAS" "QLDGAS" "SAGAS" "TASGAS" "VICGAS" "WAGAS" "NSWACTGAS"
Accept
string
Example: application/json
x-ss-id
string
Example: 8F4B617F09BC0B2D13B790ABCD3A3D22C238736DF5D42E3F44C85A48FE07E42A

The ss-id (SessionId) of the user in either long or short format. This is usually found in the ss-id cookie.

Responses

Response samples

Content type
application/json
{
  • "businessFunction": {
    }
}

Business Function Resources

Get basic information about all resources of the i

Get basic information about all resources of the input Business Function

path Parameters
businessFunctionId
required
string
header Parameters
x-initiatingParticipantId
required
string [ 1 .. 10 ] characters ^[A-Z0-9]+$
Example: NEMMCO
x-market
required
string
Default: NEM
Enum: "AATELEC" "ACTELEC" "NEM" "NSWELEC" "NTELEC" "QLDELEC" "SAELEC" "TASELEC" "VICELEC" "WAELEC" "AATGAS" "ACTGAS" "NSWGAS" "NTGAS" "QLDGAS" "SAGAS" "TASGAS" "VICGAS" "WAGAS" "NSWACTGAS"
Accept
string
Example: application/json
x-ss-id
string
Example: 8F4B617F09BC0B2D13B790ABCD3A3D22C238736DF5D42E3F44C85A48FE07E42A

The ss-id (SessionId) of the user in either long or short format. This is usually found in the ss-id cookie.

Responses

Response samples

Content type
application/json
{
  • "businessFunctionResources": [
    ]
}

Get detailed information about the input resource

Get detailed information about the input resource and Business Function

path Parameters
businessFunctionId
required
string
businessFunctionResourceId
required
string
header Parameters
x-initiatingParticipantId
required
string [ 1 .. 10 ] characters ^[A-Z0-9]+$
Example: NEMMCO
x-market
required
string
Default: NEM
Enum: "AATELEC" "ACTELEC" "NEM" "NSWELEC" "NTELEC" "QLDELEC" "SAELEC" "TASELEC" "VICELEC" "WAELEC" "AATGAS" "ACTGAS" "NSWGAS" "NTGAS" "QLDGAS" "SAGAS" "TASGAS" "VICGAS" "WAGAS" "NSWACTGAS"
Accept
string
Example: application/json
x-ss-id
string
Example: 8F4B617F09BC0B2D13B790ABCD3A3D22C238736DF5D42E3F44C85A48FE07E42A

The ss-id (SessionId) of the user in either long or short format. This is usually found in the ss-id cookie.

Responses

Response samples

Content type
application/json
{
  • "businessFunctionResource": {
    }
}