Web service API

How to use PageSeeder's Web service API

comment

/members/{member}/comments/{commentid} [PATCH]

com.pageseeder.comment.EditComment

Description

Edits an existing comment.

Parameters

NameDescriptionRequiredTypeDefault value
assignedtothe assigned member for task - status/previous status must be setnostring
attachmentgroupthe group to get the attachments to register from (only used if draft is set from false to true)nostring
authoremailthe email of the author (manager only or draft from non-member)nostring
authornamethe name of the author (manager only or draft from non-member)nostring
contentthe content of the commentnostring
contenttypethe content type of the commentnostring
createdthe creation date of the comment in ISO-8601 e.g. 2010-10-25T12:26:00+10:00 (manager only)nodatetime
draftwhether the comment is a draftnoboolean
duethe task due date format is ISO-8601 - status/previous status must be set e.g. 2010-10-25, 2010-10-25T12:26 (defaults to T18:00)nodatetime
fragmentthe URI fragment to move this comment to (only applies to uri parameter)nostringdefault
groupthe name of the group to move this comment tonostring
groupsthe groups the comment should belong to (comma-separated list of names)nostring
labelscomma-separated list of labelsnostring
moderatedif true the comment is to be moderatednoboolean
moverepliesif true any replies will also be moved (if a manager groups will be added to replies)nobooleantrue
notifythe notification behaviornonotificationsilent
prioritythe priority for task e.g. 'High', 'Medium', 'Low' - status/previous status must be setnostring
propertiespipe-separated list of properties (e.g. x=1|y=2|)nostring
replythe comment ID to make this comment a reply tonolong
statusthe status for task e.g. 'Open', 'Resolved', 'Closed'nostring
titlethe title of the commentnostring
typethe type of commentnostring
urithe URI ID to move this comment tonolong
uristhe attachments to this comment (comma-separated list of URI IDs with optional !fragments)nostring
urlthe URL with optional #fragment to move this comment tonourl
urlsthe attachments to this comment (comma-separated list of urls with optional #fragments)nostring

No parameters are required, but parameters which are specified will modify the comment accordingly. 

Permission

Undocumented permissions requirements.

Response

<comment-modification [notification-email-delayed="true"|
                        notification-email-failed="true"]
                       [notify-param-ignored="true"]
                       [public="true"]>
   <comment id="123"
                discussionid="122"
                 contentrole="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="alibaba@fortythieves.com.au"> ... </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>
      <context fragment="2">
         <uri id="789">...</uri>
      <context>
      <attachment>
         <uri id="189">...</uri>
      <attachment>
      <attachment fragment="5">
         <uri id="289">...</uri>
      </attachment>
   </comment>
</comment-modification>

Error handling

CodeCause / Description
0x1002 Invalid email address
0x1303 Only one of uri, url, group or replyto can be specified
0x1304 The URL is invalid
0x1305 The URL does not match a GroupURI
0x1306 The Group is invalid
0x1307 The assigned to member is invalid
0x1308 The due date is invalid
0x1309 The comment is archived
0x1311 The object specified is not a comment
0x1317 The replyto comment was not found
0x1318 URI not found
0x1324 Comment can't be a reply to itself
0x6301 If the group has no general discussion
0x6303 Failed to edit comment
0x6306 The replyto comment has no context URI

Created on , last edited on