機械翻訳について

移動先

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

SOA-B2Bからの取引パートナの移行

post

/ic/api/b2b/v1/migration/partners/import

アグリーメント、ドキュメント、スキーマ、ホスト識別子など、関連するB2B関連のアーティファクトを含む1つ以上の取引パートナを、エクスポートされたSOA-B2Bデザインタイム・リポジトリzipファイルからインポートします。

リクエスト

問合せパラメータ

• isFileZipOfZip(required): boolean

  インポートされたzipファイルに複数のzipファイルが含まれている場合は、このブール値をtrueに設定します。 デフォルト値はfalseです。

  例:

  ic/api/b2b/v1/migration/partners/import?isFileZipOfZip=true

  デフォルト値: false
• isOverwrite(required): boolean

  既存の取引パートナを上書きし、zipファイルからインポートされた新しい取引パートナに置き換えるには、このブール・フラグをtrueに設定します。 デフォルト値はfalseです。

  例:

  ic/api/b2b/v1/migration/partners/import?isOverwrite=true

  デフォルト値: false

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

• multipart/form-data

リクエスト本文 - multipart/form-data ()

ルート・スキーマ: schema

型: object

ソースを表示

• file: string (binary)
  SOA-B2B取引パートナzipファイルをエクスポートしました。
• option: string

  これはオプションのプロパティです。 このプロパティを使用して、インポートされたファイルのファイル名の表示方法を指定します。 次のオプションが使用できます。

  showDescription: 説明を表示するには、この値をtrueに設定します。

  description: インポートされた取引パートナに対して表示する摘要を指定します。

  documentPrefix: インポートしたドキュメントのファイル名にテキストのプレフィクスを付ける場合は、値を指定します。

  schemaPrefix: インポートされたスキーマのファイル名にテキストのプレフィクスを付ける場合は、値を指定します。

  filter: 含めるフィルタ・オプションと除外フィルタ・オプションがあります。 zipファイルからTP/TPAファイルを含めるには、includeパラメータを使用します。 zipファイルからTP/TPAファイルを除外するには、excludeパラメータを使用します。

  例:

  {"showDescription":"true","description":"IMPORT FROM SOA-B2b ","schemaPrefix":"SCH","documentPrefix":"DOC","filter":{"exclude":{"tpId":["tp_1","tp_2"],"tpa":["tpa_1","tpa_2"]},"include":{"tpId":[],"tpa":[]}}}

{
    "type":"object",
    "properties":{
        "file":{
            "type":"string",
            "description":"Exported SOA-B2B trading partner zip file.",
            "format":"binary"
        },
        "option":{
            "type":"string",
            "description":"<p>This is an optional property. Use this property to specify how you want to display the filenames of the imported files. The following options are available:</p>\n<p>showDescription: Set this value to true to display the description.</p>\n<p>description: Specify the description that you want to show for the imported trading partner.</p>\n<p>documentPrefix: Specify a value if you want to prefix any text to the filenames of the imported documents.</p>\n<p>schemaPrefix: Specify a value if you want to prefix any text to the file names of the imported schemas.</p>\n<p>filter: You have include and exclude filter options. To include TP/TPA files from the zip file, use the include parameter. To exclude TP/TPA files from the zip file, use the exclude parameter.</p>\n<p>\n<b>Example:</b> \n</p> \n <pre>{\"showDescription\":\"true\",\"description\":\"IMPORT FROM SOA-B2b \",\"schemaPrefix\":\"SCH\",\"documentPrefix\":\"DOC\",\"filter\":{\"exclude\":{\"tpId\":[\"tp_1\",\"tp_2\"],\"tpa\":[\"tpa_1\",\"tpa_2\"]},\"include\":{\"tpId\":[],\"tpa\":[]}}}</pre>",
            "nullable":true
        }
    }
}

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : TPMigrationImportRestResponse

すべてに一致

ソースを表示

• object GenericRestRs
• object TPMigrationImportRestResponse-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "required":[
                "option",
                "response"
            ],
            "type":"object",
            "properties":{
                "response":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TPMigrationService.ServiceResponse"
                    }
                },
                "option":{
                    "$ref":"#/components/schemas/ImportOption"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• links: array links

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

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

型: object

ソースを表示

• option(required): object ImportOption
• response(required): array response

{
    "required":[
        "option",
        "response"
    ],
    "type":"object",
    "properties":{
        "response":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TPMigrationService.ServiceResponse"
            }
        },
        "option":{
            "$ref":"#/components/schemas/ImportOption"
        }
    }
}

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

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

