complianceSettings
The complianceSettings
data type describes the complianceSettings resource for namespaces.
Properties
The table below describes the properties included in the complianceSettings
data type.
Property name | Data type | Description | Notes |
customMetadataChanges | String |
Specifies which operations are allowed with custom metadata for objects under retention. Valid values are:
The default is ADD. These values are not case sensitive. | |
dispositionEnabled | Boolean |
Specifies whether objects with expired retention periods should automatically be deleted from the namespace. Valid values are:
The default is false. | For disposition to take effect at the namespace level, it must also be enabled in the HCPsystem configuration. |
minimumRetentionAfterInitialUnspecified | String |
For an HCP namespace, specifies that the retention set on The default is 0 (zero) years, 0 months, and 0 days. | This property is not valid for the default namespace. |
retentionDefault | String |
For an HCP namespace, specifies the default retention setting for objects added to the namespace. Valid values are special values, offsets, retention classes, and fixed dates. The default is 0 (zero), which is equivalent to | This property is not valid for the default namespace. |
shreddingDefault | Boolean |
For an HCP namespace, specifies the default shred setting for objects added to the namespaces. Valid values are:
The default is false. |
This property is not valid for the default namespace. Once an object is marked for shredding, its shred setting cannot be changed. |
Example
Here’s an XML example of the complianceSettings
data type:
<complianceSettings> <customMetadataChanges>ALL</customMetadataChanges> <retentionDefault>A+7Y</retentionDefault> <minimumRetentionAfterInitialUnspecified>19y+0M+7d</minimumRetentionAfterInitialUnspecified> <dispositionEnabled>true</dispositionEnabled> <shreddingDefault>false</shreddingDefault> </complianceSettings>