Comprehensive API reference for workspace field mappings including CRUD operations, instances, and different scope levels
Field Mappings
For detailed information about field mappings, see the Field Mappings documentation.
API Operations
| Operation | Method | Endpoint | Description |
|---|---|---|---|
| List all field mappings | GET | /field-mappings | Retrieve all workspace field mappings |
| Get field mapping | GET | /field-mappings/{selector} | Get specific field mapping details |
| Create a new field mapping | POST | /field-mappings | Create a new workspace field mapping |
| Replace field mapping | PUT | /field-mappings/{selector} | Replace field mapping configuration |
| Patch field mapping | PATCH | /field-mappings/{selector} | Update field mapping partially |
| Clone field mapping | POST | /field-mappings/{selector}/clone | Clone an existing field mapping |
| Reset field mapping | POST | /field-mappings/{selector}/reset | Reset field mapping to default |
| Export field mapping | GET | /field-mappings/{selector}/export | Export field mapping configuration |
| Get field mapping app schema | GET | /field-mappings/{selector}/app-schema | Get app schema for field mapping |
| Get field mapping dependencies | GET | /field-mappings/{selector}/dependencies | Get field mapping dependencies |
| Refresh field mappings | POST | /field-mappings/refresh | Refresh field mapping definitions |
| Restore field mapping | POST | /field-mappings/{selector}/restore | Restore archived field mapping |
| Archive field mapping | DELETE | /field-mappings/{selector} | Archive a field mapping |
