Create Retention Policy

Create a retention policy for a space.

Only resource_type, retain_days and action are required (and entity_name and archive_days where the type and action call for them).

A retention policy says how long one kind of resource of a space stays live, and what happens to it then. BANK_ID is the space: a bank's id, or SYS for the system space. The Role is checked at that BANK_ID. Periods are configuration, set here per space, never in code.

• resource_type: one of dynamic_entity_record, file, chat_message, chat_room, customer, consent.
• entity_name: the dynamic entity, for dynamic_entity_record only. It must exist in the space.
• date_basis: what the period is counted from. created or updated for dynamic entity records, chat messages and customers; or, for dynamic entity records, field:<name>, the ISO 8601 date in that field of the record. created for files. created, updated or last_activity (the last message, or creation when there was none) for chat rooms. created, updated or expires (the expiry of the Consent's token; the default) for consents. Defaults to created otherwise.
• condition: optional, {"field": "status", "value": "CLOSED"}. Only resources whose field has this value (compared as text) are governed. For a dynamic entity record the field is one of the record's own; for the other types it is a field of the resource's JSON copy, such as media_type, message_type, customer_type or status.
• retain_days: how long a resource stays live after its trigger date. At least retention.minimum_retain_days (1825 days, five years, by default).
• action: archive (move it out of the live tables into the retention archive, readable only with CanGetRetentionArchive, then delete it after archive_days), delete (final), or, for customers only, anonymise (clear the personal fields and delete the attributes, addresses, dependants, tax residences and links to Users, keeping the customer id so that references stay valid). Archiving is not an undo: nothing is ever restored from the archive.
• archive_days: required for archive, not allowed otherwise.
• cascade: files attached to a disposed resource go with it (a dynamic entity record's files are attached with the entity name as record type; a customer's with customer). A file still attached to another record stays. Default false: the attachments go, the files stay.
• requires_approval: an execution waits as pending until a second, different user approves it.
• enabled: whether the retention scheduler runs the policy. Default true. A run can always be started by hand.

Every disposal is written to the disposal register. Resources on legal hold are skipped by every run. A run that would archive is refused unless retention.archive.enabled is true, and one that would delete or anonymise unless retention.delete.enabled is true. See RETENTION_PLAN.md.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk