Skip to main content

 Services

Web services from /about to /webhooks

create comment uri

/members/{member}/uris/{uri}/comments [POST]

com.pageseeder.comment.CreateComment

Description

Use this service to create a new comment against a URI.

Parameters

NameDescriptionRequiredTypeDefault
contentThe content of the comment. XHTML content is sanitized.yesstring
groupsA comma-separated list of group names the comment should belong toyesstrings
titleThe title of the comment. Max 255 charactersyesstring
assignedtoThe ID of the member to assign the task to – status MUST be setnolong
authoremailThe email address of the author (manager only)noemailThe current member’s email
authornameThe name of the author (manager only)nostringThe current member’s name
contenttypeThe media type of the commentnostringtext/plain 
createdThe creation date of the comment in ISO-8601 e.g. 2010-10-25T12:26:00+10:00 (manager only)nodatetimeThe current datetime
dueThe task due date, format is ISO-8601 – status MUST be set e.g. 2010-10-25, 2010-10-25T12:26 (defaults to T18:00)nodate or datetimeThe due date of previous comment in thread
labelsA comma-separated list of label valuesnolabel
notifyThe notification behaviornonotifynormal
notify-asyncWhether emails should be sent asynchronously (for slow email servers)nobooleanfalse
priorityThe priority for the task e.g. High, Medium, Low – status MUST be setnopriorityThe priority of the previous comment in thread
propertiesA pipe-separated list of value pairs (e.g. x=1|y=2|)nostring
statusThe task status value, e.g. OpennostatusThe status of the previous comment in thread
typeThe type of the commentnostring
urisComma-separated list of attachments as URI ID with optional !fragment e.g. 123,23,456!content,34!titlenolong
urlsComma-separated list of attachments as URL with optional #fragmentnourl
draftWhether the comment is a draftnobooleanfalse

Status

The  @status attribute must use a value that has been defined in the group properties. For example: “Open”, “Resolved”, “Closed”.

Priority

The @priority attribute must use a value that has been defined in the group properties. For example: “High”, “Medium”, “Low”.

Permission

By default this service requires reviewer or higher in the document's group.

Response

<comment-creation [notification-email-delayed="true"|
                  notification-email-failed="true"|
                  moderator-email-failed="true"]
                  [notify-param-ignored="true"]
                  [public="true"]>
  <comment id="123"
           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>

    <!-- Only for tasks -->
    <assignedto id="123" date="2012-03-09T..."> ... </assignedto>

    <!-- Only if modified -->
    <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-creation>
 

Error Handling

CodeCause / Description
0x1306Missing required groups or the Group is invalid
0x0000Missing required title
0x1306The URI was not accessible to the group. The status is required to validate
0x1307The assigned to member is invalid. The status is required to validate
0x1308The due date is invalid
0x0201Missing required content
0x6301If the group has no general discussion
0x6302Failed to create new comment
0x0802The title can has maximum length of 255
Created on , last edited on