DataMapping

Create a Data Mapping

Create a new data mapping to connect an external data source to this Memory Store. For DATASET_CLOUDAPP and DATASET_WAREHOUSE types, validates that all mapped Trait Groups and traits exist and that dataset field data types match their respective mapped trait data types.

post/v1/ControlPlane/Stores/{storeId}/DataMappings

Request body

displayNamestring required

Name of the data mapping.

descriptionstring

A human readable description of this resource, up to 512 characters.

isEnabledboolean

Flag indicating whether the data mapping is active. When true, data will be ingested and mapped according to the configuration. When false, the data mapping will be inactive and no data will be ingested into the Memory Store.

Example request

{
  "displayName": "crm-contacts",
  "description": "Syncs customer data from CRM dataset to profile traits",
  "isEnabled": true,
  "mappingTo": {
    "type": "TRAITS",
    "mappings": [
      {
        "expression": "primary_email",
        "traitGroup": "Contact",
        "traitName": "email"
      }
    ]
  },
  "mappingFrom": {
    "type": "INGRESS",
    "columns": [
      "first_name",
      "last_name",
      "email",
      "favorite_color"
    ]
  }
}

Response

Data mapping creation request accepted.

messagestring
statusUrlstring

URI to check operation status.

Example response

{
  "message": "Data mapping creation request accepted for processing."
}

Changes

Changed in 3 of the 8 revisions of this API.925

  • v149499262215f11See the full diff
    • removed DataMappingFromCSV DataMappingFromDataSet from the mappingFrom request property oneOf list

      request-property-one-of-removed

    • removed CSV DATASET discriminator mapping keys from the mappingFrom request property

      request-property-discriminator-mapping-deleted

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added INGRESS DATASET_CLOUDAPP DATASET_WAREHOUSE discriminator mapping keys to the mappingFrom request property

      request-property-discriminator-mapping-added

    • added DataMappingFromIngress DataMappingFromCloudAppDataSet DataMappingFromWarehouseDataSet to the mappingFrom request property oneOf list

      request-property-one-of-added

  • v1b0ed05460bbf822See the full diff
    • the request property mappingTo/oneOf[DataMappingToTraits]/mappings/items/expression became required

      request-property-became-required

    • the displayName request property's maxLength was decreased to 64

      request-property-max-length-decreased

    • the code response property's max was increased from 99999.00 to 999999.00 for the response status 400

      response-property-max-increased

    • the code response property's max was increased from 99999.00 to 999999.00 for the response status 404

      response-property-max-increased

    • the code response property's max was increased from 99999.00 to 999999.00 for the response status 409

      response-property-max-increased

    • the code response property's max was increased from 99999.00 to 999999.00 for the response status 429

      response-property-max-increased

    • the code response property's max was increased from 99999.00 to 999999.00 for the response status 500

      response-property-max-increased

    • the code response property's max was increased from 99999.00 to 999999.00 for the response status 503

      response-property-max-increased

    • changed the pattern of the request property displayName from ^[a-zA-Z][a-zA-Z0-9-_.]*$ to ^[a-zA-Z][a-zA-Z0-9-.]*$

      request-property-pattern-changed

    • removed the request property mappingTo/oneOf[DataMappingToTraits]/mappings/items/fieldName

      request-property-removed

    • added CSV discriminator mapping keys to the mappingFrom request property

      request-property-discriminator-mapping-added

    • added DataMappingFromCSV to the mappingFrom request property oneOf list

      request-property-one-of-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 8 revisions, 1 has no diff computed.