EntityUpdateByIdOptions
Options for updating an existing entity — schema and/or metadata in a single call.
Schema changes (addFields, removeFields, updateFields) and metadata changes
(displayName, description, isRbacEnabled) can be combined; each is applied
only when the corresponding fields are provided.
Extends¶
Properties¶
| Property | Type | Description |
|---|---|---|
addFields? |
EntityCreateFieldOptions[] |
New fields to add |
description? |
string |
New description for the entity |
displayName? |
string |
New display name for the entity |
folderKey? |
string |
Key identifying the folder the entity belongs to. Omit for tenant-level entities. |
isRbacEnabled? |
boolean |
Whether role-based access control is enabled for this entity |
removeFields? |
EntityRemoveFieldOptions[] |
Fields to remove, each identified by field name |
updateFields? |
EntityFieldUpdateOptions[] |
Fields to update, each identified by its field ID |