Suggest object import mappings

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

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

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

Path Parameters

handle*string

Stable handle used in routes and lookups.

Example"projects"

Request Body

application/json

Request payload for Suggest object import mappings.

columns*array<>

Source column headers available for mapping.

Example

[
  "Project Name",
  "Stage"
]

sampleRows*array<>

Representative input rows used to infer mappings.

Itemsitems <= 10

additionalInstructions?|

additional instructions.

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/objects/by-handle/projects/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,
    "reason": "Column header closely matches the destination field name."
  }
]

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Suggest object import mappings

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`