Skip to main content

Get single message

Returns single message by message ID.

Path Parameters
id string — REQUIRED

Id

Query Parameters
search string

Search query

filters string

Filter

Header Parameters
X-Tenant-ID — REQUIRED
Responses
200

OK

Schema — OPTIONAL
contractReference string — OPTIONAL
creationTime string — OPTIONAL
direction string — OPTIONAL

Possible values: [RECEIVED, SENT]

documentIdentifier string — OPTIONAL
documentName string — OPTIONAL
documentType string — OPTIONAL
documentVersion int32 — OPTIONAL
ediGasVersion string — OPTIONAL
fipDatCreated string — OPTIONAL
fipDate string — OPTIONAL
fipUser string — OPTIONAL
fipUserCreated string — OPTIONAL
fipVersion int64 — OPTIONAL

The version of the object used for optimistic locking, must be not null for update, but null for insert.

gasDate string — OPTIONAL
gasDay int64 — OPTIONAL
gasDayHourDefinition object — OPTIONAL
beforeCurrentGasDay boolean — OPTIONAL
currentGasDay boolean — OPTIONAL
date string — OPTIONAL
dlstInfo object — OPTIONAL
switchingDay boolean — OPTIONAL
switchingDetails object — OPTIONAL
gap boolean — OPTIONAL
index int32 — OPTIONAL
overlap boolean — OPTIONAL
firstTimeStamp string — OPTIONAL
gasDayOffsetHours int32 — OPTIONAL
lastTimeStamp string — OPTIONAL
localTimeStrings object[] — OPTIONAL
from string — OPTIONAL
to string — OPTIONAL
numberOfHours int32 — OPTIONAL
tomorrowGasDay boolean — OPTIONAL
zoneId object — OPTIONAL
id string — OPTIONAL
rules object — OPTIONAL
fixedOffset boolean — OPTIONAL
transitionRules (circular)[] — OPTIONAL
transitions (circular)[] — OPTIONAL
id int64 — OPTIONAL

The id of the object, must be not null for update, but null for insert.

internalAccountName string — OPTIONAL
issuerMarketParticipant string — OPTIONAL
messageDefinitionDescription string — OPTIONAL
messageStatus string — OPTIONAL

Possible values: [ACKNOWLEDGED, ACKNOWLEDGED_ERROR, FAILURE, INITIAL, MISMATCHED, MISMATCHED_PARTIAL, NOMINATED, PENDING, RECEIVED, RECEIVED_PROCESSED_ERROR, SAVED, SAVED_EXCLUDED, SAVED_RENOMINATION, SENT, UNSENT, ZERO_NOMINATION]

nomintMessages (circular)[] — OPTIONAL
recipient string — OPTIONAL
recipientMarketParticipant string — OPTIONAL
replyMessageErrors string[] — OPTIONAL
replyMessageWarnings string[] — OPTIONAL
replyMessages object[] — OPTIONAL
contractReference string — OPTIONAL
creationTime string — OPTIONAL
direction string — OPTIONAL

Possible values: [RECEIVED, SENT]

documentIdentifier string — OPTIONAL
documentName string — OPTIONAL
documentType string — OPTIONAL
documentVersion int32 — OPTIONAL
ediGasVersion string — OPTIONAL
fipDatCreated string — OPTIONAL
fipDate string — OPTIONAL
fipUser string — OPTIONAL
fipUserCreated string — OPTIONAL
fipVersion int64 — OPTIONAL

The version of the object used for optimistic locking, must be not null for update, but null for insert.

gasDate string — OPTIONAL
id int64 — OPTIONAL

The id of the object, must be not null for update, but null for insert.

internalAccountName string — OPTIONAL
issuerMarketParticipant string — OPTIONAL
messageDefinitionDescription string — OPTIONAL
messageStatus string — OPTIONAL

Possible values: [ACKNOWLEDGED, ACKNOWLEDGED_ERROR, FAILURE, INITIAL, MISMATCHED, MISMATCHED_PARTIAL, NOMINATED, PENDING, RECEIVED, RECEIVED_PROCESSED_ERROR, SAVED, SAVED_EXCLUDED, SAVED_RENOMINATION, SENT, UNSENT, ZERO_NOMINATION]

