DIGIT Specifications
PlatformUrbanHealthPublic FinanceSanitation
  • Specifications Overview
    • Standardisation Approach
  • Common Service Specs
    • Access Control
    • Analytics
    • Billing
    • Collection
    • Dashboard Analytics
    • Decision Support System Ingest
    • Document Controller
    • Employee
    • Encryption
    • Filestore
    • ID Generation
    • Inbox
    • Indexer
    • Master
    • Master Data Management
    • OTP
    • Payment Gateway
    • PDF Generation
    • URL Shortening
    • User
    • Workflow
  • Domain Service Specs
    • Attendance
    • Bank Account
    • Billing Calculator
    • Birth-Death
    • Building Plan Approval
    • Building Plan Calculator
    • Campaign
    • Campaign Delivery
    • Contracts
    • Estimates
    • eChallan
    • Facility
    • Faecal Sludge Management (FSM)
    • Fire NOC
    • Fire NOC Calculator
    • Household
    • Individual
    • Inventory
    • Land
    • Muster Roll
    • National Dashboard Ingest
    • No Objection Certificate
    • Organization
    • Planning
    • Product
    • Project
    • Property Registry
    • Property Tax Calculator
    • Public Grievance Redressal
    • Registration
    • Sewerage Connection
    • Stock
    • Supervision
    • Sync
    • Trade Licence
    • Trade Licence Calculator
    • User Events
    • Vehicle Registration
    • Vendor Registration
    • Water Connection
  • Archived-docs
    • DIGIT Urban Service Specs
      • Property Tax Service
        • Property Tax Taxonomy
        • Property Tax Data Model
        • Property Tax Service API
      • Public Grievance Redressal Service
        • Public Grievance Redressal Taxonomy
        • Public Grievance Redressal Data Model
        • Public Grievance Redressal Service API
      • Trade License Service
        • Trade License Taxonomy
        • Trade License Data Model
        • Trade License API
      • Fire NOC Service
        • Fire NOC Taxonomy
        • Fire NOC Data Model
        • Fire NOC API
      • Miscellaneous Collection Service
        • Miscellaneous Collections Taxonomy
        • Miscellaneous Collections Data Model
        • Miscellaneous Collection API
      • Online Building Plan Approval Service
        • Online Building Plan Approval Taxonomy
        • Online Building Plan Approval Data Model
        • Online Building Plan Approval Service API
      • Water & Sewerage Service
        • Water & Sewerage Taxonomy
        • Water Service Data Model
        • Sewerage Service Data Model
        • Water & Sewerage Service API
      • Birth & Death Service
        • Birth & Death Taxonomy
        • Birth & Death Data Model
        • Birth & Death Service API
    • DIGIT Public Finance Management Service Specs
      • iFIX Master Data Service API
      • Adapter Master Data Service API
      • mGramSeva iFIX Adapter Service API
      • iFIX Department Entity Service API
      • Fiscal Event API
    • DIGIT Health Service Specs
      • Health Service Data Model
      • Health Service API
    • DIGIT Sanitation Service Specs
      • Faecal Sludge Management Service
        • Faecal Sludge Management Data Model
        • Faecal Sludge Management Service API
Powered by GitBook

​All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

On this page

Was this helpful?

Export as PDF
  1. Common Service Specs

Filestore

PreviousEncryptionNextID Generation

Last updated 2 years ago

Was this helpful?

Filestore APIs

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

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.
*/*
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 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
GET /filestore/v1/files/tag?tenantId=text&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
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 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
GET /filestore/v1/files/id?tenantId=text&fileStoreId=text HTTP/1.1
Host: 
Accept: */*

No content

  • Filestore APIs
  • POSTUploads different kinds of files to server.
  • GETSearch file url based on tenantid and filestoreid.
  • GETSearch file url based on tenantid and tag name.
  • GETGet metadata of file based on tenantId and filestoreId.
  • GETSearch file url based on tenantid and filestoreid.

Uploads different kinds of files to server.

post

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"
    }
  ]
}