Key Mapping

​

Overview

• Renaming object fields to match a target schema
• Extracting nested values and promoting them to top-level keys
• Applying consistent field naming across all objects in a collection

​

Command Type

​

Parameters

​

KeyMapping

​

Usage Examples

​

Rename Fields

{
  "command": "key-mapping",
  "params": {
    "mapping": [
      { "from": "$.eventId", "to": "id" },
      { "from": "$.eventName", "to": "name" },
      { "from": "$.startTime", "to": "startsAt" }
    ]
  }
}

​

Promote Nested Fields

{
  "command": "key-mapping",
  "params": {
    "mapping": [
      { "from": "$.event.id", "to": "eventId" },
      { "from": "$.event.sport.id", "to": "sportId" },
      { "from": "$.event.league.id", "to": "leagueId" }
    ]
  }
}

​

Map Without Source Path

{
  "command": "key-mapping",
  "params": {
    "mapping": [
      { "to": "payload" }
    ]
  }
}

​

Common Use Cases

• Schema Normalization: Rename incoming fields to match your internal schema
• Field Promotion: Lift nested values to the top level for easier access
• Data Standardization: Apply consistent field naming across multiple data sources

​

Related Commands

• Key Mapping With JSONPath - Extract and map using complex JSONPath
• Object Mapper - Full object transformation with mapping config
• Transform By JDM - Transform using JDM mapping rules