Jump to

• Request
• Response

Retrieve Wire Messages

get

/ic/api/b2b/v1/monitoring/wiremessages

Retrieves a list of wire messages with information like message type, state, direction, protocol and trading partner. Wire messages represent the technical exchange of messages between the host company and trading partners. These messages can be encrypted and signed AS2.

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

Query Parameters

• limit: integer(int32)
  Use the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list wire messages starting at the 4th item, and the list will contain 16 items.
• offset: integer(int32)
  Use with the offset parameter for paginating through the returned results. Default value is 0. This limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list wire messages starting at the 4th item, and the list will contain 16 items.
• q: string

  Filter parameters.

  • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. Default value is 1h.
  • direction: Message direction. Valid values are INBOUND and OUTBOUND.
  • id: Wire message identifier.
  • startdate: Custom time range start date/time in UTC format for filtering messages.
  • enddate: Custom time range end date/time in UTC format for filtering messages.
  • status: Message status.
  • transportprotocol: Message transport protocol. Valid values are AS2 and FTP.
  • instanceId: Integration instance identifier.
  • errorcode: Value of b2b error code.
  • tradingpartnerid: Trading partner identifier.
  • messagetype: Message type. Valid values are WIRE and MDN.
  • userdefinedid: A message identifier at the wire protocol level, if one is defined for the transport type. For AS2 transport, this is set to the AS2 message Identifier. For FTP transport this field is not available.
  • parentmessageid: Value of wire message identifier. This helps in fetching all acknowledgements correlated to a given wire message identifier.

  Example:

  {startdate:'2020-07-09 07:00:00', enddate:'2020-07-09 21:25:00', id:'0AC415941776251CB5E0000026D27C45', direction:'INBOUND', messagetype:'WIRE'}

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : WireMessagesRs

Match All

Show Source

• object GenericRestRs
• object WireMessagesRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/WireMessageRs"
                    }
                },
                "totalResults":{
                    "type":"integer",
                    "format":"int32"
                },
                "hasMore":{
                    "type":"boolean"
                },
                "limit":{
                    "type":"integer",
                    "format":"int32"
                },
                "dataFetchTime":{
                    "type":"string",
                    "format":"date-time"
                },
                "totalRecordsCount":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : WireMessagesRs-allOf[1]

Type: object

Show Source

• dataFetchTime: string (date-time)
• hasMore: boolean
• items: array items
• limit: integer (int32)
• totalRecordsCount: integer (int32)
• totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WireMessageRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "dataFetchTime":{
            "type":"string",
            "format":"date-time"
        },
        "totalRecordsCount":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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 : items

Type: array

Show Source

• Array of: WireMessageRs

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

Nested 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 : 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 : 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

412 Response

Pre-condition failed

500 Response

Server error

Back to Top