UpdateVersionComment API¶

Updates the version comment (author comment) on a specific document version.

Endpoint¶

/srv.asmx/UpdateVersionComment

Methods¶

• GET /srv.asmx/UpdateVersionComment?authenticationTicket=...&documentPath=...&versionNumber=...&commentText=...
• POST /srv.asmx/UpdateVersionComment (form data)
• SOAP Action: http://tempuri.org/UpdateVersionComment

Parameters¶

Response¶

Success Response¶

<root success="true" />

Error Response¶

<root success="false" error="Error message" />

Required Permissions¶

Only the author of the version (the user who created it) may update its comment. Calls from any other user will fail with an access-denied error.

Example¶

Request (POST)¶

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

authenticationTicket=abc123&documentPath=/Finance/Reports/Q1Summary.pdf&versionNumber=1000001&commentText=Initial draft submitted for review

Request (GET)¶

GET /srv.asmx/UpdateVersionComment?authenticationTicket=abc123&documentPath=/Finance/Reports/Q1Summary.pdf&versionNumber=1000001&commentText=Initial+draft+submitted+for+review

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 comment attached to one version of a document.

await call('UpdateVersionComment', {
  authenticationTicket: ticket,
  documentPath: '/Finance/Reports/Q1.pdf',
  versionNumber: 0,             // 0 means the published version
  commentText: 'Signed off by the board'
});

It reads back as the <Comment> element of that version in GetDocumentVersions. A version number nothing uses is 4041.

Notes¶

• The version comment is distinct from document-level comments added via AddDocumentComment. It is the author's note attached to a specific version at check-in time.
• Pass an empty string for commentText to clear an existing comment.
• Use GetDocumentVersions to list all versions and their numbers before calling this API.

Related APIs¶

• GetDocumentVersions — Get the complete version history for a document, including version numbers.
• GetDocumentVersion — Get metadata for a specific version of a document.

Error Codes¶

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