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