Delete Retention Hold
DELETE /obp/v7.0.0/management/banks/BANK_ID/retention-holds/RETENTION_HOLD_ID
OBPv7.0.0-deleteRetentionHold Roles: CanManageRetentionHold(per bank) Data-RetentionAPI
Release a legal hold. The hold is kept, with who released it and when, and is listed by Get Retention Holds
with is_active false; the next run no longer skips what it named.
A legal hold keeps resources out of every retention run until it is released: they are not archived,
anonymised or deleted, and an archived resource on hold is not deleted from the archive. A hold names one
resource by resource_type and resource_id (for a dynamic entity record, entity_name may be given too), or,
for dynamic_entity_record, every record of one dynamic entity by entity_name alone. A consent is named by its
consent_reference_id. A chat room with a held message is kept whole.
BANK_ID is the space: a bank's id, or SYS for the system space. The Role is checked at that BANK_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
RETENTION_HOLD_ID: RETENTION_HOLD_ID
JSON response body fields (0)
Possible errors (6)
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-30616: Retention hold not found in this space. Please specify a valid value for RETENTION_HOLD_ID.
- OBP-30621: This retention hold has already been released.
- OBP-50000: Unknown Error.