機械翻訳について

移動先

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

B2Bドキュメントの更新

put

/ic/api/b2b/v1/b2bdocuments/{documentId}

指定されたドキュメントIDでB2Bドキュメントを更新します。 アクティブな契約で使用される文書を変更するには、最初に非アクティブ化する必要があります。

リクエスト

パス・パラメータ

• documentId(required): string

  B2BドキュメントID。

  例:

  /b2b/v1/b2bdocuments/DOC123

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

ソースを表示

• documentUi: schema

{
    "type":"object",
    "properties":{
        "documentUi":{
            "$ref":"#/components/schemas/DocumentUI"
        }
    }
}

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

すべてに一致

ソースを表示

• allOf ViewModel
• object GenericRestRs
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ViewModel"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "activeAgr":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AgreementUI"
                    }
                },
                "inActiveAgr":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AgreementUI"
                    }
                },
                "parameters":{
                    "type":"string"
                },
                "businessIdentifiers":{
                    "$ref":"#/components/schemas/BusinessIdentifierUI"
                },
                "partnerCnt":{
                    "type":"integer",
                    "format":"int32"
                },
                "schema":{
                    "type":"string"
                },
                "state":{
                    "type":"string"
                },
                "schemaName":{
                    "type":"string"
                },
                "active":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IntegrationResourceUI"
                    }
                },
                "inActive":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IntegrationResourceUI"
                    }
                }
            }
        }
    ]
}

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

すべてに一致

ソースを表示

• object GenericRestRs
• object ViewModel-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "createdBy":{
                    "type":"string"
                },
                "updatedBy":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "txName":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                },
                "txId":{
                    "type":"string"
                },
                "std":{
                    "type":"string"
                },
                "version":{
                    "type":"string"
                },
                "desc":{
                    "type":"string"
                },
                "count":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• links: array links

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

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

型: object

ソースを表示

• count: integer (int32)
• createdBy: string
• createdDate: string
• desc: string
• id: string
• name: string
• std: string
• txId: string
• txName: string
• updatedBy: string
• updatedDate: string
• version: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "txName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "txId":{
            "type":"string"
        },
        "std":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: object

ソースを表示

• active: array active
• activeAgr: array activeAgr
• businessIdentifiers: object BusinessIdentifierUI
• inActive: array inActive
• inActiveAgr: array inActiveAgr
• parameters: string
• partnerCnt: integer (int32)
• schema: string
• schemaName: string
• state: string

{
    "type":"object",
    "properties":{
        "activeAgr":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementUI"
            }
        },
        "inActiveAgr":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementUI"
            }
        },
        "parameters":{
            "type":"string"
        },
        "businessIdentifiers":{
            "$ref":"#/components/schemas/BusinessIdentifierUI"
        },
        "partnerCnt":{
            "type":"integer",
            "format":"int32"
        },
        "schema":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "schemaName":{
            "type":"string"
        },
        "active":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationResourceUI"
            }
        },
        "inActive":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationResourceUI"
            }
        }
    }
}

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

ネストされたスキーマ : アクティブ

型: array

ソースを表示

• Array of: IntegrationResourceUI

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

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

型: array

ソースを表示

• Array of: AgreementUI

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

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

型: object

ソースを表示

• bizIdName1: string
• bizIdName2: string
• bizIdName3: string
• bizIdXpath1: string
• bizIdXpath2: string
• bizIdXpath3: string

{
    "type":"object",
    "properties":{
        "bizIdName1":{
            "type":"string"
        },
        "bizIdXpath1":{
            "type":"string"
        },
        "bizIdName2":{
            "type":"string"
        },
        "bizIdXpath2":{
            "type":"string"
        },
        "bizIdName3":{
            "type":"string"
        },
        "bizIdXpath3":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

• Array of: IntegrationResourceUI

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

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

型: array

ソースを表示

• Array of: AgreementUI

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

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

すべてに一致

ソースを表示

• allOf ViewModel
• object GenericRestRs
• object IntegrationResourceUI-allOf[2]

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

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

型: object

ソースを表示

• id: string
• name: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    }
}

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

すべてに一致

ソースを表示

