PlatformUrbanSanitation

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

post
/save

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

Body
dataContextstringOptional

context of the transactional data

dataContextVersionstringOptional

version of the context

dataObjectobjectOptional

this contains the transactional object

Responses
201

Response for Success State of the API

post
/save
POST /dashboard-ingest/ingest/[APIEndPoint]/save HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: */*
Accept: */*
Content-Length: 66

{
  "dataContext": "text",
  "dataContextVersion": "text",
  "dataObject": {}
}
No content

API use to provide response for external data upload

post
/upload

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

Body
filestring · binaryRequired
Responses
201

Response for Success State of the API

post
/upload
POST /dashboard-ingest/ingest/[APIEndPoint]/upload HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
No content

This api is used for scroll search

post
/migrate/{indexName}/{version}

Response for Success State of the API

Path parameters
indexNamestringRequired
versionstringRequired
Responses
201

create

post
/migrate/{indexName}/{version}
POST /dashboard-ingest/ingest/[APIEndPoint]/migrate/{indexName}/{version} HTTP/1.1
Host: egov-micro-dev.egovernments.org
Accept: */*
201

create

No content

This API use to pause a active kafka consumer

get
/pause/{consumerId}
Path parameters
consumerIdstringRequired
Responses
200

Response for Success State of the API

application/json
Responseboolean
get
/pause/{consumerId}
GET /dashboard-ingest/ingest/[APIEndPoint]/pause/{consumerId} HTTP/1.1
Host: egov-micro-dev.egovernments.org
Accept: */*

true

This API is to resume a paused kafka consumer

get
/resume/{consumerId}
Path parameters
consumerIdstringRequired
Responses
200

Response for Success State of the API

application/json
Responseboolean
get
/resume/{consumerId}
GET /dashboard-ingest/ingest/[APIEndPoint]/resume/{consumerId} HTTP/1.1
Host: egov-micro-dev.egovernments.org
Accept: */*

true
PreviousDashboard AnalyticsNextDocument Controller

Last updated

Was this helpful?