Download OpenAPI specification:
This API provides information about your flow control statuses, details and summaries of breaches as well as for other participants. It monitors and manages message queue thresholds and participant flow‑control states.
To control traffic, we implement throttling on all API Endpoint requests. Also, some endpoints have a specific quota of requests. If a participantId request exceeds the throttling limit a HTTP 429 response returns. For more details, see the examples under each request.
| Endpoint | Limits |
|---|---|
PATCH /businessFunctions/{businessFunctionId} |
2 requests per businessFunctionId per participantId per day. A Business Function's message delivery to an outbound queue can only be switched on and off once per day. |
| All other endpoints | 288 requests per participantId per day |
Operations that return or update flow control breach information for the initiating Participant across business functions.
Get a list of business functions that have flow control breaches for your Participant ID
| expand | boolean Default: false |
| 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 |
{- "data": {
- "businessFunctions": [
- {
- "businessFunctionId": "sord",
- "ackStatus": null,
- "ackCount": null,
- "ackBreachedTimestamp": null,
- "messageStatus": "Stopped",
- "messageCount": 210,
- "messageBreachedTimestamp": "2025-10-30T12:00:00.000+00:00"
}, - {
- "businessFunctionId": "mtrd",
- "ackStatus": null,
- "ackCount": null,
- "ackBreachedTimestamp": null,
- "messageStatus": "Warned",
- "messageCount": 210,
- "messageBreachedTimestamp": "2025-10-30T12:05:00.000+00:00"
}
]
}
}Get flow control information for a single Business Function for your Participant ID
| businessFunctionId required | string |
| 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 |
{- "data": {
- "businessFunctions": [
- {
- "businessFunctionId": "sord",
- "ackStatus": null,
- "ackCount": null,
- "ackBreachedTimestamp": null,
- "messageStatus": "Stopped",
- "messageCount": 210,
- "messageBreachedTimestamp": "2025-10-30T12:00:00.000+00:00"
}
]
}
}Toggle outbound flow of messages to your queue for a given businessFunctionId
| businessFunctionId required | string |
| 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" |
| x-ss-id | string Example: 8F4B617F09BC0B2D13B790ABCD3A3D22C238736DF5D42E3F44C85A48FE07E42A The |
| Content-Encoding | string Value: "gzip" Example: gzip |
| stopQueue required | boolean |
{- "stopQueue": true
}{- "data": {
- "businessFunctionId": "pqd",
- "stopQueue": "enabled"
}
}Operations that list and inspect flow control breaches for other market participants.
Get a list of all participants experiencing flow control breaches
| businessFunctionId | string Example: businessFunctionId=pqd A Business Function ID is a unique identifier used to represent a specific Business Function. A Business Function is a logical grouping of related business services or sub-services that acts as an access point for exchanging information and executing transactions within a system or market framework. |
| 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 |
{- "data": {
- "participants": [
- {
- "participantId": "NEMMCO",
- "businessFunctions": [
- {
- "businessFunctionId": "sord",
- "messageStatus": "Stopped",
- "messageCount": 210,
- "messageBreachedTimestamp": "2025-10-30T12:00:00.000+00:00"
}, - {
- "businessFunctionId": "mtrd",
- "messageStatus": "Warned",
- "messageCount": 210,
- "messageBreachedTimestamp": "2025-10-30T12:05:00.000+00:00"
}
]
}, - {
- "participantId": "AGL",
- "businessFunctions": [
- {
- "businessFunctionId": "pqd",
- "messageStatus": "ManuallyStopped",
- "messageCount": 160,
- "messageBreachedTimestamp": "2025-10-30T12:10:00.000+00:00"
}, - {
- "businessFunctionId": "mtrd",
- "messageStatus": "Stopped",
- "messageCount": 210,
- "messageBreachedTimestamp": "2025-10-30T12:20:00.000+00:00"
}
]
}
]
}
}Get breached flow control details for a single participant.
| participantId required | string |
| 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 |
{- "data": {
- "participants": [
- {
- "participantId": "NEMMCO",
- "businessFunctions": [
- {
- "businessFunctionId": "pqd",
- "messageStatus": "Stopped",
- "messageCount": 210,
- "messageBreachedTimestamp": "2025-10-30T12:10:00.000+00:00"
}, - {
- "businessFunctionId": "mtrd",
- "messageStatus": "Stopped",
- "messageCount": 210,
- "messageBreachedTimestamp": "2025-10-30T12:20:00.000+00:00"
}
]
}
]
}
}