Retention class resources

Content Platform Tenant Management

Version

9.7.x

File Size

4269 KB

Audience

anonymous

Part Number

MK-95HCPH002-19

Retention class resources let you create, retrieve information about, modify, and delete retention classes. The tables below provides information about these resources.

.../tenants/tenant-name/namespaces/namespace-name/retentionClasses

Data type	Method	Use	Access	Notes
retentionClass	PUT	Create a retention class for a namespace	For an HCP namespace, tenant-level user account with the compliance role For the default namespace, system-level user account with the compliance role
List	GET	Retrieve a list of the retention classes defined for a namespace	For an HCP namespace, tenant-level user account with the monitor, administrator, or compliance role For the default namespace, system-level user account with the monitor, administrator, or compliance role	The listed retention classes are identified by retention class name. In XML, the element that identifies each retention class is `name`. The root element for the list of retention classes is `retentionClasses`. In JSON, the name in the name/value pair that lists the retention classes is `name`.

Data type

Method

Use

Access

Notes

retentionClass

PUT

Create a retention class for a namespace

For an HCP namespace, tenant-level user account with the compliance role
For the default namespace, system-level user account with the compliance role

List

GET

Retrieve a list of the retention classes defined for a namespace

For an HCP namespace, tenant-level user account with the monitor, administrator, or compliance role
For the default namespace, system-level user account with the monitor, administrator, or compliance role

The listed retention classes are identified by retention class name.

In XML, the element that identifies each retention class is name. The root element for the list of retention classes is retentionClasses.

In JSON, the name in the name/value pair that lists the retention classes is name.

.../tenants/tenant-name/namespaces/namespace-name/retentionClasses/retention-class-name

Data type	Method	Use	Access	Notes
retentionClass	GET	Retrieve information about a retention class	For an HCP namespace, tenant-level user account with the monitor, administrator, or compliance role For the default namespace, system-level user account with the monitor, administrator, or compliance role
N/A	HEAD	Check for the existence of a retention class	For an HCP namespace, tenant-level user account with the monitor, administrator, or compliance role For the default namespace, system-level user account with the monitor, administrator, or compliance role
retentionClass	POST	Modify a retention class	For an HCP namespace, tenant-level user account with the compliance role For the default namespace, system-level user account with the compliance role
N/A	DELETE	Delete a retention class	For an HCP namespace, tenant-level user account with the compliance role For the default namespace, system-level user account with the compliance role	You can delete a retention class only if the namespace is in enterprise mode.