Skip to main content

 Web service API

How to use PageSeeder's Web service API

edit comment

/members/{member}/comments/{commentid}/edit [POST]

com.pageseeder.comment.EditComment

Description

Edit comment.

This service has been deprecated, use service /members/{member}/comments/{commentid} [PATCH] instead.

 

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 media 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
groupsComma-separated list of group names all comments in the discussion thread belong to (ignored if this comment is a reply)nostring
labelsComma-separated list of labelsnostring
moderatedIf true the comment is to be moderated noboolean
moverepliesIf true any replies are also moved (if a manager groups are 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

Permission

The member on the request needs to be a contributor or higher.

Response

Undocumented XML response

Error Handling

CodeCause / Description
0x1002Invalid email address
0x1303Only one of uri, url, group or replyto can be specified
0x1304The URL is invalid
0x1305The URL does not match a GroupURI
0x1306The Group is invalid
0x1307The assigned to member is invalid
0x1308The due date is invalid
0x1309The comment is archived
0x1311The object specified is not a comment
0x1317The replyto comment was not found
0x1318URI not found
0x1324Comment can’t be a reply to itself
0x6301If the group has no general discussion
0x6303Failed to edit comment
0x6306The replyto comment has no context URI
Created on , last edited on