API docs by Redocly

Transaction Logging API (1.0.5)

Download OpenAPI specification:

This API supplies detailed logs and statuses for messages and (B2B) transactions.

TransLog Messages

Get a list of message logs for messages where your participant ID was the initiating or receiving Participant.

Authorizations:
AEMO-OAuth2
query Parameters
itemCount
integer

Specifies the number of records in the list to be provided in the response. A maximum of 500 records will be returned in the list. If the query parameter is not provided a default value of up to 100 records will be returned.

toParticipant
string
Example: toParticipant=EASTENGY

The Participant ID of the Participant who sent the message.

fromParticipant
string
Example: fromParticipant=EASTENGY

The Participant Id of the Participant who sent the message.

isArchived
boolean
Example: isArchived=true

Boolean identifying if the message is archived or not.

messageId
string
Example: messageId=MSG-1a9b3c4d-5e6f-7g8h-9i0j-2k3l4m5n6o7p

The Message ID of the message that was sent.

startDateTime
string <date-time>
Example: startDateTime=2025-10-16T08:56:45+00:00

Filters messages up to the specified date-time (inclusive). If omitted, results are not constrained at the end. Format enforced 'YYYY-MM-DDTHH:mm:ss.SSS+HH:MM' (e.g., '2025-08-26T05:02:46.088+10:00')

endDateTime
string <date-time>
Example: endDateTime=2025-10-17T08:56:45+00:00

Filters messages up to the specified date-time (inclusive). If omitted, results are not constrained at the end. Format enforced 'YYYY-MM-DDTHH:mm:ss.SSS+HH:MM' (e.g., '2025-08-26T05:02:46.088+10:00')

messageStatus
string
Enum: "delivery_pending" "completed" "removed" "message_acked" "message_rejected"
Example: messageStatus=delivery_pending

The current status of the message.

messageType
string
Enum: "message" "tack"
Example: messageType=message

The type of message.

messageContextId
string^[0-9a-z]{1,4}~[0-9a-z]{1,8}(?:_[0-9a-z_]{1,3...
Example: messageContextId=pqd~bpqd~m~mdpid~20250819235520790a

The unique identifier for the message context.

The messageContextID format is: `[BusinessFunctionID 0-9_a-z]{1,4} +"~"

  • [BusinessFunctionResourceID 0-9_a-z]{1,8} + "_" + [SubResourceID 0-9_a-z]{1,33 } + "" + [Priority h|m|l] + "" + [InitiatingParticipantID]{1,10}
  • "~" + [UniqueID, 0-9_a-z_-]{1,36}`.
cursor
string
Example: cursor=pqd_bpqd_m_mdpid_20250819235520790a

The cursor is a pointer to the starting position for the next page of results.

The cursor value is defined in the meta section of the previous response as the nextCursor value.

If the query parameter is not provided the first page of results will be given.

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.

businessFunctionResourceId
string
Example: businessFunctionResourceId=bpqd

A Business Function Resource ID is a unique identifier used to represent a specific Business Function Resource. A Business Function Resource is a discrete sub-service or component within a Business Function that supports specific transactions or operations. It is typically defined with its own schema, payload type, and technical specifications under the parent Business Function.

transactionId
string
Example: transactionId=TXN-20260206-000001

The Transaction ID that is part of the message that was sent.

header Parameters
x-initiatingParticipantId
required
string [ 1 .. 10 ] characters ^[A-Z0-9]+$
Example: NEMMCO

The participant ID who the request is from.

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
Value: "application/json"
Example: application/json

Specifies the content type your client application expects to receive.

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
{}

TransLog Message Transactions

Retrieve transactions for a message

Authorizations:
AEMO-OAuth2
path Parameters
messageContextId
required
string^[0-9a-z]{1,4}~[0-9a-z]{1,8}(?:_[0-9a-z_]{1,3...
Example: pqd~bpqd~m~mdpid~20250819235520790a

The unique identifier for the message context.

The messageContextID format is: `[BusinessFunctionID 0-9_a-z]{1,4} +"~"

  • [BusinessFunctionResourceID 0-9_a-z]{1,8} + "_" + [SubResourceID 0-9_a-z]{1,33 } + "" + [Priority h|m|l] + "" + [InitiatingParticipantID]{1,10}
  • "~" + [UniqueID, 0-9_a-z_-]{1,36}`.
query Parameters
messageId
string
Example: messageId=MSG-1a9b3c4d-5e6f-7g8h-9i0j-2k3l4m5n6o7p

The Message ID of the message that was sent.

header Parameters
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-initiatingParticipantId
required
string [ 1 .. 10 ] characters ^[A-Z0-9]+$
Example: NEMMCO

The participant ID who the request is from.

Accept
string
Value: "application/json"
Example: application/json

Specifies the content type your client application expects to receive.

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
{
  • "data": {
    }
}