This page describe the parameters to use to start a delete execution.
Main object
Field | Data Type | Description |
---|---|---|
DestinationDBConnection | string | database connection |
EntitiesToDelete | Array[EntitiyToDelete] | entity list to delete |
FilterTenants | boolean | if true, the records in mutitenant entities will only be deleted if belong to one of the tenant in the TenantsList property |
TenantsList | Array[integer] | list of the tenant ids. Automatic Tenant Filtering (for multi-tenant entities). The filter will not apply to entities that are not multitenant. |
EntitiyToDelete object
Field | Data Type | Description |
---|---|---|
OSEntityName | string | entity name |
OSEntitySSKey | string | entity ss_key |
ESpaceSsKey | string | entity espace ss_key |
WhereClause | string | where filter to get the records from the source |
Sample configuration
{
"DestinationDBConnection": "Destination Connection Name",
"EntitiesToDelete": [
{
"OSEntityName": "Entity 1 Name",
"OSEntitySSKey": "fcaab2d9-b22a-4822-9as8-42c132a96701",
"ESpaceSsKey": "32179c4d-abc1-2414-sc77-dccca3338a12",
"WhereClause": null
},{
"OSEntityName": "Entity 2 Name",
"OSEntitySSKey": "1232a0fb-4321-4eab-bsd1-321asd9fc1327",
"ESpaceSsKey": "32179c4d-abc1-2414-sc77-dccca3338a12",
"WhereClause": null
}
],
"FilterTenants": false,
"TenantsList": []
}