SetVersionTextOnlyContent API¶

Updates the plain-text alternative content of a specific version of the specified document. The text-only content is a searchable plain-text representation stored alongside the binary file. It is used for full-text indexing when the binary content cannot be indexed directly. Calling this API replaces any previously stored text-only content for the specified version.

Endpoint¶

/srv.asmx/SetVersionTextOnlyContent

Methods¶

• GET /srv.asmx/SetVersionTextOnlyContent?authenticationTicket=...&path=...&versionNumber=...&contentText=...

• POST /srv.asmx/SetVersionTextOnlyContent (form data)

• SOAP Action: http://tempuri.org/SetVersionTextOnlyContent

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/SetVersionTextOnlyContent

  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

  &path=/Finance/Reports/Q1-2024-Report.pdf

  &versionNumber=1000001

  &contentText=Revenue+for+Q1+2024+totals+1.2M+USD

HTTP/1.1

POST Request¶

POST /srv.asmx/SetVersionTextOnlyContent HTTP/1.1

Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

&path=/Finance/Reports/Q1-2024-Report.pdf

&versionNumber=1000001

&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:SetVersionTextOnlyContent>

      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>

      <tns:path>/Finance/Reports/Q1-2024-Report.pdf</tns:path>

      <tns:versionNumber>1000001</tns:versionNumber>

      <tns:contentText>Revenue for Q1 2024 totals 1.2M USD</tns:contentText>

    </tns:SetVersionTextOnlyContent>

  </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 stored against one version of a document.

await call('SetVersionTextOnlyContent', {
  authenticationTicket: ticket,
  Path: '/Finance/Reports/Q1.pdf',
  VersionNumber: 1000000,
  ContentText: 'Quarterly results. Revenue 4.1m.'
});

SetDocumentTextOnlyContent does the same for the published version. An empty ContentText clears the version's text, the same as the document-level operation. Until 9.0 this one's ContentText was declared without a question mark, so an empty one was refused by model binding with HTTP 400 and the version-level operation could not clear what the document-level one could.

Notes¶

• To update text content for the latest version without specifying a version number, use SetDocumentTextOnlyContent.

• Use GetDocumentVersions to retrieve all available version numbers before calling this API.

• infoRouter version numbers are large integers (--- 1,000,000) assigned internally -" they are not sequential user-facing version labels.

• Line endings in contentText are normalized to the server format before storing.

• This API does not modify the binary file -" only the stored plain-text metadata for the specified version.

• After updating, the document may need to be re-indexed before the new text becomes searchable.

Related APIs¶

• SetDocumentTextOnlyContent - Update text-only content for the latest document version

• GetVersionTextOnlyContent - Retrieve the stored text-only content of a specific version

• GetDocumentVersions - Retrieve the list of all versions for a document

Error Codes¶

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