FileStorage
This service provides functionality to manage assets and generate pdf. You can upload the assets, get the cdn link for the assets, proxy the assets and many more things.
Default
Default
Operations
POST
# This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob
POST
# This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process
POST
This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob
Uploads an arbitrarily sized buffer or blob.
It has three Major Steps:
* Start
* Upload
* Complete
### Start
Initiates the assets upload using `startUpload`.
It returns the storage link in response.
### Upload
Use the storage link to upload a file (Buffer or Blob) to the File Storage.
Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
### Complete
After successfully upload, call `completeUpload` api to complete the upload process.
This operation will return the url for the uploaded file.
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
organization_id
string
Required
This is organization id
Request body
file_name
string
Required
content_type
string
Required
size
integer
Required
tags
array of string
params
object
Response
200
400
Success. Returns a response containing relaving and absolute_url of storage service
StartResponse
file_name
string
file_path
string
content_type
string
method
string
namespace
string
operation
string
size
integer
upload
object (Upload)
Upload
cdn
object (CDN)
CDN
tags
array of string
Examples
Parameters
namespace:
"test"
organizationId:
"t6hcne7r2ewmc888"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob
startUpload
POST
This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process
Uploads an arbitrarily sized buffer or blob.
It has three Major Steps:
* Start
* Upload
* Complete
### Start
Initiates the assets upload using `startUpload`.
It returns the storage link in response.
### Upload
Use the storage link to upload a file (Buffer or Blob) to the File Storage.
Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
### Complete
After successfully upload, call `completeUpload` api to complete the upload process.
This operation will return the url for the uploaded file.
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
organization_id
string
Required
This is organization id
Request body
file_name
string
Required
file_path
string
Required
content_type
string
Required
method
string
namespace
string
Required
operation
string
Required
size
integer
Required
upload
object (Upload)
Required
Upload
cdn
object (CDN)
Required
CDN
tags
array of string
Response
200
400
Success
CompleteResponse
_id
string
file_name
string
file_path
string
content_type
string
namespace
string
operation
string
size
integer
upload
object (Upload)
Upload
cdn
object (CDN)
CDN
success
boolean
tags
array of string
created_on
string
modified_on
string
created_by
object (CreatedBy)
CreatedBy
Examples
Parameters
namespace:
"test"
organizationId:
"t6hcne7r2ewmc888"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...