移動先

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

マルチパート・ファイル・アップロードの作成

post

/essbase/rest/v1/files/upload-create/{path}

パートでのファイル・アップロードを初期化します。この操作はファイル・オブジェクトを登録し、一意のアップロードIDを返します。このIDを、このファイルパート・アップロードに関連するリクエストに含める必要があります。

マルチパート・ファイル・アップロードは、アップロードを並列化してスレッドに分けることで、そのパフォーマンスを向上させることができます。また、マルチパート・アップロードにより、ネットワーク障害時に大量のアップロードを再開する必要がなくなります。

この操作は、マルチパート・ファイル・アップロード・プロセスの最初のステップです。その後のステップで、ファイル・パートをアップロードし、アップロードをコミットします。

関連項目

• ファイル・パートのアップロード
• ファイルの部分アップロードのコミット
• マルチパート・ファイル・アップロードの中止

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• path(required): string
  パターン: .+

  ファイルのアップロード先にするフォルダのカタログ・パス。

問合せパラメータ

• overwrite(required): boolean

  ファイルが存在する場合に上書きするかどうか。

  デフォルト値: false

ヘッダー・パラメータ

• append(required): boolean

  既存のファイルに付加するかどうか。

  デフォルト値: false

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

ファイルが正常に登録されました。一意のIDを返します。

本体()

ルート・スキーマ : CreateFilePartUploadResponse

型: object

ソースの表示

• bucket: string
• namespace: string
• object: string
• timeCreated: string
• uploadId: string

{
    "type":"object",
    "properties":{
        "uploadId":{
            "type":"string"
        },
        "namespace":{
            "type":"string"
        },
        "object":{
            "type":"string"
        },
        "timeCreated":{
            "type":"string"
        },
        "bucket":{
            "type":"string"
        }
    }
}

400 レスポンス

不正なリクエスト

ログインしているユーザーに適切な権限がないか、そのファイルがすでに存在する可能性があります。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、Essbaseファイル・カタログ内のユーザー・ディレクトリへのマルチパート・ファイル・アップロードを開始する方法を示します。入力として、パス・パラメータに宛先のカタログ・パス(ファイル名を含む)が必要です。レスポンスとして、EssbaseはuploadIdを返します。これを、ファイル・パートをアップロードおよびコミットする(または、マルチパート・ファイル・アップロード・プロセスを終了する)際に渡す必要があります。

この操作は、マルチパート・ファイル・アップロード・プロセスの最初のステップです。操作のフローは、次のとおりです。

1. マルチパート・ファイル・アップロードの作成(この例のとおり)

2. ファイル・パートのアップロード

3. マルチパート・ファイル・アップロードのコミット

初期化ステップ後の任意の時点で、「マルチパート・ファイル・アップロードの中止」を使用してプロセスを終了できます。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/files/upload-create/users/admin/datafile.txt?overwrite=false?append=false" -H "Accept:application/json" -u %User%:%Password%

レスポンス本体の例

{
  "uploadId" : "2695fc23-ca67-4e9a-a0a5-b1dbe370eb17"
}

先頭に戻る