Indexer

Indexer Service APIs

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

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

application/json

legacyIndexRequest

RequestInfoRequestInfo (object)

apiDetailsAPIDetails (object)

jobIdstring

legacyIndexTopicstring

startTimeinteger (int64)

tenantIdstring

totalRecordsinteger (int32)

Response

200401403404

Success response is calculated tax.

Body

*/*

ResponseInfoResponseInfo (object)

urlstring

messagestring

jobIdstring

Request

JavaScriptCurl

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

application/json

reindexRequest

RequestInfo*RequestInfo (object)

batchSizeinteger (int32)

index*string

jobIdstring

reindexTopic*string

startTimeinteger (int64)

tenantId*string

totalRecordsinteger (int32)

type*string

Response

200401403404

Success response is calculated tax.

Body

*/*

ResponseInfoResponseInfo (object)

urlstring

totalRecordsToBeIndexednumber

estimatedTimestring

messagestring

jobIdstring

Request

JavaScriptCurl

const response = await fetch('/egov-indexer/index-operations/index-operations/_reindex', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "authToken": "text",
        "correlationId": "text",
        "did": "text",
        "key": "text",
        "msgId": "text",
        "userInfo": {
          "emailId": "text",
          "mobileNumber": "text",
          "name": "text",
          "roles": [
            {
              "code": "text",
              "name": "text"
            }
          ],
          "tenantId": "text",
          "type": "text",
          "userName": "text",
          "uuid": "text"
        },
        "ver": "text"
      },
      "index": "text",
      "reindexTopic": "text",
      "tenantId": "text",
      "type": "text"
    }),
});
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

application/json

indexJson

object

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

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