機械翻訳について

移動先

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

ビジネス・メッセージの取得

get

/ic/api/b2b/v1/monitoring/businessmessages

メッセージ・タイプ、状態、方向、取引先などの情報を含むビジネス・メッセージのリストを取得します。 ビジネス・メッセージは、個々の文書または購買オーダーなどのビジネス・トランザクションを表します。

ノート:

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

リクエスト

問合せパラメータ

• limit: integer(int32)
  戻される結果のページ区切りには、制限パラメータを使用します。 オフセットは、レコードを返す開始ポイントです。 たとえば、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: メッセージ・ステータス。
  • instanceId: 統合インスタンス識別子。
  • errorcode: エラー・コードの値。
  • 取引区分: 取引先識別子。
  • messagetype: メッセージ・タイプ。 有効な値はMSGおよびFAです。
  • userdefinedid: ビジネス・メッセージのユーザー定義識別子は、アウトバウンド・ビジネス・メッセージの「アプリケーション・メッセージ識別子」フィールドの値です。 このフィールドは、アウトバウンド統合のマッピングに使用できます。 マッピングで値が設定されている場合は、ビジネス・メッセージ詳細とともに返されます。
  • documenttype: 記入票タイプ。
  • ドキュメント標準: ドキュメント標準。
  • documentversion: ドキュメントのバージョン。
  • っても: ビジネス識別子の値。
  • parentmessageid: 機能確認識別子の値です。 これは、特定の機能確認識別子に関連するすべてのビジネス・メッセージをフェッチするのに役立ちます。
  • interchangecontrolnumber: 交換管理番号の値。
  • groupcontrolnumber: グループ・コントロール番号の値。
  • transactioncontrolnumber: トランザクション・セット管理番号の値。

  例:

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

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : BusinessMessagesRs

すべてに一致

ソースを表示

• object GenericRestRs
• object BusinessMessagesRs-allOf[1]

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

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

型: object

ソースを表示

• links: array links

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

ネストされたスキーマ : BusinessMessagesRs-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/BusinessMessageRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "totalRecordsCount":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "dataFetchTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

ネストされたスキーマ: 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: BusinessMessageRs

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

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

すべてに一致

ソースを表示

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

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

すべてに一致

ソースを表示

• 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"
                },
                "pipId":{
                    "type":"string"
                },
                "refToCollab":{
                    "type":"string"
                },
                "resubmitType":{
                    "type":"string"
                },
                "resubmittable":{
                    "type":"boolean"
                },
                "resubmitErrorCode":{
                    "type":"string"
                },
                "projectCode":{
                    "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"
        }
    }
}

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

型: object

ソースを表示

• 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
  許可される追加のプロパティ: additionalProperties
• instanceId: string
• messageType: string
• payloadName: string
• pipId: string
• projectCode: string
• referenceToId: string
• refToCollab: string
• resubmitErrorCode: string
• resubmitParentId: string
• resubmitStatus: string
• resubmitSystemNotation: string
• resubmittable: boolean
• resubmitType: 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"
        },
        "pipId":{
            "type":"string"
        },
        "refToCollab":{
            "type":"string"
        },
        "resubmitType":{
            "type":"string"
        },
        "resubmittable":{
            "type":"boolean"
        },
        "resubmitErrorCode":{
            "type":"string"
        },
        "projectCode":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

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

ネストされたスキーマ : 識別子

型: object

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

ソースを表示

• string

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

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

型: array

ソースを表示

• Array of: object BusinessMessageRs.CorrelatedMessage

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

ネストされたスキーマ : BusinessMessageRs.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"
    }
}

ネストされたスキーマ : BusinessMessageRs.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レスポンス

サーバー・エラー

先頭に戻る