Filestore

Filestore APIs

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

Uploads different kinds of files to server.

The endpoint for uploading file in the system.

post

/files

Body

filestring · binaryrequired

The file to upload.

tenantIdstringrequired

Unique ulb identifier.

modulestring

module name.

tagstring

tag name.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/filestore/v1/files' \
  --header 'Content-Type: multipart/form-data'

200

400

200

{
  "files": [
    {
      "fileStoreId": "text",
      "tenantId": "text"
    }
  ]
}

Success response with filestoreid and tenantid.

Search file url based on tenantid and filestoreid.

Search file url.

get

/files/url

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

fileStoreIdsstringrequired

Unique filestoreids.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/filestore/v1/files/url?tenantId=text&fileStoreIds=text'

200

400

200

{
  "filestoreId": [
    "text"
  ]
}

List of urls to access the uploaded file which is map to particular fielstoreid.

Search file url based on tenantid and tag name.

Search file url.

get

/files/tag

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

tagstringrequired

tag name.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/filestore/v1/files/tag?tenantId=text&tag=text'

200

400

200

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

List of urls to access the uploaded file which is map to particular tag name.

Get metadata of file based on tenantId and filestoreId.

metadata of file.

get

/files/metaData

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

fileStoreIdstringrequired

Unique fileStoreId.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/filestore/v1/files/metaData?tenantId=text&fileStoreId=text'

200

400

200

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

Metadata of file map to particulare filestoreId.

Search file url based on tenantid and filestoreid.

Search file url.

get

/files/id

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

fileStoreIdstringrequired

fileStore id.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/filestore/v1/files/id?tenantId=text&fileStoreId=text'

200

400

200

No body

Return file binary.