型: object

ソースを表示

• debug: string
• description: string
• documentPrefix: string
• filter: object ImportOption.Filter
• schemaPrefix: string
• showDescription: string

{
    "type":"object",
    "properties":{
        "debug":{
            "type":"string"
        },
        "showDescription":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "schemaPrefix":{
            "type":"string"
        },
        "documentPrefix":{
            "type":"string"
        },
        "filter":{
            "$ref":"#/components/schemas/ImportOption.Filter"
        }
    }
}

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

型: array

ソースを表示

• Array of: object TPMigrationService.ServiceResponse

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TPMigrationService.ServiceResponse"
    }
}

ネストされたスキーマ : ImportOption.Filter

型: object

ソースを表示

• exclude: object ImportOption.Attribute
• include: object ImportOption.Attribute

{
    "type":"object",
    "properties":{
        "exclude":{
            "$ref":"#/components/schemas/ImportOption.Attribute"
        },
        "include":{
            "$ref":"#/components/schemas/ImportOption.Attribute"
        }
    }
}

ネストされたスキーマ : ImportOption.Attribute

型: object

ソースを表示

• tpa: array tpa
• tpId: array tpId

{
    "type":"object",
    "properties":{
        "tpId":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "tpa":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: string

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

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

型: array

ソースを表示

• Array of: string

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

ネストされたスキーマ : TPMigrationService.ServiceResponse

型: object

ソースを表示

• _execution: object TPMigrationService.Summary
• importStatus(required): string
• report(required): array report
• zipfileName: string

{
    "required":[
        "importStatus",
        "report"
    ],
    "type":"object",
    "properties":{
        "importStatus":{
            "type":"string"
        },
        "report":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport"
            }
        },
        "zipfileName":{
            "type":"string"
        },
        "_execution":{
            "$ref":"#/components/schemas/TPMigrationService.Summary"
        }
    }
}

ネストされたスキーマ : TPMigrationService.Summary

型: object

ソースを表示

• importTimeInMillis: integer (int64)
• noOfDocumentImported: string
• noOfInboundAgreementImported: string
• noOfOutboundAgreementImported: string
• noOfSchemaImported: string
• noOfTransportImported: string
• parseTimeInMillis: integer (int64)
• totalTimeInMillis: integer (int64)

{
    "type":"object",
    "properties":{
        "noOfTransportImported":{
            "type":"string"
        },
        "noOfInboundAgreementImported":{
            "type":"string"
        },
        "noOfOutboundAgreementImported":{
            "type":"string"
        },
        "noOfDocumentImported":{
            "type":"string"
        },
        "noOfSchemaImported":{
            "type":"string"
        },
        "parseTimeInMillis":{
            "type":"integer",
            "format":"int64"
        },
        "importTimeInMillis":{
            "type":"integer",
            "format":"int64"
        },
        "totalTimeInMillis":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: array

ソースを表示

• Array of: object ProcessingReport

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

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

型: object

ソースを表示

• artifacts: object ProcessingReport.State
• status: string
• summary: string
• tpId: string
• tpName: string

{
    "type":"object",
    "properties":{
        "tpId":{
            "type":"string"
        },
        "tpName":{
            "type":"string"
        },
        "artifacts":{
            "$ref":"#/components/schemas/ProcessingReport.State"
        },
        "status":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : ProcessingReport.State

型: object

ソースを表示

• document: array document
• error: array error
• hostIdentifier: array hostIdentifier
• ignoredAgreement: array ignoredAgreement
• inboundAgreement: array inboundAgreement
• outboundAgreement: array outboundAgreement
• schema: array schema
• transport: array transport

{
    "type":"object",
    "properties":{
        "transport":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "inboundAgreement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "outboundAgreement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "document":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "schema":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "hostIdentifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "error":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Error"
            }
        },
        "ignoredAgreement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

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

型: array

ソースを表示

• Array of: object Error

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

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

型: array

ソースを表示

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

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

型: array

ソースを表示

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

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

型: array

ソースを表示

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

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

型: array

ソースを表示

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

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

型: array

ソースを表示

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

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

型: array

ソースを表示

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

ネストされたスキーマ : ProcessingReport.Status

型: object

ソースを表示

• id: string
• name: string
• reason: string
• status: string

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

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

型: object

ソースを表示

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

400レスポンス

不正リクエスト

404レスポンス

見つかりません

409レスポンス

重複データ・エラー

412レスポンス

前提条件の失敗

500レスポンス

サーバー・エラー

先頭に戻る