機械翻訳について

移動先

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

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

get

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

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

リクエスト

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

• application/json

問合せパラメータ

• 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: ドキュメントのバージョン。
  • っても: ビジネス識別子の値。
  • 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

ソースを表示

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/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"
        }
    }
}

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

型: array

ソースを表示

• Array of: object businessmessage

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

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

型: array

ソースを表示

• Array of: object SuiteLink

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

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

型: object

ソースを表示

• b2bPayloadId: string
• b2bPayloadSize: string
• canonicalPayloadId: string
• canonicalPayloadSize: string
• correlatedMessages: array correlatedMessages
• createdBy: string
• creationDate: string
• delimiter: string
• direction: string
• documentId: string
• documentStandard: string
• documentType: string
• documentVersion: string
• errorCode: string
• errorDetail: string
• errorSummary: string
• id: string
• identifiers: object identifiers
  許可される追加のプロパティ: additionalProperties
• instanceId: string
• links: array links
• messageType: string
• payload: object payload
• payloadName: string
• processingResults: array processingResults
• referenceToId: string
• state: string
• tradingPartner: string
• transportProperties: object transportProperties
  許可される追加のプロパティ: additionalProperties
• updatedBy: string
• updatedDate: string
• userDefinedId: string
• wireMessageId: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "direction":{
            "type":"string"
        },
        "tradingPartner":{
            "type":"string"
        },
        "creationDate":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "messageType":{
            "type":"string"
        },
        "userDefinedId":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "errorSummary":{
            "type":"string"
        },
        "errorDetail":{
            "type":"string"
        },
        "referenceToId":{
            "type":"string"
        },
        "documentType":{
            "type":"string"
        },
        "documentStandard":{
            "type":"string"
        },
        "documentVersion":{
            "type":"string"
        },
        "documentId":{
            "type":"string"
        },
        "identifiers":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "payloadName":{
            "type":"string"
        },
        "canonicalPayloadId":{
            "type":"string"
        },
        "b2bPayloadId":{
            "type":"string"
        },
        "canonicalPayloadSize":{
            "type":"string"
        },
        "b2bPayloadSize":{
            "type":"string"
        },
        "wireMessageId":{
            "type":"string"
        },
        "delimiter":{
            "type":"string"
        },
        "instanceId":{
            "type":"string"
        },
        "transportProperties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "processingResults":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "payload":{
            "$ref":"#/definitions/Payload"
        },
        "correlatedMessages":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CorrelatedMessage"
            }
        }
    },
    "xml":{
        "name":"businessmessage"
    }
}

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

型: array

ソースを表示

• Array of: object CorrelatedMessage

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CorrelatedMessage"
    }
}

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

型: object

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

ソースを表示

• string

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

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

型: array

ソースを表示

• Array of: object SuiteLink

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

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

型: object

ソースを表示

• action: object action
• comment: object comment
• identities: array identities
• priority: integer(int32)

{
    "type":"object",
    "properties":{
        "identities":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"identities"
                },
                "$ref":"#/definitions/Identity"
            }
        },
        "action":{
            "$ref":"#/definitions/Action"
        },
        "comment":{
            "$ref":"#/definitions/Comment"
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        }
    },
    "xml":{
        "name":"payload",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

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

型: array

ソースを表示

• Array of: string

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

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

型: object

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

ソースを表示

• string

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

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

型: object

ソースを表示

• count: integer(int32)
• label: string

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

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

型: object

ソースを表示

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• abortType: string
• activityChanges: array activityChanges
• assignees: array assignees
• comments: string
• correlationKeyChanges: array correlationKeyChanges
• dataObjectChanges: array dataObjectChanges
• faultActionType: string
• flowId: integer(int64)
• id: string
• instanceAttributeChanges: array instanceAttributeChanges
• processes: array processes
• type: string

{
    "type":"object",
    "properties":{
        "assignees":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Identity"
            }
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "processes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "faultActionType":{
            "type":"string"
        },
        "flowId":{
            "type":"integer",
            "format":"int64"
        },
        "abortType":{
            "type":"string"
        },
        "comments":{
            "type":"string"
        },
        "activityChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FlowChangeItemReq"
            }
        },
        "dataObjectChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "instanceAttributeChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "correlationKeyChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        }
    },
    "xml":{
        "name":"action",
        "namespace":"http://xmlns.oracle.com/bpm/rest/processdef"
    }
}

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

型: object

ソースを表示

• commentScope: string
• commentStr: string
• updatedBy: string
• updateddDate: string
• userId: string

{
    "type":"object",
    "properties":{
        "commentStr":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "updateddDate":{
            "type":"string"
        },
        "commentScope":{
            "type":"string"
        }
    },
    "xml":{
        "name":"comment",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

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

型: array

ソースを表示

• Array of: object identity
  識別子: type

{
    "type":"array",
    "items":{
        "xml":{
            "name":"identities"
        },
        "$ref":"#/definitions/Identity"
    }
}

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

型: array

ソースを表示

• Array of: object FlowChangeItemReq

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FlowChangeItemReq"
    }
}

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

型: array

ソースを表示

• Array of: object identity
  識別子: type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Identity"
    }
}

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

型: array

ソースを表示

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

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

型: array

ソースを表示

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

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

型: array

ソースを表示

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

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

型: array

ソースを表示

• Array of: string

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

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

型: object

ソースを表示

• correlationKeyChanges: array correlationKeyChanges
• dataObjectChanges: array dataObjectChanges
• instanceAttributeChanges: array instanceAttributeChanges
• sourceActivityId: string
• targetActivityId: string

{
    "type":"object",
    "properties":{
        "sourceActivityId":{
            "type":"string"
        },
        "targetActivityId":{
            "type":"string"
        },
        "dataObjectChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "instanceAttributeChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "correlationKeyChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

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

型: array

ソースを表示

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

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

型: array

ソースを表示

• Array of: object DataVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariable"
    }
}

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

型: object

ソースを表示

• correlationKeyPropertyName: object QName
• name: string
• value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "correlationKeyPropertyName":{
            "$ref":"#/definitions/QName"
        }
    }
}

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

型: object

ソースを表示

• localPart: string
• namespaceURI: string
• prefix: string

{
    "type":"object",
    "properties":{
        "namespaceURI":{
            "type":"string"
        },
        "localPart":{
            "type":"string"
        },
        "prefix":{
            "type":"string"
        }
    }
}

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

型: object

識別子: type

ソースを表示

• id: string
• identity: object Link
• levels: integer(int32)
• links: array links
• title: string
• type: string

{
    "type":"object",
    "discriminator":"type",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "identity":{
            "$ref":"#/definitions/Link"
        }
    },
    "xml":{
        "name":"identity",
        "namespace":"http://xmlns.oracle.com/bpm/rest/identities"
    }
}

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

型: object

ソースを表示

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

400レスポンス

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

412レスポンス

事前条件が失敗しました

500レスポンス

サーバー・エラー

先頭に戻る