CascadeConfiguration Class

Defines cascade behavior for relationship operations.

Valid values for each parameter:

"Cascade": Perform the operation on all related records
"NoCascade": Do not perform the operation on related records
"RemoveLink": Remove the relationship link but keep the records
"Restrict": Prevent the operation if related records exist

Constructor

CascadeConfiguration(assign: str = 'NoCascade', delete: str = 'RemoveLink', merge: str = 'NoCascade', reparent: str = 'NoCascade', share: str = 'NoCascade', unshare: str = 'NoCascade', additional_properties: Dict[str, Any] | None = None)

Parameters

Name	Description
assign	str Cascade behavior for assign operations. Default value: NoCascade
delete	str Cascade behavior for delete operations. Default value: RemoveLink
merge	str Cascade behavior for merge operations. Default value: NoCascade
reparent	str Cascade behavior for reparent operations. Default value: NoCascade
share	str Cascade behavior for share operations. Default value: NoCascade
unshare	str Cascade behavior for unshare operations. Default value: NoCascade
additional_properties	Optional[Dict[str, Any]] Optional dict of additional properties to include in the Web API payload (e.g., "Archive", "RollupView"). These are merged last and can override default values. Default value: None

Methods

to_dict

Convert to Web API JSON format.

Example:


   >>> config = CascadeConfiguration(delete="Cascade", assign="NoCascade")
   >>> config.to_dict()
   {
       'Assign': 'NoCascade',
       'Delete': 'Cascade',
       'Merge': 'NoCascade',
       'Reparent': 'NoCascade',
       'Share': 'NoCascade',
       'Unshare': 'NoCascade'
   }

to_dict

Convert to Web API JSON format.

Example:


   >>> config = CascadeConfiguration(delete="Cascade", assign="NoCascade")
   >>> config.to_dict()
   {
       'Assign': 'NoCascade',
       'Delete': 'Cascade',
       'Merge': 'NoCascade',
       'Reparent': 'NoCascade',
       'Share': 'NoCascade',
       'Unshare': 'NoCascade'
   }

to_dict() -> Dict[str, Any]

Attributes

additional_properties

additional_properties: Dict[str, Any] | None = None

assign

assign: str = 'NoCascade'

delete

delete: str = 'RemoveLink'

merge

merge: str = 'NoCascade'

reparent

reparent: str = 'NoCascade'

share: str = 'NoCascade'

unshare

unshare: str = 'NoCascade'