Retrieve Business Message Details
get
/ic/api/b2b/v1/monitoring/businessmessages/{id}
Retrieves detailed information about the business message with the specified identifier. Retrieves information such as message type, state, direction and properties.
Request
Path Parameters
-
id(required): string
Business message identifier.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : BusinessMessageBasicRs-allOf[2]
Type:
Show Source
object
-
applicationMessageId: string
-
b2bPayloadId: string
-
b2bPayloadSize: string
-
canonicalPayloadId: string
-
canonicalPayloadSize: string
-
createdBy: string
-
creationDate: string
-
delimiter: string
-
direction: string
-
documentId: string
-
documentStandard: string
-
documentType: string
-
documentVersion: string
-
errorCode: string
-
errorDetail: string
-
errorSummary: string
-
identifiers: object
identifiers
Additional Properties Allowed: additionalProperties
-
instanceId: string
-
messageType: string
-
payloadName: string
-
pipId: string
-
projectCode: string
-
referenceToId: string
-
refToCollab: string
-
resubmitErrorCode: string
-
resubmitParentId: string
-
resubmitStatus: string
-
resubmitSystemNotation: string
-
resubmittable: boolean
-
resubmitType: string
-
state: string
-
tradingPartner: string
-
updatedBy: string
-
updatedDate: string
-
userDefinedId: string
-
wireMessageId: string
400 Response
Malformed parameters
404 Response
Business message not found
412 Response
Pre-condition failed
500 Response
Server error