Service: zimbraMail
Namespace: "urn:zimbraMail"
ListDocumentRevisions SOAP Command

Returns {num} number of revisions starting from {version} of the requested document. {num} defaults to 1. {version} defaults to the current version.
Documents that have multiple revisions have the flag "/", which indicates that the document is versioned.

Authorization token required true
Admin Authorization token required false

ListDocumentRevisionsRequest

    <ListDocumentRevisionsRequest> ## ListDocumentRevisionsRequest
        <doc id="{item-id}" [ver="{version} (Integer)"] [count="{num-revisions} (Integer)"] /> ## ListDocumentRevisionsSpec
    </ListDocumentRevisionsRequest>

The following table describes elements and attributes you can define within a <ListDocumentRevisionsRequest> element:

XPath Required / Optional Description
/doc Required (only 1) Specification for the list of document revisions
/doc@id Required (only 1) Type:String
Item ID
/doc@ver Optional (0 or 1) Type:Integer
Version
/doc@count Optional (0 or 1) Type:Integer
Maximum number of revisions to return starting from {version}

ListDocumentRevisionsResponse

    <ListDocumentRevisionsResponse> ## ListDocumentRevisionsResponse
        (<doc [loid="{lock-owner-account-id}"] [loe="{lock-owner-account-email}"] [lt="{lock-timestamp}"] [id="..."]
                  [uuid="{uuid}"] [name="{name}"] [s="{size} (Long)"] [d="{date-millis} (Long)"] [l="{folder-id}"]
                  [luuid="{folder-uuid}"] [ms="{modified-sequence} (Integer)"] [mdver="{metadata-version} (Integer)"]
                  [md="{change-date-seconds} (Long)"] [rev="{revision} (Integer)"] [f="{flags}"] [t="{tags}"]
                  [tn="{tag-names}"] [desc="{optional-description}"] [ct="{content-type}"]
                  [descEnabled="{is-description-enabled} (0|1)"] [ver="{version} (Integer)"] [leb="{last-edited-by}"]
                  [cr="{revision-creator}"] [cd="{revision-create-date-millis} (Long)"]> ## DocumentInfo
            (<meta [section="{section}"]> ## MailCustomMetadata
                (<a n="{key}">{value}</a> ## KeyValuePair)*
              </meta>)*
            <fr>{fragment} (String)</fr>
            <acl [internalGrantExpiry="{millis-since-epoch} (Long)"] [guestGrantExpiry="{millis-since-epoch} (Long)"]> ## Acl
                (<grant perm="{rights}" gt="{grantee-type} (usr|grp|cos|pub|all|dom|guest|key)" zid="{grantee-id}"
                            [expiry="{millis-since-epoch} (Long)"] [d="{grantee-name}"] [pw="{guest-password}"]
                            [key="{access-key}"] /> ## Grant)*
             </acl>
          </doc>)*
        (<user [id="{id}"] [email="{email}"] [name="{name}"] /> ## IdEmailName)*
    </ListDocumentRevisionsResponse>

The following table describes elements and attributes you can define within a <ListDocumentRevisionsResponse> element:

XPath Required / Optional Description
/doc Optional (0 or more) Document revision information
/doc@loid Optional (0 or 1) Type:String
Lock owner account ID
/doc@loe Optional (0 or 1) Type:String
Lock owner account email address
/doc@lt Optional (0 or 1) Type:String
Lock timestamp
/doc@id Optional (0 or 1) Type:String
/doc@uuid Optional (0 or 1) Type:String
Item's UUID - a globally unique identifier
/doc@name Optional (0 or 1) Type:String
Name
/doc@s Optional (0 or 1) Type:Long
Size
/doc@d Optional (0 or 1) Type:Long
Date the item's content was last modified in milliseconds since 1970-01-01 00:00:00 UTC. For immutable objects (e.g. received messages), this will be the same as the date the item was created.
/doc@l Optional (0 or 1) Type:String
Folder ID
/doc@luuid Optional (0 or 1) Type:String
Folder UUID
/doc@ms Optional (0 or 1) Type:Integer
Modified sequence
/doc@mdver Optional (0 or 1) Type:Integer
Metadata version
/doc@md Optional (0 or 1) Type:Long
The date the item's metadata and/or content was last modified in seconds since 1970-01-01 00:00:00 UTC.
/doc@rev Optional (0 or 1) Type:Integer
Revision
/doc@f Optional (0 or 1) Type:String
Flags
/doc@t Optional (0 or 1) Type:String
Tags - Comma separated list of integers. DEPRECATED - use "tn" instead
/doc@tn Optional (0 or 1) Type:String
Comma-separated list of tag names
/doc@desc Optional (0 or 1) Type:String
Optional description
/doc@ct Optional (0 or 1) Type:String
Content type
/doc@descEnabled Optional (0 or 1) Type:0|1
Flags whether description is enabled or not
/doc@ver Optional (0 or 1) Type:Integer
Version
/doc@leb Optional (0 or 1) Type:String
Last edited by
/doc@cr Optional (0 or 1) Type:String
Revision creator
/doc@cd Optional (0 or 1) Type:Long
Revision creation date in milliseconds since 1970-01-01 00:00:00 UTC.
/doc/meta Optional (0 or more) Metadata
/doc/meta@section Optional (0 or 1) Type:String
Section.
Normally present. If absent this indicates that CustomMetadata info is present but there are no sections to report on.
/doc/meta/a Optional (0 or more) Type:{value}
Key value pairs
Description for element text content:Value
/doc/meta/a@n Required (only 1) Type:String
Key
/doc/fr Optional (0 or 1) Type:{fragment} (String)
First few bytes of the message (probably between 40 and 100 bytes)
/doc/acl Optional (0 or 1) ACL for sharing
/doc/acl@internalGrantExpiry Optional (0 or 1) Type:Long
Time when grants to internal grantees expire. If not specified in the request, defaults to the maximum allowed expiry for internal grants. If not specified in the response, defaults to 0. Value of 0 indicates that these grants never expire.
/doc/acl@guestGrantExpiry Optional (0 or 1) Type:Long
Time when grants to guest grantees expire. If not specified in the request, defaults to the maximum allowed expiry for guest/external user grants. If not specified in the response, defaults to 0. Value of 0 indicates that these grants never expire.
/doc/acl/grant Optional (0 or more) Grants
/doc/acl/grant@perm Required (only 1) Type:String
Rights - Some combination of (r)ead, (w)rite, (i)nsert, (d)elete, (a)dminister, workflow action (x), view (p)rivate, view (f)reebusy, (c)reate subfolder
/doc/acl/grant@gt Required (only 1) Type:usr|grp|cos|pub|all|dom|guest|key
The type of Grantee:
     "usr",
     "grp",
     "dom" (domain),
     "cos",
     "all" (all authenticated users), "pub" (public authenticated and unauthenticated access),
     "guest" (non-Zimbra email address and password),
     "key" (non-Zimbra email address and access key)
 
/doc/acl/grant@zid Required (only 1) Type:String
Grantee ID
/doc/acl/grant@expiry Optional (0 or 1) Type:Long
Time when this grant expires. For internal/guest grant: If this attribute is not specified, the expiry of the grant is derived from internalGrantExpiry/guestGrantExpiry of the ACL it is part of. If this attribute is specified (overridden), the expiry value can not be greater than the corresponding expiry value in the ACL. For public grant: If this attribute is not specified, defaults to the maximum allowed expiry for a public grant. If not specified in the response, defaults to 0. Value of 0 indicates that this grant never expires.
/doc/acl/grant@d Optional (0 or 1) Type:String
Name or email address of the principal being granted rights. optional if {grantee-type} is "all"/"guest"/"pub". When specified in a request, this can be just the username portion of the address in the default domain.
/doc/acl/grant@pw Optional (0 or 1) Type:String
Optional argument. password when {grantee-type} is "guest"
/doc/acl/grant@key Optional (0 or 1) Type:String
Optional argument. Access key when {grantee-type} is "key"
/user Optional (0 or more) User information
/user@id Optional (0 or 1) Type:String
ID
/user@email Optional (0 or 1) Type:String
Email
/user@name Optional (0 or 1) Type:String
Name