POST/Imports/{target}
Builds an import plan from a parsed file and saves it. Nothing is written to the target until Imports_ExecuteImport is called.
Each row is planned as Create, Update or Skip with the reason, using the schema keys from Imports_GetSchema. uniqueAttributeKey matches rows
to existing records and is only valid for targets that can update; leave it empty to create every row. A file is limited to 2,000 rows.
excludedValues skips every row carrying a value, and valueOverrides replaces a raw value before planning. The permission belongs to the import target: EventAdmin on the event for proposalLineItems (event token), OrganizationAdmin for events (organization token).
Path Parameters
| Field | Type | Required | Description |
|---|
| target | string | Required | |
Request Body
| Field | Type | Required | Description |
|---|
| contextId | uuid | Optional | |
| fileName | string | Optional | |
| uniqueAttributeKey | string | Optional | |
| mapping | CreateImportRequestImportColumnMappingRequest[] | Optional | |
| rows | CreateImportRequestImportRowRequest[] | Optional | |
| excludedValues | CreateImportRequestExcludedValueRequest[] | Optional | |
| valueOverrides | CreateImportRequestValueOverrideRequest[] | Optional | |
CreateImportRequestImportColumnMappingRequest
| Field | Type | Description |
|---|
| fileColumn | string| null | |
| attributeKey | string| null | |
| attributePath | string| null | |
CreateImportRequestImportRowRequest
| Field | Type | Description |
|---|
| rowNumber | integer | |
| values | object| null | |
CreateImportRequestExcludedValueRequest
| Field | Type | Description |
|---|
| attributeKey | string| null | |
| rawValue | string| null | |
CreateImportRequestValueOverrideRequest
| Field | Type | Description |
|---|
| attributeKey | string| null | |
| rawValue | string| null | |
| value | string| null | |
Response
| Field | Type | Description |
|---|
| importId | uuid | |
| target | string| null | |
| status | string| null | |
| fileName | string| null | |
| rowCount | integer | |
| createCount | integer | |
| updateCount | integer | |
| noChangeCount | integer | |
| skipCount | integer | |
| plannedDate | date-time| null | |
| executedDate | date-time| null | |
| rows | GetImportResponseImportRowResponse[]| null | |
GetImportResponseImportRowResponse
| Field | Type | Description |
|---|
| rowNumber | integer | |
| plannedOutcome | string| null | |
| matchedRecordId | uuid| null | |
| matchedRecordLabel | string| null | |
| skipReason | string| null | |
| reason | string| null | |
| result | string| null | |
| resolvedValues | object| null | |