Indexer

LogoSwagger Editor
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.

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.
*/*
post
POST /egov-indexer/index-operations/index-operations/_legacyindex HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 642

{
  "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
    },
    "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
indexstringOptional
jobIdstringOptional
reindexTopicstringOptional
startTimeinteger · int64Optional
tenantIdstringOptional
totalRecordsinteger · int32Optional
typestringOptional
Responses
200
Success response is calculated tax.
*/*
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
post
POST /egov-indexer/index-operations/index-operations/{key}/_index HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{}
PreviousID GenerationNextLocalisation

Last updated

Was this helpful?