Comment

Representation of a comment object. Documents, polls, direct messages, and blog posts can be commented on. Note that an object that can be commented on will have a comments resource.

Examples:

Example JSON

JSON including important fields and a Comment's resources. See the tables below for a list of all fields and resources.

{
 "type" : "comment",
 "status" : "published",
 "subject" : "My First Document",
 "parent" : "https://example.jiveon.com/api/core/v3/contents/1181",
 "content" : {
   "type" : "text/html",
   "text" : "<body><p>I really like your document!</p></body>"
 },
 "author" : {
   "name" : {
     "formatted" : "Administrator"
   },
   "type" : "person",
   "displayName" : "Administrator",
   "id" : "1"
 },
 "replyCount" : 0,
 "likeCount" : 0,
 "published" : "2012-07-10T21:43:47.026+0000",
 "updated" : "2012-07-10T21:43:47.026+0000",
 "id" : "1211",
 "resources" : {
   "likes" : {
     "ref" : "https://example.jiveon.com/api/core/v3/comments/1211/likes",
     "allowed" : [ "POST", "GET" ]
   },
   "self" : {
     "ref" : "https://example.jiveon.com/api/core/v3/comments/1211",
     "allowed" : [ "PUT", "DELETE", "GET" ]
   },
   "html" : {
     "ref" : "https://example.jiveon.com/docs/DOC-1331#comment-1211",
     "allowed" : [ "GET" ]
   },
   "comments" : {
     "ref" : "https://example.jiveon.com/api/core/v3/comments/1211/comments",
     "allowed" : [ "POST", "GET" ]
   }
 }
}

Create a Comment

POST to /contents/{contentID}/comments creates a new comment on a content. The minimum set of fields you must include are:

 {
  "content": {"type": "text/html", "text": "<body><p>This is a public comment</p></body>"},
  "type": "comment"
  }

Create an Author Comment

POST to /contents/{contentID}/comments?author=true creates a new author comment on a content. The minimum set of fields you must include are:

 {
  "content": {"type": "text/html", "text": "<body><p>This is a author comment</p></body>"},
  "type": "comment"
  }

Fields

Field	Type	Mode †	Description
`author`	`Person`	read-only	Author of this content object.
`content`	`ContentBody`	required	Content of this content object.
`highlightBody`	`String`	read-only	Highlight snippet of a search match in the body or description. Availability: Will be present in search results only.
`highlightSubject`	`String`	read-only	Highlight snippet of a search match in the subject or name. Availability: Will be present in search results only.
`highlightTags`	`String`	read-only	Highlight snippet of a search match in tags. Availability: Will be present in search results only.
`id`	`String`	read-only	Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs.
`likeCount`	`Integer`	read-only	Number of people who have liked this object. Availability: Will be present only for object types that support being liked.
`parent`	`String`	required	URI of the parent place (or person, for personal content) of this content object.
`parentContent`	`Summary`	read-only	Summary information about the content object that is the parent of this object. Availability: Will be present in search results only.
`parentPlace`	`Summary`	read-only	Summary information about the place that contains this object. Availability: Will be present in search results only.
`published`	`ISO 8601 Date`	read-only	Date and time when this content object was originally created.
`replyCount`	`Integer`	read-only	Number of replies to this object. Availability: Will be present only for object types that support replies.
`resources`	`Object`	read-only	Resource links (and related permissions for the requesting person) relevant to this object.
`rootType`	`String`	read-only	Object type of the root content object that this comment is a direct or indirect reply to.
`rootURI`	`String`	read-only	URI of the root content object that this comment is a direct or indirect reply to.
`status`	`String`	read-only	Published status of this content object. `incomplete` - Content object is in draft mode `pending_approval` - Content object is waiting for approval `rejected` - Content object has been rejected for publication by an approver `published` - Content object has been published
`subject`	`String`	read-only	Subject of this content object.
`type`	`String`	required	The object type for this object ("comment"). This field is required when creating new content.
`updated`	`ISO 8601 Date`	read-only	Date and time this content object was most recently updated.
`viewCount`	`Integer`	read-only	Number of times this content object has been viewed. Availability: Will be present only for objects that support view counts

Resources

Resource	Method	Description
`comments`	`POST`	Add a comment about this comment. Takes: Comment describing the new comment Retrieves: Comment representing the recorded comment
`comments`	`GET`	Return a paginated list of the comments about this content object. Retrieves: Comment[]
`html`	`GET`	Return the HTML representation of this content object.
`likes`	`POST`	Register that the requesting person likes this comment. Availability: Must be authenticated, must not be your own comment, and must not have liked this comment already
`likes`	`GET`	Return a paginated list of people who like this comment. Retrieves: Person[]
`self`	`GET`	Return an updated version of this comment. Retrieves: Comment describing this content object
`self`	`PUT`	Update the information about this comment. Retrieves: Comment representing the updated content object
`self`	`DELETE`	Delete this comment and any related comments and other related information.
`likes`	`DELETE`	Delete the like of this comment by the requesting person. Availability: Must be authenticated, and must have liked this comment already

Comment

Examples:

Example JSON

Create a Comment

Create an Author Comment

Fields

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Resources

Takes:

Retrieves:

Retrieves:

Availability:

Retrieves:

Retrieves:

Retrieves:

Availability: