Jump to

• Request
• Response

Retrieve Wire Message Details

get

/ic/api/b2b/v1/monitoring/wiremessages/{id}

Retrieves detailed information about the wire message with the specified identifier. Retrieves information such as message type, state, direction, protocol and properties.

Note: Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results.

Request

Path Parameters

• id(required): string
  Wire 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 : WireMessageRs

Match All

Show Source

• allOf WireMessageBasicRs
• allOf IdRs
• object GenericRestRs
• object WireMessageRs-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WireMessageBasicRs"
        },
        {
            "$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/WireMessageRs.Payload"
                },
                "correlatedMessages":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/WireMessageRs.CorrelatedMessage"
                    }
                }
            }
        }
    ]
}

Nested Schema : WireMessageBasicRs

Match All

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "resubmitParentId":{
                    "type":"string"
                },
                "resubmitSystemNotation":{
                    "type":"string"
                },
                "state":{
                    "type":"string"
                },
                "transportProtocol":{
                    "type":"string"
                },
                "url":{
                    "type":"string"
                },
                "protocolMessageId":{
                    "type":"string"
                },
                "resubmitCount":{
                    "type":"integer",
                    "format":"int32"
                },
                "resubmitStatus":{
                    "type":"string"
                },
                "direction":{
                    "type":"string"
                },
                "tradingPartner":{
                    "type":"string"
                },
                "source":{
                    "type":"string"
                },
                "creationDate":{
                    "type":"string"
                },
                "payloadName":{
                    "type":"string"
                },
                "messageType":{
                    "type":"string"
                },
                "userDefinedId":{
                    "type":"string"
                },
                "instanceId":{
                    "type":"string"
                },
                "errorCode":{
                    "type":"string"
                },
                "errorSummary":{
                    "type":"string"
                },
                "errorDetail":{
                    "type":"string"
                },
                "referenceToId":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "updatedBy":{
                    "type":"string"
                },
                "packedPayloadId":{
                    "type":"string"
                },
                "packedPayloadSize":{
                    "type":"string"
                },
                "unpackedPayloadId":{
                    "type":"string"
                },
                "unpackedPayloadSize":{
                    "type":"string"
                },
                "createdBy":{
                    "type":"string"
                },
                "ackState":{
                    "type":"string"
                },
                "transportName":{
                    "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 : WireMessageBasicRs-allOf[2]

Type: object

Show Source

• ackState: string
• createdBy: string
• creationDate: string
• direction: string
• errorCode: string
• errorDetail: string
• errorSummary: string
• instanceId: string
• messageType: string
• packedPayloadId: string
• packedPayloadSize: string
• payloadName: string
• protocolMessageId: string
• referenceToId: string
• resubmitCount: integer (int32)
• resubmitParentId: string
• resubmitStatus: string
• resubmitSystemNotation: string
• source: string
• state: string
• tradingPartner: string
• transportName: string
• transportProtocol: string
• unpackedPayloadId: string
• unpackedPayloadSize: string
• updatedBy: string
• updatedDate: string
• url: string
• userDefinedId: string

{
    "type":"object",
    "properties":{
        "resubmitParentId":{
            "type":"string"
        },
        "resubmitSystemNotation":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "transportProtocol":{
            "type":"string"
        },
        "url":{
            "type":"string"
        },
        "protocolMessageId":{
            "type":"string"
        },
        "resubmitCount":{
            "type":"integer",
            "format":"int32"
        },
        "resubmitStatus":{
            "type":"string"
        },
        "direction":{
            "type":"string"
        },
        "tradingPartner":{
            "type":"string"
        },
        "source":{
            "type":"string"
        },
        "creationDate":{
            "type":"string"
        },
        "payloadName":{
            "type":"string"
        },
        "messageType":{
            "type":"string"
        },
        "userDefinedId":{
            "type":"string"
        },
        "instanceId":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "errorSummary":{
            "type":"string"
        },
        "errorDetail":{
            "type":"string"
        },
        "referenceToId":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "packedPayloadId":{
            "type":"string"
        },
        "packedPayloadSize":{
            "type":"string"
        },
        "unpackedPayloadId":{
            "type":"string"
        },
        "unpackedPayloadSize":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "ackState":{
            "type":"string"
        },
        "transportName":{
            "type":"string"
        }
    }
}

Nested Schema : WireMessageRs-allOf[3]

Type: object

Show Source

• correlatedMessages: array correlatedMessages
• payload: object WireMessageRs.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/WireMessageRs.Payload"
        },
        "correlatedMessages":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WireMessageRs.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 : correlatedMessages

Type: array

Show Source

• Array of: object WireMessageRs.CorrelatedMessage

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

Nested Schema : WireMessageRs.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 : WireMessageRs.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

Wire message not found

412 Response

Pre-condition failed

500 Response

Server error

Back to Top