GetDispositionLog API¶

Returns the disposition log for documents, folders, and libraries matching the specified date range and path filter. Each entry represents a retention and disposition action performed on an object.

Endpoint¶

/srv.asmx/GetDispositionLog

Methods¶

• GET /srv.asmx/GetDispositionLog?authenticationTicket=...&startDate=...&endDate=...&pathFilter=...
• POST /srv.asmx/GetDispositionLog (form data)
• SOAP Action: http://tempuri.org/GetDispositionLog

Parameters¶

All filter parameters are optional. When all filters are omitted, all disposition log entries in the system are returned (requires system-wide permission — see Required Permissions).

Required Permissions¶

The required permission level depends on the pathFilter value:

When a library name is resolved from the path, the query is automatically scoped to that library. Library-level audit log administrators can therefore query their own library without system-wide admin rights.

Response¶

Success Response¶

Returns a <response> element with success="true" containing a <logs> element with zero or more <LOGITEM> child elements. Results are ordered by action date descending (most recent first).

<response success="true" error="">
  <logs>
    <LOGITEM
      TYPE="DOCUMENT"
      NAME="Policy_2024.docx"
      PATH="\MyLibrary\Policies"
      DATE="2026-02-01 14:30:00"
      ID="1234"
      DOMAINID="1"
      DOMAINNAME="MyLibrary"
      COMMENTS="Retention period expired. Document disposed per schedule."
      USERID="5"
      FULLNAME="John Smith" />
    <LOGITEM
      TYPE="DOCUMENT"
      NAME="Contract_Old.pdf"
      PATH="\MyLibrary\Contracts"
      DATE="2026-01-15 10:00:00"
      ID="1235"
      DOMAINID="1"
      DOMAINNAME="MyLibrary"
      COMMENTS="Manual disposition approved by records manager."
      USERID="8"
      FULLNAME="Jane Doe" />
  </logs>
</response>

LOGITEM Attribute Reference¶

Empty Result¶

<response success="true" error="">
  <logs />
</response>

Error Response¶

<response success="false" error="[ErrorCode] Error message" />

Example Requests¶

GET — system-wide query¶

GET /srv.asmx/GetDispositionLog?authenticationTicket=abc123-def456&startDate=2026-01-01&endDate=2026-02-01 HTTP/1.1
Host: server.example.com

GET — scoped to a library¶

GET /srv.asmx/GetDispositionLog?authenticationTicket=abc123-def456&startDate=2026-01-01&endDate=2026-02-01&pathFilter=\MyLibrary* HTTP/1.1
Host: server.example.com

POST¶

POST /srv.asmx/GetDispositionLog HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=abc123-def456&startDate=2026-01-01&endDate=2026-02-01&pathFilter=\MyLibrary*

SOAP 1.1¶

POST /srv.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/GetDispositionLog"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDispositionLog xmlns="http://tempuri.org/">
      <authenticationTicket>abc123-def456</authenticationTicket>
      <startDate>2026-01-01</startDate>
      <endDate>2026-02-01</endDate>
      <pathFilter>\MyLibrary*</pathFilter>
    </GetDispositionLog>
  </soap:Body>
</soap:Envelope>

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Reports what reached its disposition date in a date range. Rows come back as <log> inside <logs>.

The dates are yyyy-MM-dd. They bind as DateTime, so a value that is not a date is refused with HTTP 400 before the operation runs - not with this API's error document. An empty one binds to its default, which leaves the range open at that end, and a range given backwards is accepted and reports nothing.

const root = await call('GetDispositionLog', {
  authenticationTicket: ticket,
  startDate: '2026-01-01',
  endDate: '2026-12-31',
  pathFilter: ''            // empty for everywhere, or a path to narrow it
});

for (const row of root.querySelectorAll('logs > log')) {
  console.log(row.getAttribute('DATE'), row.getAttribute('NAME'));
}

Leave pathFilter empty to search everywhere.

Notes¶

• pathFilter also sets permission scope: providing a valid library name in the path is not just a filter — it also reduces the required permission to library-level ViewAuditLogs. Omitting the path queries all libraries and requires system-wide admin rights.
• pathFilter wildcards: use * as a trailing wildcard. \MyLibrary\* matches all items under MyLibrary. An exact path is used when no * is present.
• UTC input: startDate and endDate may be submitted as UTC values; the server converts them to local time before filtering.
• DATE format: the DATE attribute in the response is server local time in yyyy-MM-dd HH:mm:ss format, not UTC.
• COMMENTS: contains the disposition reason or notes recorded at the time of the action. May be empty if no comments were provided.

Error Codes¶

The errorCode values this operation returns, checked against a running server:

Related APIs¶

• GetDeleteLog - Get deletion log entries
• GetCheckInLog - Get check-in log entries
• GetNewDocumentsAndFoldersLog - Get creation log entries for new documents and folders
• GetRetentionSourceAuthorities - List all retention source authorities