Delete Entities Task

Learn about the DeleteEntitiesTask task

This task batch deletes entities in a tenant. This task also starts DeleteEntitiesTask to delete all entities by specifying the type or a list of URIs to delete.

Request:

Tenant admin role is required:

POST {ApplicationURL}/api/{tenantId}/_delete

DELETE {ApplicationURL}/api/{tenantId}/entities

Table 1. Parameters
Parameter	Required	Description
`tenantId`	Yes	ID of the tenant to reindex potential matches.
`deleteEntitiesRequest`	No	The body of the request. This contain the following list of properties filter: search filter to determine the entities to delete uriList: a list of URIs of entities to delete excludeList: a list of URIs of entities exclude from deletion options: options for search parameter activeness: activeness for search parameter
`mode`	No	Specifies how entities are removed: `soft`: The entities are marked as deleted but all data remains in the storage (you cannot see or restore them). `hard`: The data of entities (such as crosswalks, attributes and other non‑essential fields) is removed from storage, retaining only minimal identity fields (such as entity ID, version, date fields). Note: The default value is `soft.`
`distributed`	No	If set to `true`, the task runs in distributed mode. Default value is `false`. For more information, see Distributed mode.
`taskPartsCount`	No	Specifies the maximum number of sub-tasks for distributed execution. The platform determines the optimal number based on performance limits. Default value is `2`. Note: This parameter is only applicable when `distributed=true`. Otherwise, it s ignored.
`entityType`	No	The entity type of entities to delete.

Response example:

 [
  {
    "id": "d37146e6-1b55-46ef-975b-8dfd1248e46e",
    "createdTime": 1440008511759,
    "createdBy": "User",
    "updatedTime": 1440008514672,
    "updatedBy": "User",
    "type": "com.reltio.businesslogic.tasks.delete.DeleteEntitiesTask",
    "status": "COMPLETED",
    "name": "Soft Delete Entities",
    "createdOnHost": "api01",
    "executedOnHost": "api01",
    "startTime": "08-19-2015 22.21",
    "endTime": "08-19-2015 22.25",
    "parameters": {
      "force": "true",
      "tenantId": "Merill"
    },
    "currentState": {
      "numberOfProcessedObjects": 3246,
      "maxQueueSize": 32000,
      "entityType": "all types",
      "status": "Completed"
    },
    "throughput": 346,
    "duration": "4m 5s"
  }
]

Unify and manage your data

Delete Entities Task

Footer