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
Supported Media Types
- application/json
Path Parameters
-
id(required): string
Business Message identifier.
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : businessmessage
Type:
Show Source
object
-
b2bPayloadId:
string
-
b2bPayloadSize:
string
-
canonicalPayloadId:
string
-
canonicalPayloadSize:
string
- correlatedMessages: array correlatedMessages
-
createdBy:
string
-
creationDate:
string
-
delimiter:
string
-
direction:
string
-
documentId:
string
-
documentStandard:
string
-
documentType:
string
-
documentVersion:
string
-
errorCode:
string
-
errorDetail:
string
-
errorSummary:
string
-
id:
string
-
identifiers:
object identifiers
Additional Properties Allowed: additionalProperties
-
instanceId:
string
-
links:
array links
-
messageType:
string
-
payload:
object payload
-
payloadName:
string
-
processingResults:
array processingResults
-
referenceToId:
string
-
state:
string
-
tradingPartner:
string
-
transportProperties:
object transportProperties
Additional Properties Allowed: additionalProperties
-
updatedBy:
string
-
updatedDate:
string
-
userDefinedId:
string
-
wireMessageId:
string
Nested Schema : action
Type:
Show Source
object
-
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
400 Response
Malformed parameters
404 Response
Business message not found
412 Response
Pre condition failed
500 Response
Server error