Filestore
Filestore APIs
API contracts to manage files e.g. images, PDF, XLS etc
The endpoint for uploading file in the system.
Body
filestring · binaryRequired
The file to upload.
tenantIdstringRequired
Unique ulb identifier.
modulestringOptional
module name.
tagstringOptional
tag name.
Responses
200
Success response with filestoreid and tenantid.
*/*
400
Error response in case of failures.
*/*
post
POST /filestore/v1/files HTTP/1.1
Host:
Content-Type: multipart/form-data
Accept: */*
Content-Length: 64
{
"file": "binary",
"tenantId": "text",
"module": "text",
"tag": "text"
}
{
"files": [
{
"fileStoreId": "text",
"tenantId": "text"
}
]
}
Search file url.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
fileStoreIdsstringRequired
Unique filestoreids.
Responses
200
List of urls to access the uploaded file which is map to particular fielstoreid.
*/*
400
Error response in case of failures.
*/*
get
GET /filestore/v1/files/url?tenantId=text&fileStoreIds=text HTTP/1.1
Host:
Accept: */*
{
"filestoreId": [
"text"
]
}
Search file url.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
tagstringRequired
tag name.
Responses
200
List of urls to access the uploaded file which is map to particular tag name.
*/*
400
Error response in case of failures.
*/*
get
GET /filestore/v1/files/tag?tenantId=text&tag=text HTTP/1.1
Host:
Accept: */*
{
"files": [
{
"url": "text",
"contetntType": "text"
}
]
}
metadata of file.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
fileStoreIdstringRequired
Unique fileStoreId.
Responses
200
Metadata of file map to particulare filestoreId.
*/*
400
Error response in case of failures.
*/*
get
GET /filestore/v1/files/metaData?tenantId=text&fileStoreId=text HTTP/1.1
Host:
Accept: */*
{
"fileName": "text",
"contetntType": "text",
"tenantId": "text",
"resource": "text",
"fileSize": "text"
}
Search file url.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
fileStoreIdstringRequired
fileStore id.
Responses
200
Return file binary.
400
Error response in case of failures.
*/*
get
GET /filestore/v1/files/id?tenantId=text&fileStoreId=text HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?