機械翻訳について

移動先

• リクエスト
• レスポンス

ワイヤー・メッセージの取得

get

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

メッセージ・タイプ、状態、方向、プロトコル、取引先などの情報を含むワイヤー・メッセージのリストを取得します。 ワイヤー・メッセージは、ホスト会社と取引先間のメッセージの技術交換を表します。 これらのメッセージは、暗号化してAS2に署名できます。

ノート:

トラッキング情報は非同期に保持され、システム・スループットが向上するため、B2BモニタリングAPIは一貫性のない結果を断続的に返す可能性があります。 ビジネス・ユース・ケースで一貫したモニタリング結果が必要な場合は、APIが一貫した結果を返すまで、再試行メカニズムを使用するソフトウェア設計を実装できます。

リクエスト

問合せパラメータ

• limit: integer(int32)
  返される結果をページングするには、limitパラメータを使用します。 オフセットは、レコードを返す開始ポイントです。 たとえば、offset=3&limit=16は、4番目のアイテムから始まるワイヤー・メッセージを一覧表示し、リストには16個のアイテムが含まれます。
• offset: integer(int32)
  返される結果のページ区切りには、オフセット・パラメータを使用します。 デフォルト値は0です。 この制限は、一度に返品するアイテムの最大数です。 たとえば、offset=3&limit=16は、4番目のアイテムから始まるワイヤー・メッセージを一覧表示し、リストには16個のアイテムが含まれます。
• q: string

  フィルタ・パラメータ

  • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. デフォルト値は1hです。
  • direction: メッセージの方向。 有効な値はINBOUNDおよびOUTBOUNDです。
  • id: ワイヤー・メッセージ識別子。
  • startdate: メッセージのフィルタリング用のUTC形式のカスタム時間範囲開始日時。
  • enddate: メッセージのフィルタリング用のUTC形式のカスタム時間範囲終了日時。
  • status: メッセージ・ステータス。
  • transportprotocol: メッセージ・トランスポート・プロトコル。 有効な値は、AS2およびFTPです。
  • instanceId: 統合インスタンス識別子。
  • errorcode: b2bエラー・コードの値。
  • 取引区分: 取引先識別子。
  • messagetype: メッセージ・タイプ。 有効な値はWIREおよびMDNです。
  • userdefinedid: トランスポート・タイプにメッセージ識別子が定義されている場合、ワイヤー・プロトコル・レベルのメッセージ識別子。 AS2トランスポートの場合、これはAS2メッセージ識別子に設定されます。 FTPトランスポートの場合、このフィールドは使用できません。
  • parentmessageid: ワイヤー・メッセージ識別子の値。 これは、特定のワイヤー・メッセージ識別子に関連するすべての確認をフェッチするのに役立ちます。

  例:

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

この操作のリクエスト本文がありません。

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : WireMessagesRs

すべてに一致

ソースを表示

• 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"
                }
            }
        }
    ]
}

ネストされたスキーマ : GenericRestRs

型: object

ソースを表示

• links: array links

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

ネストされたスキーマ : WireMessagesRs-allOf[1]

型: object

ソースを表示

• 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"
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object SuiteLink

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

ネストされたスキーマ : SuiteLink

型: object

ソースを表示

• 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"
        }
    }
}

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: WireMessageRs

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

ネストされたスキーマ : WireMessageRs

すべてに一致

ソースを表示

• 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"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : WireMessageBasicRs

すべてに一致

ソースを表示

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "state":{
                    "type":"string"
                },
                "transportProtocol":{
                    "type":"string"
                },
                "url":{
                    "type":"string"
                },
                "protocolMessageId":{
                    "type":"string"
                },
                "resubmitStatus":{
                    "type":"string"
                },
                "resubmitCount":{
                    "type":"integer",
                    "format":"int32"
                },
                "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"
                },
                "resubmitParentId":{
                    "type":"string"
                },
                "resubmitSystemNotation":{
                    "type":"string"
                },
                "comments":{
                    "type":"string"
                },
                "resubmitType":{
                    "type":"string"
                },
                "projectCode":{
                    "type":"string"
                },
                "resubmittable":{
                    "type":"boolean"
                },
                "resubmitErrorCode":{
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : IdRs

すべてに一致

ソースを表示

• object GenericRestRs
• object IdRs-allOf[1]

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

ネストされたスキーマ : IdRs-allOf[1]

型: object

ソースを表示

• id: string

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

ネストされたスキーマ : WireMessageBasicRs-allOf[2]

型: object

ソースを表示

• ackState: string
• comments: string
• createdBy: string
• creationDate: string
• direction: string
• errorCode: string
• errorDetail: string
• errorSummary: string
• instanceId: string
• messageType: string
• packedPayloadId: string
• packedPayloadSize: string
• payloadName: string
• projectCode: string
• protocolMessageId: string
• referenceToId: string
• resubmitCount: integer (int32)
• resubmitErrorCode: string
• resubmitParentId: string
• resubmitStatus: string
• resubmitSystemNotation: string
• resubmittable: boolean
• resubmitType: 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":{
        "state":{
            "type":"string"
        },
        "transportProtocol":{
            "type":"string"
        },
        "url":{
            "type":"string"
        },
        "protocolMessageId":{
            "type":"string"
        },
        "resubmitStatus":{
            "type":"string"
        },
        "resubmitCount":{
            "type":"integer",
            "format":"int32"
        },
        "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"
        },
        "resubmitParentId":{
            "type":"string"
        },
        "resubmitSystemNotation":{
            "type":"string"
        },
        "comments":{
            "type":"string"
        },
        "resubmitType":{
            "type":"string"
        },
        "projectCode":{
            "type":"string"
        },
        "resubmittable":{
            "type":"boolean"
        },
        "resubmitErrorCode":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : WireMessageRs-allOf[3]

型: object

ソースを表示

• correlatedMessages: array correlatedMessages
• payload: object WireMessageRs.Payload
• processingResults: array processingResults
• transportProperties: object transportProperties
  許可される追加のプロパティ: 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"
            }
        }
    }
}

ネストされたスキーマ : correlatedMessages

型: array

ソースを表示

• Array of: object WireMessageRs.CorrelatedMessage

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

ネストされたスキーマ : WireMessageRs.Payload

型: object

ソースを表示

• links: array links

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

ネストされたスキーマ : processingResults

型: array

ソースを表示

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : transportProperties

型: object

使用可能なその他のプロパティ

ソースを表示

• string

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

ネストされたスキーマ : WireMessageRs.CorrelatedMessage

型: object

ソースを表示

• count(必須): integer (int32)
• label(必須): string

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object SuiteLink

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

400レスポンス

パラメータの形式が正しくありません

412レスポンス

前提条件が失敗しました

500レスポンス

サーバー・エラー

先頭に戻る