Jump to

• Request
• Response

Retrieve Wire Messages

get

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

Retrieves a list of wire messages along with information such as message type, state, direction, protocol and trading partner. Wire messages represent the technical exchange of messages from/to the host company and trading partners, such as an encrypted and signed AS2 message.

Request

Supported Media Types

• application/json

Query Parameters

• limit: integer(int32)
  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 wire messages starting at the 4th item, and the list will contain 16 items.
• offset: integer(int32)
  Use with the offset parameter for paginating through the returned results. Default is 0. The 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.
• q: string

  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.

  Example:

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : wiremessages

Type: object

Show Source

• dataFetchTime: string(date-time)
• hasMore: boolean
• items: array items
• limit: integer(int32)
• links: array links
• totalRecordsCount: integer(int32)
• totalResults: integer(int32)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WireMessageRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "totalRecordsCount":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "dataFetchTime":{
            "type":"string",
            "format":"date-time"
        }
    },
    "xml":{
        "name":"wiremessages"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object wiremessage

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WireMessageRs"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

Nested Schema : wiremessage

Type: object

Show Source

• ackState: string
• correlatedMessages: array correlatedMessages
• createdBy: string
• creationDate: string
• direction: string
• errorCode: string
• errorDetail: string
• errorSummary: string
• id: string
• instanceId: string
• links: array links
• messageType: string
• packedPayloadId: string
• packedPayloadSize: string
• payload: object payload
• payloadName: string
• processingResults: array processingResults
• source: string
• state: string
• tradingPartner: string
• transportName: string
• transportProperties: object transportProperties
  Additional Properties Allowed: additionalProperties
• transportProtocol: string
• unpackedPayloadId: string
• unpackedPayloadSize: string
• updatedBy: string
• updatedDate: string
• url: string
• userDefinedId: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "ackState":{
            "type":"string"
        },
        "transportProtocol":{
            "type":"string"
        },
        "transportName":{
            "type":"string"
        },
        "url":{
            "type":"string"
        },
        "direction":{
            "type":"string"
        },
        "tradingPartner":{
            "type":"string"
        },
        "source":{
            "type":"string"
        },
        "creationDate":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "payloadName":{
            "type":"string"
        },
        "packedPayloadId":{
            "type":"string"
        },
        "packedPayloadSize":{
            "type":"string"
        },
        "unpackedPayloadId":{
            "type":"string"
        },
        "unpackedPayloadSize":{
            "type":"string"
        },
        "messageType":{
            "type":"string"
        },
        "userDefinedId":{
            "type":"string"
        },
        "instanceId":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "errorSummary":{
            "type":"string"
        },
        "errorDetail":{
            "type":"string"
        },
        "transportProperties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "processingResults":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "payload":{
            "$ref":"#/definitions/Payload"
        },
        "correlatedMessages":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CorrelatedMessage"
            }
        }
    },
    "xml":{
        "name":"wiremessage"
    }
}

Nested Schema : correlatedMessages

Type: array

Show Source

• Array of: object CorrelatedMessage

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CorrelatedMessage"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

Nested Schema : payload

Type: object

Show Source

• action: object action
• comment: object comment
• identities: array identities
• priority: integer(int32)

{
    "type":"object",
    "properties":{
        "identities":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"identities"
                },
                "$ref":"#/definitions/Identity"
            }
        },
        "action":{
            "$ref":"#/definitions/Action"
        },
        "comment":{
            "$ref":"#/definitions/Comment"
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        }
    },
    "xml":{
        "name":"payload",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : processingResults

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : transportProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : CorrelatedMessage

Type: object

Show Source

• count: integer(int32)
• label: string

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : action

Type: object

Show Source

• abortType: string
• activityChanges: array activityChanges
• assignees: array assignees
• comments: string
• correlationKeyChanges: array correlationKeyChanges
• dataObjectChanges: array dataObjectChanges
• faultActionType: string
• flowId: integer(int64)
• id: string
• instanceAttributeChanges: array instanceAttributeChanges
• processes: array processes
• type: string

{
    "type":"object",
    "properties":{
        "assignees":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Identity"
            }
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "processes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "faultActionType":{
            "type":"string"
        },
        "flowId":{
            "type":"integer",
            "format":"int64"
        },
        "abortType":{
            "type":"string"
        },
        "comments":{
            "type":"string"
        },
        "activityChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FlowChangeItemReq"
            }
        },
        "dataObjectChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "instanceAttributeChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "correlationKeyChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        }
    },
    "xml":{
        "name":"action",
        "namespace":"http://xmlns.oracle.com/bpm/rest/processdef"
    }
}

Nested Schema : comment

Type: object

Show Source

• commentScope: string
• commentStr: string
• updatedBy: string
• updateddDate: string
• userId: string

{
    "type":"object",
    "properties":{
        "commentStr":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "updateddDate":{
            "type":"string"
        },
        "commentScope":{
            "type":"string"
        }
    },
    "xml":{
        "name":"comment",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : identities

Type: array

Show Source

• Array of: object identity
  Discriminator: type

{
    "type":"array",
    "items":{
        "xml":{
            "name":"identities"
        },
        "$ref":"#/definitions/Identity"
    }
}

Nested Schema : activityChanges

Type: array

Show Source

• Array of: object FlowChangeItemReq

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FlowChangeItemReq"
    }
}

Nested Schema : assignees

Type: array

Show Source

• Array of: object identity
  Discriminator: type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Identity"
    }
}

Nested Schema : correlationKeyChanges

Type: array

Show Source

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

Nested Schema : dataObjectChanges

Type: array

Show Source

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

Nested Schema : instanceAttributeChanges

Type: array

Show Source

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

Nested Schema : processes

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : FlowChangeItemReq

Type: object

Show Source

• correlationKeyChanges: array correlationKeyChanges
• dataObjectChanges: array dataObjectChanges
• instanceAttributeChanges: array instanceAttributeChanges
• sourceActivityId: string
• targetActivityId: string

{
    "type":"object",
    "properties":{
        "sourceActivityId":{
            "type":"string"
        },
        "targetActivityId":{
            "type":"string"
        },
        "dataObjectChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "instanceAttributeChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "correlationKeyChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        }
    }
}

Nested Schema : correlationKeyChanges

Type: array

Show Source

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

Nested Schema : dataObjectChanges

Type: array

Show Source

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

Nested Schema : instanceAttributeChanges

Type: array

Show Source

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

Nested Schema : DataVariable

Type: object

Show Source

• correlationKeyPropertyName: object QName
• name: string
• value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "correlationKeyPropertyName":{
            "$ref":"#/definitions/QName"
        }
    }
}

Nested Schema : QName

Type: object

Show Source

• localPart: string
• namespaceURI: string
• prefix: string

{
    "type":"object",
    "properties":{
        "namespaceURI":{
            "type":"string"
        },
        "localPart":{
            "type":"string"
        },
        "prefix":{
            "type":"string"
        }
    }
}

Nested Schema : identity

Type: object

Discriminator: type

Show Source

• id: string
• identity: object Link
• levels: integer(int32)
• links: array links
• title: string
• type: string

{
    "type":"object",
    "discriminator":"type",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "identity":{
            "$ref":"#/definitions/Link"
        }
    },
    "xml":{
        "name":"identity",
        "namespace":"http://xmlns.oracle.com/bpm/rest/identities"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

400 Response

Malformed parameters

412 Response

Pre condition failed

500 Response

Server error

Back to Top