API Reference

Start Execution delete configuration

This page describe the parameters to use to start a delete execution.

Main object

FieldData TypeDescription
DestinationDBConnectionstringdatabase connection
EntitiesToDeleteArray[EntitiyToDelete]entity list to delete
ApplicationDeletionModebooleandelete mode to use. If true, the delete is by application and it will be use the ApplicationsToDelete list; otherwise, the export is by entity and it will be use the EntitiesToDelete list
ApplicationsToDeleteArray[ApplicationsToDelete]List of applications to delete. If the delete is by application, this field should be used with the applications definitions
FilterTenantsbooleanif true, the records in mutitenant entities will only be deleted if belong to one of the tenant in the TenantsList property
TenantsListArray[integer]list of the tenant ids. Automatic Tenant Filtering (for multi-tenant entities). The filter will not apply to entities that are not multitenant.
IncludeProtectedApplicationsbooleanBy default, the protected applications will be ignored (some default OutSystems application and the DMM applications).

EntitiyToDelete object

FieldData TypeDescription
OSEntityNamestringentity name
OSEntitySSKeystringentity ss_key
ESpaceSsKeystringentity espace ss_key
WhereClausestringwhere filter to get the records from the source

ApplicationsToDelete object

FieldData TypeDescription
OSApplicationIdintegerapplication id
OSApplicationNamestringapplication name

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": []
}