AcademyDesign SystemFeedback

DSS Ingest

https://raw.githubusercontent.com/egovernments/business-services/master/Docs/dss-dashboard/DSS%20Ingest%20YAML%20Spec%201.0.0.yaml
API Contract Link

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

post

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
POST /dashboard-ingest/ingest/[APIEndPoint]/save HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 66

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

API use to provide response for external data upload

post

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

Body
filestringRequired
Responses
201
Response for Success State of the API
post
POST /dashboard-ingest/ingest/[APIEndPoint]/upload HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 15

"file='text'"
No content

This api is used for scroll search

post

Response for Success State of the API

Path parameters
indexNamestringRequired
versionstringRequired
Responses
201
create
post
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
Path parameters
consumerIdstringRequired
Responses
200
Response for Success State of the API
application/json
Responseboolean
get
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
Path parameters
consumerIdstringRequired
Responses
200
Response for Success State of the API
application/json
Responseboolean
get
GET /dashboard-ingest/ingest/[APIEndPoint]/resume/{consumerId} HTTP/1.1
Host: egov-micro-dev.egovernments.org
Accept: */*

true
PreviousCollectionNextHRMS

Last updated

Was this helpful?