Service: zimbraAdmin

Command: GetSystemRetentionPolicy
Namespace: urn:zimbraAdmin
Description: Get System Retention Policy

The system retention policy SOAP APIs allow the administrator to edit named system retention policies that users can apply to folders and tags.
Properties:
Authorization token required true
Admin Authorization token required true

GetSystemRetentionPolicyRequest

    <GetSystemRetentionPolicyRequest> ## GetSystemRetentionPolicyRequest
        <cos [by="{cos-selector-by} (id | name)"]>{key}</cos> ## CosSelector
    </GetSystemRetentionPolicyRequest>

elements and attributes you can define within a <GetSystemRetentionPolicyRequest> element:

XPath Required / Optional Description
/cos Optional (0 or 1) Type: {key}
COS
Description for element text content:The key used to identify the COS. Meaning determined by {cos-selector-by}
/cos@by Optional (0 or 1) Type: id | name
Select the meaning of {cos-selector-key}

GetSystemRetentionPolicyResponse

    <GetSystemRetentionPolicyResponse> ## GetSystemRetentionPolicyResponse
        <retentionPolicy> ## RetentionPolicy
            <purge>
                (<policy [type="{retention-policy-type} (user | system)"] [id="{id}"] [name="{name}"]
                             [lifetime="{policy-duration}"] /> ## Policy)*
            </purge>
         </retentionPolicy>
    </GetSystemRetentionPolicyResponse>

elements and attributes you can define within a <GetSystemRetentionPolicyResponse> element:

XPath Required / Optional Description
/retentionPolicy Optional (0 or 1) Retention Policy information
/retentionPolicy/purge Required (only 1)
/retentionPolicy/purge/policy Optional (0 or more)
/retentionPolicy/purge/policy@type Optional (0 or 1) Type: user | system
Retention policy type
/retentionPolicy/purge/policy@id Optional (0 or 1) Type: String
ID
/retentionPolicy/purge/policy@name Optional (0 or 1) Type: String
Name
/retentionPolicy/purge/policy@lifetime Optional (0 or 1) Type: String
Duration