osapi.jive.corev3.contents.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 with the most important data for a Comment.

{
 "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"
}

Create a Comment on a Document

Read createComment() to learn how to create a new comment on a document.

Create an Author Comment on a Document

Read createComment() to learn how to create a new author comment on a document.

Properties

Property	Type	Mode †	Description
`abuseCount`	`Integer`	read-only	↑ Number of abuse reports associated with this content object.
`author`	`Person`	read-only	↑ Author of this content object.
`content`	`ContentBody`	required	↑ Content of this content object.
`contentImages`	`Image[]`	read-only	↑ A list of Image objects providing metadata about images embedded within this content.
`contentVideos`	`ContentVideo[]`	read-only	↑ A list of ContentVideo objects providing metadata about videos embedded within this content.
`externalID`	`String`	read-only	↑ A string identifier, such as an Open Graph id, that can be used to identify this comment object in an external system. This property may be set when a comment is created, but cannot be changed. This field is typically used when synchronizing comment streams between Jive and some other system. Since: 3.3
`favoriteCount`	`Integer`	read-only	↑ Number of people who have bookmarked this object. Availability: Will be present only for object types that support being bookmarked. Since: 3.11
`helpfulCount`	`Integer`	read-only	↑ Number of people who marked this reply as helpful Availability: Will be present for comments that have been marked helpful, if helpful acclaim is enabled
`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.
`iconCss`	`String`	read-only	↑ CSS Style to locate icon within sprite.
`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.
`isCanMarkHelpful`	`Boolean`	read-only	↑
`isCanMarkUnHelpful`	`Boolean`	read-only	↑
`isFollowed`	`Boolean`	read-only	↑ Whether the current user is following this object. Availability: Will be present only for object types that support being followed.
`isHasVotedHelpful`	`Boolean`	read-only	↑
`isHasVotedUnHelpful`	`Boolean`	read-only	↑
`isPromotedResult`	`Boolean`	read-only	↑ A boolean determining whether this search result is a promoted result Availability: Will be present in search results only.
`isUnHelpfulEnabled`	`Boolean`	read-only	↑
`lastActivityDate`	`ISO 8601 Date`	read-only	↑ Date and time when this had its last activity. Since: 3.12
`likeCount`	`Integer`	read-only	↑ Number of people who have liked this object. Availability: Will be present only for object types that support being liked.
`outcomeCounts`	`Object`	read-only	↑ Map of structured outcome type names that have been assigned to this content object, and a count of how many times they appear. For top level content objects like Discussion, Document, File, and Post, outcomes assigned to child comments and messages will also be included. Availability: Only available for content object types that support structured outcomes Since: 3.3
`outcomeTypeNames`	`String[]`	read-only	↑ List of structured outcome type names that have been assigned to this content object. For top level content objects like Discussion, File, and Document, outcomes assigned to child comments and messages will also be included. Availability: Only available for content object types that support structured outcomes Since: 3.3
`outcomeTypes`	`OutcomeType[]`	optional	↑ A list of valid outcome types that can be set on this piece of content
`pageNumber`	`Integer`	read-only	↑
`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.
`parentContentVisible`	`Boolean`	read-only	↑ Flag indicating that the content parent's contents are visible to the viewer.
`parentID`	`Integer`	read-only	↑
`parentPlace`	`Summary`	read-only	↑ Summary information about the place that contains this object. Availability: Will be present in search results only.
`parentVisible`	`Boolean`	read-only	↑ Flag indicating that the content parent is visible to the viewer.
`published`	`ISO 8601 Date`	read-only	↑ Date and time when this content object was originally created.
`publishedCalendarDate`	`String`	read-only	↑
`publishedTime`	`String`	read-only	↑
`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.
`rootExternalID`	`String`	read-only	↑ A string identifier, such as an Open Graph id, that can be used to identify the root content object of this comment in an external system. This field is typically used when synchronizing comment streams between Jive and some other system. Since: 3.3
`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.
`searchRankings`	`Object`	read-only	↑ A map of search result scores including social signals. Availability: Will be present in search results only.
`status`	`String`	read-only	↑ Published status of this content object. `incomplete` - Content object is in draft mode `awaiting moderation` - Content object is waiting for moderation by an approver `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.
`typeCode`	`Integer`	read-only	↑
`unhelpfulCount`	`Integer`	read-only	↑ Number of people who marked this reply as unhelpful Availability: Will be present for comments that have been marked unhelpful, if unhelpful (negative) acclaim is enabled
`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

Methods

↑

createComment(comment,options)
POST /comments/1234/comments

Retrieves

Comment

Description

Add a comment about this comment.

Takes:

Comment describing the new comment

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned
author	String	false	Flag indicating if new comment is an author comment or a regular comment (only valid for documents). By default a regular comment will be created.

Retrieves:

Comment representing the recorded comment

↑

createExtProps(uriinfo,options)
POST /contents/1234/extprops

Retrieves

ExtProps[]

Description

Creates extended properties for content.

 {
  "any prop name": "any val",
  "any prop2 name": "any val"
 }

Availability:

Content should be editable to caller.

Options:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned

Retrieves:

ExtProps[]

↑

createOutcome(outcome,options)
POST /comments/1234/outcomes

Retrieves

Outcome

Description

Here is an example of a JSON with the minimum set of fields you must include:

{
  "outcomeType":
      {
          "id": 1
      }
}

Availability:

Must be authenticated, must not be able to read the comment, and must not have the same outcome type on this comment already

Takes:

Outcome the outcome to be created.

Options:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned.

Retrieves:

Outcome Representation of the newly created outcome

↑

deleteExtProps()
DELETE /contents/1234/extprops

Retrieves

--

Description

Deletes all extended properties for content.

Availability:

Content should be editable to caller.

↑

destroy(options)
DELETE /comments/1234

Retrieves

--

Description

Delete this comment and any related comments and other related information.

↑

get(options)
GET /comments/1234

Retrieves

Comment

Description

Return an updated version of this comment.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Comment describing this content object

↑

getChildOutcomeTypes(options)
GET /contents/1234/childOutcomeTypes

Retrieves

OutcomeType[]

Description

Return a paginated list of possible outcomes types on the content object's children.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcome types to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

OutcomeType[]

↑

getComments(options)
GET /comments/1234/comments

Retrieves

Comment[]

Description

Return a paginated list of the comments about this content object.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of comments to be returned (default is 25)
anchor	String	false	optional URI for a comment to anchor at. Specifying a anchor will try to return the page containing the anchor. If the anchor could not be found then the first page of comments will be returned.
excludeReplies	Boolean	false	Flag indicating that replies to the direct comments about this direct message should be excluded (default is false)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first comment to be returned (default is zero)

Retrieves:

Comment[]

↑

getExtProps(options)
GET /contents/1234/extprops

Retrieves

ExtProps

Description

Returns extended properties for content.

Availability:

Content should be visible to caller.

Options:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned

Retrieves:

ExtProps[]

↑

getLikes(options)
GET /comments/1234/likes

Retrieves

Person[]

Description

Return a paginated list of people who like this comment.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of people to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

Person[]

↑

getMarkedHelpful(options)
GET /comments/1234/helpful

Retrieves

Person[]

Description

Return a paginated list of people who have marked this comment helpful.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of people to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

Person[]

↑

getMarkedUnhelpful(options)
GET /comments/1234/unhelpful

Retrieves

Person[]

Description

Return a paginated list of people who have marked this comment unhelpful.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of people to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

Person[]

↑

getOutcomes(options)
GET /comments/1234/outcomes

Retrieves

Outcome[]

Description

Return a paginated list of outcomes on the comment.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcomes to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

Outcome[]

↑

getOutcomeTypes(options)
GET /comments/1234/outcomeTypes

Retrieves

OutcomeType[]

Description

Return a paginated list of possible outcomes types on the comment.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcome types to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

OutcomeType[]

↑

like()
POST /comments/1234/likes

Retrieves

--

Description

Availability:

Must be authenticated, must not be your own comment, and must not have liked this comment already

↑

markHelpful()
POST /comments/1234/helpful

Retrieves

--

Description

Availability:

Must be authenticated, must not be the requesting person's own message

↑

markUnhelpful()
POST /comments/1234/unhelpful

Retrieves

--

Description

Availability:

Must be authenticated, must not be the requesting person's own message, and must have been marked helpful by someone else first

↑

toURI()

Retrieves

String

Description

Retrieves:

A URI representing this entity, or undefined if no such URI exists.

↑

unlike()
DELETE /comments/1234/likes

Retrieves

--

Description

Delete the like of this comment by the requesting person.

Availability:

Must be authenticated, and must have liked this comment already

↑

unmarkHelpful()
DELETE /comments/1234/helpful

Retrieves

--

Description

Un-register that the requesting person found that this message was helpful.

Availability:

Must be authenticated, must not be the requesting person's own message, must have been previously been marked helpful by the requesting person

↑

unmarkUnhelpful()
DELETE /comments/1234/unhelpful

Retrieves

--

Description

Un-register that the requesting person found that this message was not helpful.

Availability:

Must be authenticated, must not be your own message, must have been previously marked as not helpful by the requesting person

↑

update(options)
PUT /comments/1234

Retrieves

Comment

Description

Update the information about this comment.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Comment representing the updated content object

Resources

Resource	Method	Returns	Description
`html`	`GET`	`Object`	↑ Return the HTML representation of this content object.

osapi.jive.corev3.contents.Comment

Examples:

Example JSON

Properties

Methods

Resources

Properties

Since: 3.3

Availability:

Since: 3.11

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Since: 3.12

Availability:

Availability:

Since: 3.3

Availability:

Since: 3.3

Availability:

Availability:

Availability:

Since: 3.3

Availability:

Availability:

Availability:

Methods

Retrieves

Description

Takes:

Options:

Retrieves:

Retrieves

Description

Availability:

Options:

Retrieves:

Retrieves

Description

Availability:

Takes:

Options:

Retrieves:

Retrieves

Description

Availability:

Retrieves

Description

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Availability:

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves: