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.

post

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

Body

RequestInfoobjectoptional

apiDetailsobjectoptional

jobIdstringoptional

legacyIndexTopicstringoptional

startTimeinteger · int64optional

tenantIdstringoptional

totalRecordsinteger · int32optional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-indexer/index-operations/index-operations/_legacyindex' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
  }'

200

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "text"
  },
  "url": "text",
  "message": "text",
  "jobId": "text"
}

Success response is calculated tax.

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

RequestInfoobjectrequired

batchSizeinteger · int32optional

indexstringrequired

jobIdstringoptional

reindexTopicstringrequired

startTimeinteger · int64optional

tenantIdstringrequired

totalRecordsinteger · int32optional

typestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-indexer/index-operations/index-operations/_reindex' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

200

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "text"
  },
  "url": "text",
  "totalRecordsToBeIndexed": 1,
  "estimatedTime": "text",
  "message": "text",
  "jobId": "text"
}

Success response is calculated tax.

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

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-indexer/index-operations/index-operations/{key}/_index' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

201

401

403

404

200

{}

OK