Suggest object import mappings

Suggests how source import columns should map into the destination object schema.

POST/api/unstable/objects/by-handle/{handle}/import-mappings/suggest

Suggests how source import columns should map into the destination object schema.

Request Body

application/json

columns*array<>

Source column headers available for mapping.

Example

[
  "Project Name",
  "Stage"
]

sampleRows*array<>

Representative input rows used to infer mappings.

Itemsitems <= 10

Example

[
  {
    "Project Name": "Airport Expansion",
    "Stage": "Qualified"
  }
]

additionalInstructions?string

Extra operator instructions for the mapper.

Lengthlength <= 500

Example"Map Stage to the status field."

schema*

Destination object schema keyed by field handle.

Example

{
  "name": {
    "name": "name",
    "type": "text",
    "required": true
  }
}

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/unstable/objects/by-handle/{handle}/import-mappings/suggest" \  -H "Content-Type: application/json" \  -d '{    "columns": [      "Project Name",      "Stage"    ],    "sampleRows": [      {        "Project Name": "Airport Expansion",        "Stage": "Qualified"      }    ],    "schema": {      "name": {        "name": "name",        "type": "text",        "required": true      }    }  }'

[
  {
    "destinationField": "name",
    "sourceColumn": "Project Name",
    "expression": "concat(first_name, ' ', last_name)",
    "confidence": 0.97,
    "reason": "Column header closely matches the destination field name."
  }
]

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Suggest object import mappings

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`