|API Support||Available since||Last updated||Output|
Archive an existing comment.
If the comment has been posted on multiple groups, archiving the comment will remove it from all the groups – even if the member archiving it only has access to one of the groups.
This service only archives a single comment in a discussion such that the other comments are preserved:
- The replies of an archived comment are always retained, regardless of its position in the discussion.
- If the archived comment is the first comment in a discussion, the immediately following reply will replace it as the first comment.
No parameters required – the comment is specified by the
xlinkid in the URL.
Only contributors and above can archive comments that have been posted, however, only managers and above can archive the comments of other members.
Members can always archive their own draft comments regardless of their role.
Administrators can archive any comment.
When successful, the archived comment is returned as a <comment> wrapped in a
<comment-archive> element as in the example below.
<comment-archive> <comment id="123" contentrole="archive-Comment" created="2012-03-08T12:34:00+10:00" [status="Open"] [due="2012-03-10T18:00:00+10:00"] [priority="High"] [moderated="true"]> <title>Cavern stolen!</title> <author email="firstname.lastname@example.org"> ... </author> <assignedto id="123" date="2012-03-09T..."> ... </assignedto> <modifiedby id="456" date="2012-03-09T..."> ... </modifiedby> <content id="789" type="text/plain">Sesame opened the door</content> <attachment> <uri id="189"> ... </uri> </attachment> <attachment fragment="5"> <uri id="289"> ... </uri> </attachment> </comment> </comment-archive>
contentrole of the comment should start with "
archive-" after the comment has been archived.
|Code||Cause / Description|
|0x1309||The comment is already archived|
|0x1311||The object specified is not a comment|
|0x1317||The comment was not found|
|0x6304||Failed to archive comment|
Created on , last edited on