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>"
 },
 "contentImages" : [ {
    "id" : "1055",
    "contentType" : "image/jpeg",
    "name" : "pic.jpeg",
    "ref" : "http://example.jiveon.com/api/core/v3/attachments/file/1055/data",
    "size" : 5953,
    "width" : 251,
    "height" : 201,
    "type" : "image"
 } ],
 "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

FieldTypeMode †Description
abuseCountIntegerread-only

Number of abuse reports associated with this content object.

authorPersonread-only

Author of this content object.

contentContentBodyrequired

Content of this content object.

contentImagesImage[]read-only

A list of Image objects providing metadata about images embedded within this content.

contentVideosContentVideo[]read-only

A list of ContentVideo objects providing metadata about videos embedded within this content.

externalIDStringread-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
favoriteCountIntegerread-only

Number of people who have bookmarked this object.

Availability:

Will be present only for object types that support being bookmarked.

Since: 3.11
helpfulCountIntegerread-onlyNumber of people who marked this reply as helpful
Availability:

Will be present for comments that have been marked helpful, if helpful acclaim is enabled

highlightBodyStringread-only

Highlight snippet of a search match in the body or description.

Availability:

Will be present in search results only.

highlightSubjectStringread-only

Highlight snippet of a search match in the subject or name.

Availability:

Will be present in search results only.

highlightTagsStringread-only

Highlight snippet of a search match in tags.

Availability:

Will be present in search results only.

iconCssStringread-only

CSS Style to locate icon within sprite.

idStringread-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.

lastActivityDateISO 8601 Dateread-only

Date and time when this had its last activity.

Since: 3.12
likeCountIntegerread-only

Number of people who have liked this object.

Availability:

Will be present only for object types that support being liked.

outcomeCountsObjectread-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
outcomeTypeNamesString[]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
outcomeTypesOutcomeType[]optional

A list of valid outcome types that can be set on this piece of content

pageNumberIntegerread-only
parentStringrequired

URI of the parent place (or person, for personal content) of this content object.

parentContentSummaryread-only

Summary information about the content object that is the parent of this object.

Availability:

Will be present in search results only.

parentContentVisibleBooleanread-only

Flag indicating that the content parent's contents are visible to the viewer.

parentIDIntegerread-only
parentPlaceSummaryread-only

Summary information about the place that contains this object.

Availability:

Will be present in search results only.

parentVisibleBooleanread-only

Flag indicating that the content parent is visible to the viewer.

publishedISO 8601 Dateread-only

Date and time when this content object was originally created.

publishedCalendarDateStringread-only
publishedTimeStringread-only
replyCountIntegerread-only

Number of replies to this object.

Availability:

Will be present only for object types that support replies.

resourcesObjectread-only

Resource links (and related permissions for the requesting person) relevant to this object.

rootExternalIDStringread-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
rootTypeStringread-only

Object type of the root content object that this comment is a direct or indirect reply to.

rootURIStringread-only

URI of the root content object that this comment is a direct or indirect reply to.

searchRankingsObjectread-only

A map of search result scores including social signals.

Availability:

Will be present in search results only.

statusStringread-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
subjectStringread-only

Subject of this content object.

typeStringrequired

The object type for this object ("comment"). This field is required when creating new content.

unhelpfulCountIntegerread-onlyNumber 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

updatedISO 8601 Dateread-only

Date and time this content object was most recently updated.

viewCountIntegerread-only

Number of times this content object has been viewed.

Availability:

Will be present only for objects that support view counts

canMarkHelpfulBooleanread-only
canMarkUnHelpfulBooleanread-only
followedBooleanread-only

Whether the current user is following this object.

Availability:

Will be present only for object types that support being followed.

hasVotedHelpfulBooleanread-only
hasVotedUnHelpfulBooleanread-only
promotedResultBooleanread-only

A boolean determining whether this search result is a promoted result

Availability:

Will be present in search results only.

unHelpfulEnabledBooleanread-only
†
→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Resources

ResourceMethodDescription
childOutcomeTypesGET

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

Retrieves:
  • OutcomeType[]
    • commentsPOST

    Add a comment about this comment.

    Takes:
    Retrieves:
  • Comment representing the recorded comment
    • commentsGET

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

    Retrieves:
  • Comment[]
    • extpropsDELETE

    Deletes all extended properties for content.

    Availability:

    Content should be editable to caller.

    extpropsGET

    Returns extended properties for content.

    Availability:

    Content should be visible to caller.

    Retrieves:
  • ExtProps[]
    • extpropsPOST

    Creates extended properties for content.

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

    Content should be editable to caller.

    Retrieves:
  • ExtProps[]
    • htmlGET

    Return the HTML representation of this content object.

    likesPOST

    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

    likesGET

    Return a paginated list of people who like this comment.

    Retrieves:
  • Person[]
    • markedHelpfulGET

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

    Retrieves:
  • Person[]
    • markedUnhelpfulGET

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

    Retrieves:
  • Person[]
    • helpfulPOST

    Register that the requesting person found that this message was helpful.

    Availability:

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

    unhelpfulPOST

    Register that the requesting person found that this message was not helpful.

    Availability:

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

    outcomesPOST

    Register that the requesting person created the outcome.

    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:
    Retrieves:
  • Outcome Representation of the newly created outcome
    • outcomesGET

    Return a paginated list of outcomes on the comment.

    Retrieves:
  • Outcome[]
    • outcomeTypesGET

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

    Retrieves:
  • OutcomeType[]
    • selfGET

    Return an updated version of this comment.

    Retrieves:
  • Comment describing this content object
    • selfPUT

    Update the information about this comment.

    Retrieves:
  • Comment representing the updated content object
    • selfDELETE

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

    likesDELETE

    Delete the like of this comment by the requesting person.

    Availability:

    Must be authenticated, and must have liked this comment already

    helpfulDELETE

    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

    unhelpfulDELETE

    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