Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Template

Suggest column-to-attribute mappings for a not-yet-created template

Given a list of column names parsed client-side from an uploaded file (CP-31960), returns ranked mapping suggestions per column. Columns with a confirmed prior mapping in the tenant-scoped column mapping cache are returned as a single high-confidence suggestion; all other columns are fuzzy-matched against system fields.

post/templates/scratch/suggest-mappings

Headers

tenant-idstring required

Tenant identifier

Request body

jobType'PRACTITIONER' | 'FACILITY' | 'GROUP'
columnNamesstring[]

Response

Suggestions generated successfully

namestring

CSV column header the suggestions apply to, exactly as it appears in the uploaded file.

Example response

[
  {
    "name": "First Name",
    "suggestedMatches": [
      {
        "name": "First Name",
        "mappedKey": "firstName",
        "mappedEntity": "practitioner",
        "entityGroup": "license",
        "validationRegex": "^\\d{10}$",
        "separator": ";"
      }
    ]
  }
]