API docs by Redocly

Archive API (1.0.0)

Download OpenAPI specification:

This API lists and retrieves archived Business Function payloads and metadata associated with outbound messages sent to receiving participants. The response returns re-signed messages from the IDX-Hub in the format of the originating Business Function.

Retrieval Of Archived Messsages

Get a list of the meta-data for your outbound archived messages.

Get a list of archived messages as part of your outbound archive. This will list all archived messages for all resources under all Business Functions that are archived.

Authorizations:
AEMO-OAuth2
query Parameters
startDateTime
string <date-time>
Example: startDateTime=2025-08-26T05:02:46.088+10:00

Filters messages from the specified date-time (inclusive). If omitted, it defaults to the current system date-time. 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-08-26T05:02:46.088+10: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')

itemCount
integer [ 1 .. 100 ]
Example: itemCount=100

The itemCount specifies the number of records that you want to receive in the response. A maximum of 500 records will be returned in the list. If you do not provide the query parameter a default value of up to 100 records will be returned.

cursor
string
Example: cursor=pqd~bpqd~m~agle~20250819235520790a

Specifies the next cursor as a pointer to the next page of records to retrieve -the cursor is the starting position for the next page of results.

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

If you do not provide the query parameter 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.

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

The Participant ID belonging to the Participant who sent the request.

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 to the IDX Hub 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. It is usually found in the ss-id cookie.

Responses

Response samples

Content type
application/json
{}

Retrieve an outbound archived message.

Retrieve an outbound archived message from a specified Business Function.

Required query parameters -

  • messageDateTime - Required because messageContextId values can be repeated on different dates, therefore more than one message in an archive can have the same messageContextId value.
  • schemaVersion - Required because two schema-versions of the same message can exist during a schema-transition-window.
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 messageContextId for the message.

The messageContextID is used in the following ways:

  • To provide a contextID for the message exchange. The participant/IDX-Hub uses this contextID of the original request when handling delivery.
  • For Large File Business Functions, the filename is set to .zip.
  • The name of the archive files is set to .zip.
  • To provide context to the failure messages to be returned where the incoming payload is unreadable such as, the payload is schema invalid.

NOTE: The _ delimiter and following SubResourceID are optional elements, applicable to some business functions only.

The UniqueID is defined by the Participant. Unique identifiers do not have to be globally unique, only unique to a particular sender. However, the length has been chosen such that UUIDs can be used as message identifiers if considered appropriate, guaranteeing global uniqueness.

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
messageDateTime
required
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}[+...
Example: messageDateTime=2025-10-17T08:56:45.000+10:00

The date and time (ISO-8601) that the messageContextId was sent.

To uniquely idenfity the archived message. The date is required as the messageContextId can be duplicated across dates, but are unique for a specific date. The messageDateTime is format enforced: YYYY-MM-DDTHH:mm:ss.SSS+HH:MM (e.g., '2025-12-10T16:45:33.000+10:00')

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

The Participant ID belonging to the Participant who sent the request.

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 ss-id (SessionId) of the user in either long or short format. It is usually found in the ss-id cookie.

Responses

Response samples

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