Kafka Mapper Get Configuration

List All Kafka Mapper Configurations

Request

URI

GET

https://{api_host}/v1/kafkamapper/mappings

COPY

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns all Kafka Mapper Configurations

Returns KafkaMapperConfigResponse of type(s) application/json

{
    "total": 6,
    "pageCount": 1,
    "entity": [
        {
            "metadata": {
                "enabled": true,
                "description": "KMD RegEx Desc",
                "keys": [
                    "string"
                ],
                "type": "json_metrics"
            },
            "default": {
                "mapping": {
                    "metricType": "$.properties.devtype",
                    "instance": "$.properties.instance",
                    "properties.entityName": "$.properties.table",
                    "properties.entityType": "$.properties.type",
                    "processedTimestamp": "$.timestamp",
                    "metrics": "$.metrics.*.value",
                    "type": "Kafka-Metrics-Defn",
                    "properties.dataSource": "$.properties.ip",
                    "properties.deviceName": "$.properties.devdesc",
                    "timestamp": "$.timestamp",
                    "properties.deviceType": "$.properties.devtype",
                    "tags": "$.relations.*.type"
                }
            }
        }
    ]
}

integer

total

Required

Constraints: default: 0

Total count of mapping in the database

integer

pageCount

Required

Constraints: default: 0

Total number of pages in the response object

array of object

entity

Required

Object contains a map, where key is the mapping name, and the value is an object of mapping metadata and json mapping

400

Invalid Request sent by the user