Jump to

• Request
• Response
• Examples

Create Multipart File Upload

post

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

Initialize a file upload in parts. This operation registers the file object and returns a unique upload ID, which must be included in any request related to this file-part upload.

Multipart file upload can improve performance of uploads by parallelizing them into threads. Multipart upload also protects against needing to restart large uploads in case of network failures.

This operation is the first step in the multi-part file upload process. The next steps are to upload the file parts, and then commit the upload.

See Also

• Upload File Part
• Commit Partial File Upload
• Abort Multipart File Upload

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• path: string
  Pattern: .+

  Catalog path of the folder to which you want to upload the file.

Query Parameters

• overwrite: boolean

  Overwrite if file exists?

  Default Value: false

Header Parameters

• append: boolean

  Append to an existing file?

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

File registered successfully. Returns unique ID.

Body ()

Root Schema : CreateFilePartUploadResponse

Type: object

Show Source

• bucket(optional): string
• namespace(optional): string
• object(optional): string
• timeCreated(optional): string
• uploadId(optional): string

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

400 Response

Bad Request

Logged in user may not have appropriate permissions, or the file may already exist.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to initiate a multi-part file upload to a user directory in the Essbase file catalog. This example uses cURL to access the REST API from a Windows shell script. As input, path parameters require the destination catalog path, including filename. As a response, Essbase returns an uploadId that you need to pass in when you upload and commit the file parts (or terminate the multi-part file upload process).

This operation is the first step in the multi-part file upload process. The flow of operations is as follows:

1. Create Multipart File Upload (shown in this example)

2. Upload File Part

3. Commit Multipart File Upload

At any point after the initialization step, you can terminate the process using Abort Multipart File Upload.

The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

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%

Example of Response Body

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

Back to Top