SetDocumentTextOnlyContent API¶

Updates the plain-text alternative content of the latest version of the specified document. The text-only content is a searchable plain-text representation stored alongside the binary document file. It is used for full-text indexing when the binary content cannot be indexed directly (e.g. encrypted or proprietary formats). Calling this API replaces any previously stored text-only content for the latest version.

Endpoint¶

/srv.asmx/SetDocumentTextOnlyContent

Methods¶

• GET /srv.asmx/SetDocumentTextOnlyContent?authenticationTicket=...&path=...&contentText=...
• POST /srv.asmx/SetDocumentTextOnlyContent (form data)
• SOAP Action: http://tempuri.org/SetDocumentTextOnlyContent

Parameters¶

Response¶

Success Response¶

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

Error Response¶

<response success="false" error="Document not found." />

Required Permissions¶

The calling user must have write (modify) permission on the document or its containing folder.

Example¶

GET Request¶

GET /srv.asmx/SetDocumentTextOnlyContent
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &path=/Finance/Reports/Q1-2024-Report.pdf
  &contentText=Revenue+for+Q1+2024+totals+1.2M+USD
HTTP/1.1

POST Request¶

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&path=/Finance/Reports/Q1-2024-Report.pdf
&contentText=Revenue for Q1 2024 totals 1.2M USD

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:SetDocumentTextOnlyContent>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:path>/Finance/Reports/Q1-2024-Report.pdf</tns:path>
      <tns:contentText>Revenue for Q1 2024 totals 1.2M USD</tns:contentText>
    </tns:SetDocumentTextOnlyContent>
  </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;
}

Writes the plain-text rendition of a document - what full-text search reads, and what GetDocumentTextOnlyContent returns.

await call('SetDocumentTextOnlyContent', {
  authenticationTicket: ticket,
  Path: '/Finance/Reports/Q1.pdf',
  ContentText: 'Quarterly results. Revenue 4.1m, up 4% year on year.'
});

ContentText is nullable, so an empty one reaches the operation and clears the stored text rather than being refused.

Notes¶

• This API always targets the latest version of the document. To update text content for a specific version, use SetVersionTextOnlyContent.
• Line endings in contentText are normalized to the server format before storing.
• Passing null or an empty string clears the previously stored text-only content.
• The stored text content is used by the full-text search index. After updating, the document may need to be re-indexed before the new text becomes searchable.
• This API does not modify the binary file -" only the stored plain-text metadata.

Related APIs¶

• SetVersionTextOnlyContent - Update text-only content for a specific document version
• GetDocumentTextOnlyContent - Retrieve the stored text-only content of the latest version
• GetVersionTextOnlyContent - Retrieve the stored text-only content of a specific version

Error Codes¶

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