File Store

PreviousEncryption NextID Generation

Last updated 9 months ago

Was this helpful?

Search file url based on tenantid and filestoreid.

get

Search file url.

Query parameters

tenantIdanyRequired

Unique id for a tenant.

fileStoreIdsstringRequired

Unique filestoreids.

Responses

200

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

application/json

400

Error response in case of failures.

application/json

get

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

{
  "filestoreId": [
    "text"
  ]
}

Search file url based on tenantid and tag name.

get

Search file url.

Query parameters

tenantIdanyRequired

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.

application/json

400

Error response in case of failures.

application/json

get

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

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

Get metadata of file based on tenantId and filestoreId.

get

metadata of file.

Query parameters

tenantIdanyRequired

Unique id for a tenant.

fileStoreIdstringRequired

Unique fileStoreId.

Responses

200

Metadata of file map to particulare filestoreId.

application/json

400

Error response in case of failures.

application/json

get

GET /filestore/v1/files/metaData?tenantId=null&fileStoreId=text HTTP/1.1
Host: 
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

tenantIdanyRequired

Unique id for a tenant.

fileStoreIdstringRequired

fileStore id.

Responses

200

Return file binary.

400

Error response in case of failures.

application/json

get

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

No content

Uploads different kinds of files to server.

post

The endpoint for uploading file in the system.

Body

filestringRequired

The file to upload.

tenantIdstringRequired

Unique ulb identifier.

modulestringOptional

module name.

tagstringOptional

tag name.

Responses

200

Success response with filestoreid and tenantid.

application/json

400

Error response in case of failures.

application/json

post

POST /filestore/v1/files HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 62

"file='text'&tenantId='text'&module='text'&tag='text'"

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