Service: zimbraAdmin

Command: CreateSystemRetentionPolicy
Namespace: urn:zimbraAdmin
Description: Create a 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

CreateSystemRetentionPolicyRequest

    <CreateSystemRetentionPolicyRequest> ## CreateSystemRetentionPolicyRequest
        <cos [by="{cos-selector-by} (id | name)"]>{key}</cos> ## CosSelector
        <keep> ## CreateSystemRetentionPolicyRequest$PolicyHolder
            <policy [type="{retention-policy-type} (user | system)"] [id="{id}"] [name="{name}"]
                        [lifetime="{policy-duration}"] /> ## Policy
         </keep>
        <purge> ... </purge> ## See /keep [ ## CreateSystemRetentionPolicyRequest$PolicyHolder]
    </CreateSystemRetentionPolicyRequest>

elements and attributes you can define within a <CreateSystemRetentionPolicyRequest> 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}
/keep Optional (0 or 1) Keep policy details
/keep/policy Optional (0 or 1)
/keep/policy@type Optional (0 or 1) Type: user | system
Retention policy type
/keep/policy@id Optional (0 or 1) Type: String
ID
/keep/policy@name Optional (0 or 1) Type: String
Name
/keep/policy@lifetime Optional (0 or 1) Type: String
Duration
/purge Optional (0 or 1) Purge policy details
See /keep for more details.

CreateSystemRetentionPolicyResponse

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

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

XPath Required / Optional Description
/policy Required (only 1) Information about the newly created retention policy
/policy@type Optional (0 or 1) Type: user | system
Retention policy type
/policy@id Optional (0 or 1) Type: String
ID
/policy@name Optional (0 or 1) Type: String
Name
/policy@lifetime Optional (0 or 1) Type: String
Duration