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

Retrieve Business Messages

get

/ic/api/b2b/v1/monitoring/businessmessages

Retrieves a list of business messages with information such as message type, state, direction and trading partner. Business messages represent individual documents or business transactions such as a purchase order.

Request

Query Parameters
  • Use with 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 business 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. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list business messages starting at the 4th item, and the list will contain 16 items.

  • Filter parameter.

    • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. Default value is 1h.
    • direction: Message direction. Valid values are INBOUND and OUTBOUND.
    • id: Business 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.
    • instanceId: Integration instance identifier.
    • errorcode: Value of error code.
    • tradingpartnerid: Trading partner identifier.
    • messagetype: Message type. Valid values are MSG and FA.
    • userdefinedid: User defined Identifier for business message is the value for Application Message Identifier field for an outbound business message. This field is available for mapping in your outbound integration. If a value is set in the mapping, it is returned with the business message details.
    • documenttype: Document type.
    • documentstandard: Document standard.
    • documentversion: Document version.
    • identifiervalue: Value of business identifier.
    • parentmessageid: Value of functional acknowledgement identifier. This will be helpful to fetch all business messages correlated to a given functional acknowledgement identifier.
    • interchangecontrolnumber: Value of interchange control number.
    • groupcontrolnumber: Value of group control number.
    • transactioncontrolnumber: Value of transaction set control number.

    Example: 

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

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

400 Response

Malformed parameters

412 Response

Pre condition failed

500 Response

Server error
Back to Top