GET/Imports/{target}/schema
Lists the attributes a spreadsheet column can be mapped onto for an import target. Call it when the mapping step opens. target is
proposalLineItems or events (case-insensitive). contextId is the proposal for proposalLineItems and the event type for events, whose
custom attributes it adds; omit it for events to get only the built-in fields. An attribute missing here cannot be imported.
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 | |
Query Parameters
| Field | Type | Required | Description |
|---|
| contextId | uuid | Optional | |
Response
| Field | Type | Description |
|---|
| target | string| null | |
| attributes | GetImportSchemaResponseImportAttribute[]| null | |
GetImportSchemaResponseImportAttribute
| Field | Type | Description |
|---|
| key | string| null | |
| label | string| null | |
| kind | string| null | |
| path | string[]| null | |
| isRequired | boolean | |
| isUpdatable | boolean | |
| canBeUnique | boolean | |
| options | GetImportSchemaResponseImportAttributeOption[]| null | |
GetImportSchemaResponseImportAttributeOption
| Field | Type | Description |
|---|
| value | string| null | |
| label | string| null | |
| description | string| null | |