File Store

https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/filestore-service-contract.yml

API Contract Link

Uploads different kinds of files to server.

The endpoint for uploading file in the system.

POST/filestore/v1/files

Body

multipart/form-data

file*string (binary)

The file to upload.

tenantId*string

Unique ulb identifier.

modulestring

module name.

tagstring

tag name.

Response

200400

Success response with filestoreid and tenantid.

Body

*/*

filesarray of UploadFile (object)

Request

JavaScriptCurlPython

const response = await fetch('/filestore/v1/files', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "file": "binary",
      "tenantId": "text"
    }),
});
const data = await response.json();

Response

200

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

Search file url based on tenantid and filestoreid.

Search file url.

GET/filestore/v1/files/url

Query parameters

Response

200400

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

Body

*/*

filestoreId*array of string

Request

JavaScriptCurlPython

const response = await fetch('/filestore/v1/files/url?tenantId=text&fileStoreIds=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "filestoreId": [
    "text"
  ]
}

Search file url based on tenantid and tag name.

Search file url.

GET/filestore/v1/files/tag

Query parameters

Response

200400

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

Body

*/*

filesarray of TagFile (object)

Request

JavaScriptCurlPython

const response = await fetch('/filestore/v1/files/tag?tenantId=text&tag=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Get metadata of file based on tenantId and filestoreId.

metadata of file.

GET/filestore/v1/files/metaData

Query parameters

Response

200400

Metadata of file map to particulare filestoreId.

Body

*/*

fileNamestring

file name.

contetntTypestring

contetnt type of file.

tenantIdstring

Unique ulb identifier.

resourcestring

resource.

fileSizestring

file size.

Request

JavaScriptCurlPython

const response = await fetch('/filestore/v1/files/metaData?tenantId=text&fileStoreId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Search file url based on tenantid and filestoreid.

Search file url.

GET/filestore/v1/files/id

Query parameters

Response

200400

Return file binary.

Request

JavaScriptCurlPython

const response = await fetch('/filestore/v1/files/id?tenantId=text&fileStoreId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();