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

Indexer

PreviousInboxNextMaster

Last updated 2 years ago

Was this helpful?

Indexer Service APIs

API to enrich and push events. Events can be used for providing unified inbox, analytics etc.

  • Indexer Service APIs
  • POSTThis endpoint is used to start legacy index job to reindex records from DB. The data is fetched from DB by calling api mentioned in request in batches. The is useful when some record is present in DB but missing on index.
  • POSTThis endpoint is used to start indexing job to reindex records from one index to another index.
  • POSTThis endpoint is used to index one record on a index. The information to pick correct config is provided with the data to be indexed.

This endpoint is used to start legacy index job to reindex records from DB. The data is fetched from DB by calling api mentioned in request in batches. The is useful when some record is present in DB but missing on index.

post

Initiate legacy index job to index data from DB fetched by calling some api

Body
jobIdstringOptional
legacyIndexTopicstringOptional
startTimeinteger · int64Optional
tenantIdstringOptional
totalRecordsinteger · int32Optional
Responses
200
Success response is calculated tax.
*/*
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /egov-indexer/index-operations/index-operations/_legacyindex HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 657

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "authToken": "text",
    "correlationId": "text",
    "userInfo": {
      "id": 1,
      "userName": "text",
      "name": "text",
      "type": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "id": 1,
          "name": "text",
          "code": "text"
        }
      ],
      "tenantId": "text",
      "uuid": "text"
    }
  },
  "apiDetails": {
    "customQueryParam": "text",
    "paginationDetails": {
      "maxPageSize": 1,
      "offsetKey": "text",
      "sizeKey": "text",
      "startingOffset": 1,
      "maxRecords": 1
    },
    "request": {},
    "responseJsonPath": "text",
    "tenantIdForOpenSearch": "text",
    "uri": "text"
  },
  "jobId": "text",
  "legacyIndexTopic": "text",
  "startTime": 1,
  "tenantId": "text",
  "totalRecords": 1
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "text"
  },
  "url": "text",
  "message": "text",
  "jobId": "text"
}

This endpoint is used to start indexing job to reindex records from one index to another index.

post

Reindex data from one index to another

Body
batchSizeinteger · int32Optional
indexstringRequired
jobIdstringOptional
reindexTopicstringRequired
startTimeinteger · int64Optional
tenantIdstringRequired
totalRecordsinteger · int32Optional
typestringRequired
Responses
200
Success response is calculated tax.
*/*
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /egov-indexer/index-operations/index-operations/_reindex HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 464

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "authToken": "text",
    "correlationId": "text",
    "userInfo": {
      "id": 1,
      "userName": "text",
      "name": "text",
      "type": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "id": 1,
          "name": "text",
          "code": "text"
        }
      ],
      "tenantId": "text",
      "uuid": "text"
    }
  },
  "batchSize": 1,
  "index": "text",
  "jobId": "text",
  "reindexTopic": "text",
  "startTime": 1,
  "tenantId": "text",
  "totalRecords": 1,
  "type": "text"
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "text"
  },
  "url": "text",
  "totalRecordsToBeIndexed": 1,
  "estimatedTime": "text",
  "message": "text",
  "jobId": "text"
}

This endpoint is used to index one record on a index. The information to pick correct config is provided with the data to be indexed.

post

Index request to index one record on an index

Path parameters
keystringRequired

key

Body
objectOptional
Responses
200
OK
*/*
Responseobject
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /egov-indexer/index-operations/index-operations/{key}/_index HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{}