GetVersionDeleteLog API
Returns the version deletion log for documents matching the specified date range and path filter. Each entry represents a version being deleted from a document, including whether it was the last remaining version.
Endpoint
/srv.asmx/GetVersionDeleteLog
Methods
- GET
/srv.asmx/GetVersionDeleteLog?authenticationTicket=...&startDate=...&endDate=...&pathFilter=... - POST
/srv.asmx/GetVersionDeleteLog(form data) - SOAP Action:
http://tempuri.org/GetVersionDeleteLog
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
authenticationTicket |
string | Yes | Authentication ticket obtained from AuthenticateUser |
startDate |
DateTime | No | Start date for the log query range |
endDate |
DateTime | No | End date for the log query range |
pathFilter |
string | No | Path filter with optional wildcard (e.g. \MyLibrary\Reports*) |
Response Structure
Success Response
<response success="true">
<logs>
<log TYPE="DOCUMENT" ID="1234" NAME="Report.docx" DATE="2026-02-01 14:30:00" DOMAINID="1" PATH="\MyLibrary\Reports" USERID="5" FULLNAME="John Smith" VERSION="2" ISLASTVERSION="FALSE" />
<log TYPE="DOCUMENT" ID="1235" NAME="Invoice.pdf" DATE="2026-01-28 09:15:00" DOMAINID="1" PATH="\MyLibrary\Finance" USERID="8" FULLNAME="Jane Doe" VERSION="1" ISLASTVERSION="TRUE" />
</logs>
</response>
Empty Result
<response success="true">
<logs />
</response>
Error Response
<response success="false" error="[ErrorCode] Error message" />
Log Entry Attributes
Each <log> element contains:
| Attribute | Type | Description |
|---|---|---|
TYPE |
string | Object type (typically DOCUMENT) |
ID |
integer | Document identifier |
NAME |
string | Name of the document |
DATE |
DateTime | Date and time the version was deleted |
DOMAINID |
integer | Domain/library identifier |
PATH |
string | Parent path of the document |
USERID |
integer | User identifier who deleted the version |
FULLNAME |
string | Full name of the user who deleted the version |
VERSION |
integer | The version number that was deleted |
ISLASTVERSION |
string | TRUE if the deleted version was the last remaining version, FALSE otherwise |
Required Permissions
- User must be authenticated (valid authentication ticket required)
- User must have
ViewAuditLogsadmin permission
Example Requests
Request (GET)
GET /srv.asmx/GetVersionDeleteLog?authenticationTicket=abc123-def456&startDate=2026-01-01&endDate=2026-02-01&pathFilter=\MyLibrary* HTTP/1.1
Host: server.example.com
Request (POST)
POST /srv.asmx/GetVersionDeleteLog HTTP/1.1
Content-Type: application/x-www-form-urlencoded
authenticationTicket=abc123-def456&startDate=2026-01-01&endDate=2026-02-01&pathFilter=\MyLibrary*
Request (SOAP 1.1)
POST /srv.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/GetVersionDeleteLog"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetVersionDeleteLog xmlns="http://tempuri.org/">
<authenticationTicket>abc123-def456</authenticationTicket>
<startDate>2026-01-01</startDate>
<endDate>2026-02-01</endDate>
<pathFilter>\MyLibrary*</pathFilter>
</GetVersionDeleteLog>
</soap:Body>
</soap:Envelope>
Notes
- Results are ordered by action date descending (most recent first).
- The
pathFilterparameter supports wildcard matching using*(e.g.,\MyLibrary\Reports*). - If
startDateandendDateare omitted, all available log entries are returned. - UTC dates are automatically converted to local server time.
- Version delete logging must be enabled in the domain policies for entries to be recorded.
- The
ISLASTVERSIONattribute indicates whether the deleted version was the last remaining version of the document.
Error Codes
Common error responses:
| Error | Description |
|---|---|
[901]Session expired or Invalid ticket |
Invalid or expired authentication ticket |
| Insufficient permissions | Caller does not have ViewAuditLogs admin permission |
Related APIs
GetVersionCreateLog- Get version creation log entriesGetCheckInLog- Get check-in log entriesGetCheckoutLog- Get checkout log entriesGetDeleteLog- Get deletion log entriesGetNewDocumentsAndFoldersLog- Get creation log entries for new documents and folders
Version History
- New: Added to provide programmatic access to version deletion log previously only available through the Control Panel UI