Comments Resource

GET /replies

Get replies by ID.

Request Parameters
name type description default constraints multivalued
count query 100 int no
description_format query The desired format for the reply descriptions. Can be "html" or "text". text   no
first query 0 int no
id query The ID of a reply. Can be specified multiple times.   long yes
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of ReplyBrief objects.
application/xml searchResultList (XML)

DELETE /replies/{id}

Delete the specified reply and its child replies.

Request Parameters
name type description constraints
id path The ID of the folder entry. long

GET /replies/{id}

List the first level of replies to this reply.

Request Parameters
name type description default constraints
id path The ID of the reply.   long
description_format query The desired format for the reply description in the response. Can be "html" or "text". text  
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of Reply objects.
application/xml searchResultList (XML)

GET /replies/{id}

Get a reply.

Request Parameters
name type description default constraints
id path The ID of the repy.   long
description_format query The desired format for the reply description. Can be "html" or "text". text  
include_attachments query Whether to include file attachment metadata in the response. true boolean
Response Body
media type data type
application/json Reply (JSON)
application/xml reply (XML)

POST /replies/{id}

Add a reply to the specified reply.

Request Parameters
name type description default constraints
id path The ID of the reply.   long
description_format query The desired format for the folder entry description in the response. Can be "html" or "text". text  
Request Body
media type data type description
application/json Reply (JSON) The reply to add. The description text must be specified in the Reply object. The title is optional.
application/xml reply (XML)
Response Body
media type data type description
application/json Reply (JSON) The new Reply object.
application/xml reply (XML)

PUT /replies/{id}

Update the reply.

Request Parameters
name type description default constraints
id path The ID of the reply.   long
description_format query The desired format for the reply description in the response. Can be "html" or "text". text  
Request Body
media type data type description
application/json Reply (JSON) The updated Reply object.
application/xml reply (XML)
Response Body
media type data type description
application/json Reply (JSON) The updated Reply object.
application/xml reply (XML)

GET /replies/{id}/reply_tree

Get a tree structure with all of the replies to this reply.

Request Parameters
name type description default constraints
id path The ID of the reply.   long
description_format query The desired format for the reply descriptions in the response. Can be "html" or "text". text  
Response Body
media type data type description
application/json SearchResultTree (JSON) A SearchResultTree of Reply objects.
application/xml searchResultTree (XML)