Updates the version comment (author comment) on a specific document version.
/srv.asmx/UpdateVersionComment
/srv.asmx/UpdateVersionComment?authenticationTicket=...&documentPath=...&versionNumber=...&commentText=.../srv.asmx/UpdateVersionComment (form data)http://tempuri.org/UpdateVersionComment| Parameter | Type | Required | Description |
|---|---|---|---|
authenticationTicket |
string | Yes | Authentication ticket obtained from AuthenticateUser. |
documentPath |
string | Yes | Full infoRouter path of the document (e.g. /Finance/Reports/Q1Summary.pdf). |
versionNumber |
integer | Yes | Version number to update. Use GetDocumentVersions to retrieve valid version numbers. |
commentText |
string | Yes | New comment text for the version. Pass an empty string to clear the comment. |
<root success="true" />
<root success="false" error="Error message" />
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.
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
GET /srv.asmx/UpdateVersionComment?authenticationTicket=abc123&documentPath=/Finance/Reports/Q1Summary.pdf&versionNumber=1000001&commentText=Initial+draft+submitted+for+review
AddDocumentComment. It is the author’s note attached to a specific version at check-in time.commentText to clear an existing comment.GetDocumentVersions to list all versions and their numbers before calling this API.