removeProperty() — Schema Manager

Removes a property (column) from an existing entity definition.

Request Format

removeProperty(
    entityDefId: string,     // ID of the entity definition to modify
    propertyName: string,    // Name of the property to remove
    token: string,           // Authentication token
    tenantCode?: string      // Optional tenant code
): Promise<{
    success: boolean,
    data?: boolean,          // Success status
    error?: string
}>

Response Format

{
    "success": boolean,
    "data": boolean,        // True if property was removed successfully
    "error": "string"      // Present only if success is false
}

Example

const result = await removeProperty("entity-id", "address", "your-auth-token");

Important Notes

1. Data Loss Warning: Removing a property will delete all data stored in that column
2. Default Properties: Some default properties (like id) cannot be removed
3. Reference Properties: When removing a reference property:
   • The mirror property in the referenced entity is also removed
   • For ManyToMany relationships, the mapping table may be dropped
4. Dependent Components: Check for UI components or business logic that depend on the property before removal