recipient string — OPTIONAL
recipientMarketParticipant string — OPTIONAL
replyMessages (circular)[] — OPTIONAL
sendTime string — OPTIONAL
sender string — OPTIONAL
sendTime string — OPTIONAL
sender string — OPTIONAL
valuesStructured object[] — OPTIONAL
connectionPointName string — OPTIONAL
internalAccount string — OPTIONAL
timeSeriesMessageDtos object[] — OPTIONAL
connectionPointName string — OPTIONAL
destinationId int64 — OPTIONAL
excludeInOutgoingMessage boolean — OPTIONAL
externalAccount string — OPTIONAL
externalAccountCounterPartyCode string — OPTIONAL
externalAccountCounterPartyName string — OPTIONAL
externalHourlyValues object[] — OPTIONAL
hourlyStatus object — OPTIONAL
timetable string[]

Possible values: [ACKNOWLEDGED, ACKNOWLEDGED_ERROR, FAILURE, INITIAL, MISMATCHED, MISMATCHED_PARTIAL, NOMINATED, PENDING, RECEIVED, RECEIVED_PROCESSED_ERROR, SAVED, SAVED_EXCLUDED, SAVED_RENOMINATION, SENT, UNSENT, ZERO_NOMINATION]

hourlyValues object — OPTIONAL
fipDatCreated string — OPTIONAL
fipDate string — OPTIONAL
fipUser string — OPTIONAL
fipUserCreated string — OPTIONAL
fipVersion int64 — OPTIONAL
timetable number[]
originTimeSeriesType object — OPTIONAL
definition string — OPTIONAL
internal boolean — OPTIONAL
order int32 — OPTIONAL
title string — OPTIONAL
type string — OPTIONAL
replyMessageHourlyStatusDto object — OPTIONAL
timetable array[] — OPTIONAL
code string
definition string — OPTIONAL
title string — OPTIONAL
gasDayHourDefinition object — OPTIONAL
beforeCurrentGasDay boolean — OPTIONAL
currentGasDay boolean — OPTIONAL
date string — OPTIONAL
dlstInfo object — OPTIONAL
switchingDay boolean — OPTIONAL
switchingDetails object — OPTIONAL
gap boolean — OPTIONAL
index int32 — OPTIONAL
overlap boolean — OPTIONAL
firstTimeStamp string — OPTIONAL
gasDayOffsetHours int32 — OPTIONAL
lastTimeStamp string — OPTIONAL
localTimeStrings object[] — OPTIONAL
from string — OPTIONAL
to string — OPTIONAL
numberOfHours int32 — OPTIONAL
tomorrowGasDay boolean — OPTIONAL
zoneId object — OPTIONAL
id string — OPTIONAL
rules object — OPTIONAL
fixedOffset boolean — OPTIONAL
transitionRules (circular)[] — OPTIONAL
transitions (circular)[] — OPTIONAL
granularity string — OPTIONAL

Possible values: [DAILY, HOURLY]

internalAccount string — OPTIONAL
internalHourlyValues object — OPTIONAL
hourlyStatus object — OPTIONAL
timetable string[]

Possible values: [ACKNOWLEDGED, ACKNOWLEDGED_ERROR, FAILURE, INITIAL, MISMATCHED, MISMATCHED_PARTIAL, NOMINATED, PENDING, RECEIVED, RECEIVED_PROCESSED_ERROR, SAVED, SAVED_EXCLUDED, SAVED_RENOMINATION, SENT, UNSENT, ZERO_NOMINATION]

hourlyValues object — OPTIONAL
fipDatCreated string — OPTIONAL
fipDate string — OPTIONAL
fipUser string — OPTIONAL
fipUserCreated string — OPTIONAL
fipVersion int64 — OPTIONAL
timetable number[]
originTimeSeriesType object — OPTIONAL
definition string — OPTIONAL
internal boolean — OPTIONAL
order int32 — OPTIONAL
title string — OPTIONAL
type string — OPTIONAL
replyMessageHourlyStatusDto object — OPTIONAL
timetable array[] — OPTIONAL
code string
definition string — OPTIONAL
title string — OPTIONAL
messageStatus string — OPTIONAL

Possible values: [ACKNOWLEDGED, ACKNOWLEDGED_ERROR, FAILURE, INITIAL, MISMATCHED, MISMATCHED_PARTIAL, NOMINATED, PENDING, RECEIVED, RECEIVED_PROCESSED_ERROR, SAVED, SAVED_EXCLUDED, SAVED_RENOMINATION, SENT, UNSENT, ZERO_NOMINATION]

nominationTrackId int64 — OPTIONAL
sourceId int64 — OPTIONAL
401

Unauthorized

403

Forbidden

404

Not Found