Decision Support System Ingest

DSS Ingest APIs

API specs to manage and facilitate data ingestion for decision support systems.

API receives the Transaction Details JSON Request and passes it on to

This API receives the Transaction Details JSON Request and passes it on to the Service Layer for further process of persisting into elastic search.

post

/save

Body

dataContextstring

context of the transactional data

dataContextVersionstring

version of the context

dataObjectobject

this contains the transactional object

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/save' \
  --header 'Content-Type: */*' \
  --data '{"dataObject":{}}'

201

400

201

No body

Response for Success State of the API

API use to provide response for external data upload

uploded file get parsed and stores target data to Elastic search.

post

/upload

Body

filestring · binaryrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/upload' \
  --header 'Content-Type: multipart/form-data'

201

400

201

No body

Response for Success State of the API

This api is used for scroll search

Response for Success State of the API

post

/migrate/{indexName}//{version}

Path parameters

indexNamestringrequired

versionstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/migrate/{indexName}/{version}'

201

201

No body

create

This API use to pause a active kafka consumer

get

/pause/{consumerId}

Path parameters

consumerIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/pause/{consumerId}'

200

400

200

true

Response for Success State of the API

This API is to resume a paused kafka consumer

get

/resume/{consumerId}

Path parameters

consumerIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/resume/{consumerId}'

200

400

200

true

Response for Success State of the API