Skip to main content
Announcements

Delete a record by ID

Deletes a data record by the specified ID.
Request 
DELETE /services/rest/data/{containerName}/{type}/{id}
Parameters
  • containerName: This is a String value which specifies the name of the data container from which you want to delete a data record.
  • container: This is a String value which represents the type of the data container. It is either MASTER (default) or STAGING.
  • type: This is a String value which specifies the name of the entity from which you want to delete a data record.
  • id: The ID of the data record to be deleted. For composite IDs, you can use a dot-separated value. For example, to delete an instance Address with the ID 1 in the data container Customer, use http://localhost:8180/talendmdm/services/rest/data/Customer/Address/1, and to delete an instance Address with the ID 1 and 2, use http://localhost:8180/talendmdm/services/rest/data/Customer/Address/1.2.
  • updateReport: This is a Boolean value which controls whether to generate a journal entry (update report). By default, it is true.
  • logical: This is a Boolean value which controls whether to delete a record logically. By default, it is false, which implies that the record will be physically removed from the database and cannot be recovered from the Recycle Bin.
    Information noteNote: Logical delete is only supported on master data records.
Headers
  • Content-Type: application/json
  • Authorization: Basic Authentication scheme
Response No content.
Status
  • 200 OK: The operation is executed successfully, and the data record specified by the element Id will be deleted.
  • 400 BAD REQUEST: The request contains invalid parameter, for example, invalid storage name or invalid entity name.
  • 403 FORBIDDEN: Missing required permission.
  • 404 NOT FOUND: The resource does not exist, for example, invalid service URL.
  • 500 INTERNAL SERVER ERROR: Other errors.
Limitation This REST API does not support deleting a record by ID for the Role entity in the PROVISIONING system data container.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here