Indexer

Swagger API Contract Link

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.

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

POST/egov-indexer/index-operations/index-operations/_legacyindex
Body

legacyIndexRequest

RequestInfoRequestInfo (object)
apiDetailsAPIDetails (object)
jobIdstring
legacyIndexTopicstring
startTimeinteger (int64)
tenantIdstring
totalRecordsinteger (int32)
Response

Success response is calculated tax.

Body
ResponseInfoResponseInfo (object)
urlstring
messagestring
jobIdstring
Request
const response = await fetch('/egov-indexer/index-operations/index-operations/_legacyindex', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "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.

Reindex data from one index to another

POST/egov-indexer/index-operations/index-operations/_reindex
Body

reindexRequest

RequestInfoRequestInfo (object)
batchSizeinteger (int32)
indexstring
jobIdstring
reindexTopicstring
startTimeinteger (int64)
tenantIdstring
totalRecordsinteger (int32)
typestring
Response

Success response is calculated tax.

Body
ResponseInfoResponseInfo (object)
urlstring
totalRecordsToBeIndexednumber
estimatedTimestring
messagestring
jobIdstring
Request
const response = await fetch('/egov-indexer/index-operations/index-operations/_reindex', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "text"
  },
  "url": "text",
  "totalRecordsToBeIndexed": 0,
  "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.

Index request to index one record on an index

POST/egov-indexer/index-operations/index-operations/{key}/_index
Path parameters
key*string

key

Body

indexJson

object
Response

OK

Body
object
Request
const response = await fetch('/egov-indexer/index-operations/index-operations/{key}/_index', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Last updated

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