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.

POSThttps://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/save

Body

*/*

dataContextstring

context of the transactional data

dataContextVersionstring

version of the context

dataObjectobject

this contains the transactional object

Response

201400

Response for Success State of the API

Request

JavaScriptCurl

const response = await fetch('https://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/save', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

API use to provide response for external data upload

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

POSThttps://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/upload

Body

multipart/form-data

file*string (binary)

Response

201400

Response for Success State of the API

Request

JavaScriptCurl

const response = await fetch('https://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/upload', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "file": "binary"
    }),
});
const data = await response.json();

This api is used for scroll search

Response for Success State of the API

POSThttps://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/migrate/{indexName}/{version}

Path parameters

indexName*string

version*string

Response

201

create

Request

JavaScriptCurl

const response = await fetch('https://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/migrate/{indexName}/{version}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

This API use to pause a active kafka consumer

GEThttps://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/pause/{consumerId}

Path parameters

consumerId*string

Response

200400

Response for Success State of the API

Body

application/json

Response (boolean)

Request

JavaScriptCurl

const response = await fetch('https://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/pause/{consumerId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

false

This API is to resume a paused kafka consumer

GEThttps://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/resume/{consumerId}

Path parameters

consumerId*string

Response

200400

Response for Success State of the API

Body

application/json

Response (boolean)

Request

JavaScriptCurl

const response = await fetch('https://egov-micro-dev.egovernments.org/dashboard-ingest/ingest/[APIEndPoint]/resume/{consumerId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

false