Domain Model
Sync Field Mapping
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| workspaceId | string.uuid | Yes | — | ID of the associated workspace |
| externalConnectionId | string.uuid | Yes | — | ID of the associated external connection |
| localRecordType | string | Yes | — | Local record type |
| localField | string | Yes | — | Local field |
| externalField | string | Yes | — | External field |
| direction | enum(bidirectional, push, pull, ignore) | Yes | — | Direction |
| valueMapJson | unknown | Yes | — | Value map json |
| isDefault | boolean | Yes | — | Is default |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| workspaceId | string.uuid | Yes | — | ID of the associated workspace |
| externalConnectionId | string.uuid | Yes | — | ID of the associated external connection |
| localRecordType | string | Yes | — | Local record type |
| localField | string | Yes | — | Local field |
| externalField | string | Yes | — | External field |
| direction | enum(bidirectional, push, pull, ignore) | Yes | "bidirectional" | Direction |
| valueMapJson | unknown | No | — | Value map json |
| isDefault | boolean | Yes | true | Is default |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| direction | enum(bidirectional, push, pull, ignore) | No | — | Direction |
| valueMapJson | unknown | No | — | Value map json |
| isDefault | boolean | No | — | Is default |