1. REST API for Oracle Integration 3
  2. Tasks
  3. B2B
  4. Monitoring

Retrieve Wire Messages

get

/ic/api/b2b/v1/monitoring/wiremessages

Retrieves a list of wire messages with information like message type, state, direction, protocol and trading partner. Wire messages represent the technical exchange of messages between the host company and trading partners. These messages can be encrypted and signed AS2.

Request

Query Parameters
  • Use the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list wire messages starting at the 4th item, and the list will contain 16 items.
  • Use with the offset parameter for paginating through the returned results. Default value is 0. This limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list wire messages starting at the 4th item, and the list will contain 16 items.

  • Filter parameters.

    • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. Default value is 1h.
    • direction: Message direction. Valid values are INBOUND and OUTBOUND.
    • id: Wire message identifier.
    • startdate: Custom time range start date/time in UTC format for filtering messages.
    • enddate: Custom time range end date/time in UTC format for filtering messages.
    • status: Message status.
    • transportprotocol: Message transport protocol. Valid values are AS2 and FTP.
    • instanceId: Integration instance identifier.
    • errorcode: Value of b2b error code.
    • tradingpartnerid: Trading partner identifier.
    • messagetype: Message type. Valid values are WIRE and MDN.
    • userdefinedid: A message identifier at the wire protocol level, if one is defined for the transport type. For AS2 transport, this is set to the AS2 message Identifier. For FTP transport this field is not available.
    • parentmessageid: Value of wire message identifier. This helps in fetching all acknowledgements correlated to a given wire message identifier.

    Example: 

    {startdate:'2020-07-09 07:00:00', enddate:'2020-07-09 21:25:00', id:'0AC415941776251CB5E0000026D27C45', direction:'INBOUND', messagetype:'WIRE'}

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : WireMessagesRs
Match All
Show Source
Nested Schema : GenericRestRs
Type: object
Show Source
Nested Schema : WireMessagesRs-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : WireMessageRs
Match All
Show Source
Nested Schema : WireMessageBasicRs
Match All
Show Source
Nested Schema : IdRs
Match All
Show Source
Nested Schema : IdRs-allOf[1]
Type: object
Show Source
Nested Schema : WireMessageBasicRs-allOf[2]
Type: object
Show Source
Nested Schema : WireMessageRs-allOf[3]
Type: object
Show Source
Nested Schema : correlatedMessages
Type: array
Show Source
Nested Schema : WireMessageRs.Payload
Type: object
Show Source
Nested Schema : processingResults
Type: array
Show Source
Nested Schema : transportProperties
Type: object
Additional Properties Allowed
Show Source
Nested Schema : WireMessageRs.CorrelatedMessage
Type: object
Show Source

400 Response

Malformed parameters

412 Response

Pre-condition failed

500 Response

Server error
Back to Top