Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : BusinessMessageRs

Match All

Show Source

• allOf BusinessMessageBasicRs
• allOf IdRs
• object GenericRestRs
• object BusinessMessageRs-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BusinessMessageBasicRs"
        },
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "transportProperties":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                },
                "processingResults":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "payload":{
                    "$ref":"#/components/schemas/BusinessMessageRs.Payload"
                },
                "correlatedMessages":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/BusinessMessageRs.CorrelatedMessage"
                    }
                }
            }
        }
    ]
}

Nested Schema : BusinessMessageBasicRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object BusinessMessageBasicRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "resubmitStatus":{
                    "type":"string"
                },
                "resubmitParentId":{
                    "type":"string"
                },
                "resubmitSystemNotation":{
                    "type":"string"
                },
                "applicationMessageId":{
                    "type":"string"
                },
                "identifiers":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                },
                "state":{
                    "type":"string"
                },
                "direction":{
                    "type":"string"
                },
                "tradingPartner":{
                    "type":"string"
                },
                "creationDate":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "updatedBy":{
                    "type":"string"
                },
                "messageType":{
                    "type":"string"
                },
                "errorCode":{
                    "type":"string"
                },
                "errorSummary":{
                    "type":"string"
                },
                "errorDetail":{
                    "type":"string"
                },
                "referenceToId":{
                    "type":"string"
                },
                "userDefinedId":{
                    "type":"string"
                },
                "documentType":{
                    "type":"string"
                },
                "payloadName":{
                    "type":"string"
                },
                "canonicalPayloadId":{
                    "type":"string"
                },
                "b2bPayloadId":{
                    "type":"string"
                },
                "canonicalPayloadSize":{
                    "type":"string"
                },
                "b2bPayloadSize":{
                    "type":"string"
                },
                "createdBy":{
                    "type":"string"
                },
                "wireMessageId":{
                    "type":"string"
                },
                "documentStandard":{
                    "type":"string"
                },
                "documentVersion":{
                    "type":"string"
                },
                "documentId":{
                    "type":"string"
                },
                "delimiter":{
                    "type":"string"
                },
                "instanceId":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : BusinessMessageBasicRs-allOf[2]

Type: object

Show Source

• 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
• referenceToId: string
• resubmitParentId: string
• resubmitStatus: string
• resubmitSystemNotation: string
• state: string
• tradingPartner: string
• updatedBy: string
• updatedDate: string
• userDefinedId: string
• wireMessageId: string

{
    "type":"object",
    "properties":{
        "resubmitStatus":{
            "type":"string"
        },
        "resubmitParentId":{
            "type":"string"
        },
        "resubmitSystemNotation":{
            "type":"string"
        },
        "applicationMessageId":{
            "type":"string"
        },
        "identifiers":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "state":{
            "type":"string"
        },
        "direction":{
            "type":"string"
        },
        "tradingPartner":{
            "type":"string"
        },
        "creationDate":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "messageType":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "errorSummary":{
            "type":"string"
        },
        "errorDetail":{
            "type":"string"
        },
        "referenceToId":{
            "type":"string"
        },
        "userDefinedId":{
            "type":"string"
        },
        "documentType":{
            "type":"string"
        },
        "payloadName":{
            "type":"string"
        },
        "canonicalPayloadId":{
            "type":"string"
        },
        "b2bPayloadId":{
            "type":"string"
        },
        "canonicalPayloadSize":{
            "type":"string"
        },
        "b2bPayloadSize":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "wireMessageId":{
            "type":"string"
        },
        "documentStandard":{
            "type":"string"
        },
        "documentVersion":{
            "type":"string"
        },
        "documentId":{
            "type":"string"
        },
        "delimiter":{
            "type":"string"
        },
        "instanceId":{
            "type":"string"
        }
    }
}

Nested Schema : BusinessMessageRs-allOf[3]

Type: object

Show Source

• correlatedMessages: array correlatedMessages
• payload: object BusinessMessageRs.Payload
• processingResults: array processingResults
• transportProperties: object transportProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "transportProperties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "processingResults":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "payload":{
            "$ref":"#/components/schemas/BusinessMessageRs.Payload"
        },
        "correlatedMessages":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BusinessMessageRs.CorrelatedMessage"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : identifiers

Type: object

Additional Properties Allowed

Show Source

• string

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

Nested Schema : correlatedMessages

Type: array

Show Source

• Array of: object BusinessMessageRs.CorrelatedMessage

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BusinessMessageRs.CorrelatedMessage"
    }
}

Nested Schema : BusinessMessageRs.Payload

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

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 : BusinessMessageRs.CorrelatedMessage

Type: object

Show Source

• count: integer (int32)
• label: string

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

400 Response

Malformed parameters

404 Response

Business message not found

412 Response

Pre-condition failed

500 Response

Server error

Back to Top