機械翻訳について

移動先

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

B2Bドキュメントのインポート

post

/ic/api/b2b/v1/projects/{projectId}/b2bdocuments/import

B2Bドキュメントとその関連スキーマを、プロジェクト・コンテキストで以前にエクスポートされたドキュメントzipファイルからインポートします。

リクエスト

パス・パラメータ

• projectId(required): string
  プロジェクト識別子

問合せパラメータ

• isOverwrite(required): boolean

  フラグを上書きして、zipファイルのコンポーネントを上書きします。 デフォルト値はfalse

  例:

  /b2b/v1/projects/PROJECTID/b2bdocuments/import?isOverwrite=true

  デフォルト値: false

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

• multipart/form-data

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

ルート・スキーマ: schema

型: object

ソースを表示

• file: string (binary)
  以前にエクスポートされたドキュメントZIPファイル。

{
    "type":"object",
    "properties":{
        "file":{
            "type":"string",
            "description":"Previously exported Document ZIP file.",
            "format":"binary"
        }
    }
}

トップに戻る

レスポンス

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

• application/json

201レスポンス

操作の成功

本文()

ルート・スキーマ : ImportDocRs

すべてに一致

ソースを表示

• object GenericRestRs
• object ImportDocRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "required":[
                "documents",
                "schemas"
            ],
            "type":"object",
            "properties":{
                "documents":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
                    }
                },
                "schemas":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
                    }
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• links: array links

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

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

型: object

ソースを表示

• documents(required): array documents
• schemas(required): array schemas

{
    "required":[
        "documents",
        "schemas"
    ],
    "type":"object",
    "properties":{
        "documents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
            }
        },
        "schemas":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
            }
        }
    }
}

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

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

型: array

ソースを表示

• Array of: object ImportDocRs.ImportDocStatus

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
    }
}

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

型: array

ソースを表示

• Array of: object ImportDocRs.ImportDocStatus

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
    }
}

ネストされたスキーマ : ImportDocRs.ImportDocStatus

型: object

ソースを表示

• id(required): string
• name(required): string
• status(required): string

{
    "required":[
        "id",
        "name",
        "status"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

404レスポンス

見つかりません

409レスポンス

重複データ・エラー

500レスポンス

サーバー・エラー

先頭に戻る