API Explorer 1018 endpoints

Delete Retention Policy

DELETE /obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID

OBPv7.0.0-deleteRetentionPolicy Roles: CanManageRetentionPolicy(per bank) Data-RetentionAPI

Delete a retention policy. Its pending runs are refused. Its runs, the disposal register and what it archived stay; archived resources are still deleted from the archive when their archive period ends (by the retention scheduler, with retention.delete.enabled).

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_POLICY_ID: RETENTION_POLICY_ID

JSON response body fields (0)
Possible errors (5)
  • 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-30609: Retention policy not found in this space. Please specify a valid value for RETENTION_POLICY_ID.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 deleteRetentionPolicy