Filestore

Filestore APIs

API contracts to manage files e.g. images, PDF, XLS etc

Uploads different kinds of files to server.

post

The endpoint for uploading file in the system.

Body

multipart/form-data

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

/files

HTTPcURLJavaScriptPython

POST /filestore/v1/files HTTP/1.1
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 based on tenantid and filestoreid.

get

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.

*/*

A list of values

filestoreIdstring[]Required

400

Error response in case of failures.

*/*

get

/files/url

HTTPcURLJavaScriptPython

GET /filestore/v1/files/url?tenantId=text&fileStoreIds=text HTTP/1.1
Accept: */*

{
  "filestoreId": [
    "text"
  ]
}

Search file url based on tenantid and tag name.

get

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

/files/tag

HTTPcURLJavaScriptPython

GET /filestore/v1/files/tag?tenantId=text&tag=text HTTP/1.1
Accept: */*

{
  "files": [
    {
      "url": "text",
      "contetntType": "text"
    }
  ]
}

Get metadata of file based on tenantId and filestoreId.

get

metadata of file.

Query parameters

tenantIdstring · varcharRequired

Unique id for a tenant.

fileStoreIdstringRequired

Unique fileStoreId.

Responses

200

Metadata of file map to particulare filestoreId.

*/*

Response data cobtains details of files.

fileNamestringOptional

file name.

contetntTypestringOptional

contetnt type of file.

tenantIdstringOptional

Unique ulb identifier.

resourcestringOptional

resource.

fileSizestringOptional

file size.

400

Error response in case of failures.

*/*

get

/files/metaData

HTTPcURLJavaScriptPython

GET /filestore/v1/files/metaData?tenantId=text&fileStoreId=text HTTP/1.1
Accept: */*

{
  "fileName": "text",
  "contetntType": "text",
  "tenantId": "text",
  "resource": "text",
  "fileSize": "text"
}

Search file url based on tenantid and filestoreid.

get

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

/files/id

HTTPcURLJavaScriptPython

GET /filestore/v1/files/id?tenantId=text&fileStoreId=text HTTP/1.1
Accept: */*

No content