POST resource/comment

Adds a comment in a resource. It can be a response of another parent comment.

Request Information

Headers

HTTP_AUTHORIZATION: Required. OAuth 1.0 parameters with the OAuth signature of the url you are going to request. The consumer keys and access token can be obtained from the community administration.

Sample:
        HTTP_AUTHORIZATION:
            OAuth oauth_token="CObXqjfOisVh9%2F2GjC7NNd8BCzY%3D",
            oauth_consumer_key="clGACsiGaMp%2FD%2BUwkSvRBxA1k50%3D",
            oauth_nonce="VqKza6d5x1HpPQWFe08spbdOnkTQpfaLfD9Oeuyg",
            oauth_signature_method="HMAC-SHA1",
            oauth_timestamp="1462882011",
            oauth_signature="RH5aKKKJaEvK5cIsZZzXtFh7cCk%3D"
    

Body Parameters

NameDescriptionTypeAdditional information
community_short_name

Community short name

string

Required

resource_id

Resource identificator

globally unique identifier

Required

user_short_name

User short name

string

Required

html_description

Description of the comment

string

Required

parent_comment_id

Parent comment identificator (if the comment is an answer to another comment)

globally unique identifier

Optional

comment_date

Comment date

date

Required

publish_home

True if the comment must be pusblished in the community home

boolean

Optional

Request Formats

application/json, text/json

Sample:
{
  "community_short_name": "developers",
  "resource_id": "dda4a08a-6a33-40fe-be0e-edadfd27e514",
  "user_short_name": "javadeveloper@organization.com",
  "html_description": "<p>good topic for debate as we take some beers ;)</p>",
  "parent_comment_id": "00000000-0000-0000-0000-000000000000",
  "comment_date": "2015-05-12T00:00:00",
  "publish_home": false
}

Response Information

Resource Description

DescriptionType

Comment identifier Guid

Guid

Response Formats

application/json, text/json

Sample:
"bb370fd4-e759-4f89-b345-d3e80a0c8009"

Response HTTP status code

On success, the response contains 200 code.

On fail, throws a WebException with code:

  • 401 Unauthorized if the OAuth signature is invalid
  • 400 Bad Request if the params are invalid
  • 500 Internal server error if something goes wrong...