Kafka Mapper Get Configuration

Kafka Mapper Get Configuration

List All Kafka Mapper Configurations

Request
URI
GET
https://{api_host}/tcsa.host.com/v1/kafkamapper/mappings
COPY
Authentication
This operation uses the following authentication methods.
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

Total count of mapping in the database

integer
pageCount
Required

Total number of pages in the response object

entity
Required

entity


400

Invalid Request sent by the user

Operation doesn't return any data structure

401

User authentication failed

Operation doesn't return any data structure

403

Access to the requested resource/operation is forbidden

Operation doesn't return any data structure

404

Cannot find requested resource

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure