Skip to main content

Upload File​

Select

SaaS
Customer Managed

This API uploads a File.

There are two types of Upload:

  • Full File Upload
  • Chunked Upload

1. Full File Upload​

To upload an entire file, pass the following parameters and headers

Headers :

  • FileName = Name of the File
  • FileSize = Total File Size
  • ParentFolderPath = Parent folder path where file to be uploaded
  • FileEOF = 1

Param :

  • uploadType = fullFile Body :
  • Full File Content

2. Upload File By Chunks​

For the first request, pass the below parameters and headers:

Headers:

  • FileName = Name of the File
  • FileSize = Total File Size
  • ParentFolderPath = Parent folder path where file to be uploaded
  • FileEOF = 0

Param :

  • uploadType = chunkedFile
  • forceRestart = true Body :
  • Partial file data

For the requests following:

Headers:

  • uploadType = chunkedFile
  • requestId = Request ID ( Sent in response to first request)
  • FileEOF = 0 (if more chunks are to be uploaded) 1 (if this is the last chunk)

Body:

  • Partial File data
Path Parameters
  • clientId integer required

    Client ID where files has to be uploaded

Query Parameters
  • uploadType string required

    Possible values: [chunkedFile, fullFile]

    Default value: fullFile

    Specify the type of file upload

  • requestId string

    Request ID - To be fetched from the response of first API call

Header Parameters
  • FileName string

    FileName to be uploaded (Base64 encoded)

  • FileSize string

    Size of the file to be uploaded

  • ParentFolderPath string

    base64 encoded parent folder path where file should be uploaded

  • FileEOF integer

    Possible values: [0, 1]

    Indicates whether the upload has end of the file

Responses

OK

Schema
  • chunkOffset integer
  • requestId string
Loading...