• allOf ViewModel
• object GenericRestRs
• object AgreementUI-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ViewModel"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "deployStatus":{
                    "type":"string"
                },
                "direction":{
                    "type":"string"
                },
                "agrID":{
                    "type":"string"
                },
                "tpId":{
                    "type":"string"
                },
                "docId":{
                    "type":"string"
                },
                "agrName":{
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• agrID: string
• agrName: string
• deployStatus: string
• direction: string
• docId: string
• tpId: string

{
    "type":"object",
    "properties":{
        "deployStatus":{
            "type":"string"
        },
        "direction":{
            "type":"string"
        },
        "agrID":{
            "type":"string"
        },
        "tpId":{
            "type":"string"
        },
        "docId":{
            "type":"string"
        },
        "agrName":{
            "type":"string"
        }
    }
}

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf ViewModel
• object GenericRestRs
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ViewModel"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "activeAgr":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AgreementUI"
                    }
                },
                "inActiveAgr":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AgreementUI"
                    }
                },
                "parameters":{
                    "type":"string"
                },
                "businessIdentifiers":{
                    "$ref":"#/components/schemas/BusinessIdentifierUI"
                },
                "partnerCnt":{
                    "type":"integer",
                    "format":"int32"
                },
                "schema":{
                    "type":"string"
                },
                "state":{
                    "type":"string"
                },
                "schemaName":{
                    "type":"string"
                },
                "active":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IntegrationResourceUI"
                    }
                },
                "inActive":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IntegrationResourceUI"
                    }
                }
            }
        }
    ]
}

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

すべてに一致

ソースを表示

• object GenericRestRs
• object ViewModel-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "createdBy":{
                    "type":"string"
                },
                "updatedBy":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "txName":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                },
                "txId":{
                    "type":"string"
                },
                "std":{
                    "type":"string"
                },
                "version":{
                    "type":"string"
                },
                "desc":{
                    "type":"string"
                },
                "count":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• links: array links

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

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

型: object

ソースを表示

• count: integer (int32)
• createdBy: string
• createdDate: string
• desc: string
• id: string
• name: string
• std: string
• txId: string
• txName: string
• updatedBy: string
• updatedDate: string
• version: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "txName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "txId":{
            "type":"string"
        },
        "std":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: object

ソースを表示

• active: array active
• activeAgr: array activeAgr
• businessIdentifiers: object BusinessIdentifierUI
• inActive: array inActive
• inActiveAgr: array inActiveAgr
• parameters: string
• partnerCnt: integer (int32)
• schema: string
• schemaName: string
• state: string

{
    "type":"object",
    "properties":{
        "activeAgr":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementUI"
            }
        },
        "inActiveAgr":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementUI"
            }
        },
        "parameters":{
            "type":"string"
        },
        "businessIdentifiers":{
            "$ref":"#/components/schemas/BusinessIdentifierUI"
        },
        "partnerCnt":{
            "type":"integer",
            "format":"int32"
        },
        "schema":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "schemaName":{
            "type":"string"
        },
        "active":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationResourceUI"
            }
        },
        "inActive":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationResourceUI"
            }
        }
    }
}

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

ネストされたスキーマ : アクティブ

型: array

ソースを表示

• Array of: IntegrationResourceUI

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

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

型: array

ソースを表示

• Array of: AgreementUI

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

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

型: object

ソースを表示

• bizIdName1: string
• bizIdName2: string
• bizIdName3: string
• bizIdXpath1: string
• bizIdXpath2: string
• bizIdXpath3: string

{
    "type":"object",
    "properties":{
        "bizIdName1":{
            "type":"string"
        },
        "bizIdXpath1":{
            "type":"string"
        },
        "bizIdName2":{
            "type":"string"
        },
        "bizIdXpath2":{
            "type":"string"
        },
        "bizIdName3":{
            "type":"string"
        },
        "bizIdXpath3":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

• Array of: IntegrationResourceUI

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

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

型: array

ソースを表示

• Array of: AgreementUI

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

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

すべてに一致

ソースを表示

• allOf ViewModel
• object GenericRestRs
• object IntegrationResourceUI-allOf[2]

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

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

型: object

ソースを表示

• id: string
• name: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    }
}

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

すべてに一致

ソースを表示

• allOf ViewModel
• object GenericRestRs
• object AgreementUI-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ViewModel"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "deployStatus":{
                    "type":"string"
                },
                "direction":{
                    "type":"string"
                },
                "agrID":{
                    "type":"string"
                },
                "tpId":{
                    "type":"string"
                },
                "docId":{
                    "type":"string"
                },
                "agrName":{
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• agrID: string
• agrName: string
• deployStatus: string
• direction: string
• docId: string
• tpId: string

{
    "type":"object",
    "properties":{
        "deployStatus":{
            "type":"string"
        },
        "direction":{
            "type":"string"
        },
        "agrID":{
            "type":"string"
        },
        "tpId":{
            "type":"string"
        },
        "docId":{
            "type":"string"
        },
        "agrName":{
            "type":"string"
        }
    }
}

400レスポンス

不正なリクエスト、不正なパラメータ、または必須データがありません

412レスポンス

前提条件の失敗。 名前の長さが50文字を超えず、識別子の長さが32文字を超えず、復号の長さが1024文字を超えず、識別子の長さが32文字を超えないようにしてください。 名前および識別子の名前がStandardまたはDefaultでないことを確認してください。 std、versionおよびtxIdの有効な組合せがあることを確認してください。

500レスポンス

サーバー・エラー

先頭に戻る