Message

An entity representing a message (reply) in a discussion. One or more messages in a particular discussion may be marked as helpful, and at most one message can be marked as correct, by setting the helpful or answer fields, respectively, to true. To create a message that is a direct reply to a Discussion, POST to the "messages" resource of a discussion. These endpoints are of the form /messages/contents/{discussionID}. To reply to a Message, use the "messages" resource of a Message (see Resources section below).

Examples:
Example JSON

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

 {
 "type" : "message",
 "status" : "published",
 "subject" : "Re: New Discussion",
 "parent" : "https://example.jiveon.com/api/core/v3/contents/1236",
 "discussion" : "https://example.jiveon.com/api/core/v3/contents/1236",
 "content" : {
   "type" : "text/html",
   "text" : "<body><p>This discussion is insightful!</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"
 },
 "visibleToExternalContributors" : false,
 "replyCount" : 0,
 "followerCount" : 0,
 "likeCount" : 0,
 "published" : "2012-07-09T21:32:47.368+0000",
 "updated" : "2012-07-09T21:32:47.368+0000",
 "attachments" : [ ],
 "tags" : [ ],
 "id" : "1126",
 "resources" : {
   "likes" : {
     "ref" : "https://example.jiveon.com/api/core/v3/messages/1126/likes",
     "allowed" : [ "GET" ]
   },
   "self" : {
     "ref" : "https://example.jiveon.com/api/core/v3/messages/1126",
     "allowed" : [ "PUT", "DELETE", "GET" ]
   },
   "html" : {
     "ref" : "https://example.jiveon.com/message/1126#1126",
     "allowed" : [ "GET" ]
   },
   "attachments" : {
     "ref" : "https://example.jiveon.com/api/core/v3/attachments/messages/1126",
     "allowed" : [ "POST", "GET" ]
   },
   "messages" : {
     "ref" : "https://example.jiveon.com/api/core/v3/messages/1126/messages",
     "allowed" : [ "POST", "GET" ]
   }
  }
 }
Simple Reply to a Discussion

POST to /messages/contents/{contentID} creates a new reply. The minimum set of fields you must include are: 

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

For more information refer to Discussion

Fields

FieldTypeMode †Description
abuseCountIntegerread-only

Number of abuse reports associated with this content object.

answerBooleanoptional

Flag indicating that this message contains the correct answer to the question posed in this discussion.

answeredQuestionCountIntegerread-onlyNumber of people who found this reply answered their question.
Availability:

Will be present only for replies that were marked correct.

attachmentsAttachment[]optional

List of attachments to this message (if any).

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.

discussionStringread-only

URI of the discussion that this message belongs to.

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
followerCountIntegerread-only

Number of people following this object.

Availability:

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

fromQuestStringoptional

Flag indicating that this document was created as part of a quest.

Since: 3.2
helpfulBooleanoptional

Flag indicating that this message contains a helpful answer to the question posed in this discussion.

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

Will be present for replies 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.

messageTargetStringread-only

Information that is available when the message was posted via an external system.

Since: 3.3
onBehalfOfOnBehalfOfoptional

Information that is available when the message was posted by the author on behalf of another person. This person may be an anonymous user, an unknown user with just an email address or another user of Jive.

Since: 3.3
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

parentStringoptional

URI of the parent Discussion or Message that this message is in reply to. The parent field is not required when creating a message from a discussion or another message (using their messages resource in REST or a javascript instance method).

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.

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.

questionBooleanoptional

Flag indicating that this message is a question

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.

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.

tagsString[]optional

Tags associated with this object.

Availability:

Will be present only for object types that support tags

typeStringrequired

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

unhelpfulCountIntegerread-onlyNumber of people who marked this reply as unhelpful
Availability:

Will be present for replies 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.

viaViaoptional

Information that is available when the message was posted via an external system.

Since: 3.3
viewCountIntegerread-only

Number of times this content object has been viewed.

Availability:

Will be present only for objects that support view counts

visibleToExternalContributorsBooleanread-only

Flag indicating that this content object is potentially visible to external contributors.

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
answeredQuestionPOST

Register that the requesting person found this reply to have answered their question.

Availability:

Must be authenticated, must not be the requesting person's own discussion, must be a discussion that was a question, and must not have already indicated that this reply answered your question.

answeredQuestionsGET

Return a paginated list of people who also found that this reply answered their question.

Retrieves:
  • Person[]
    • attachmentsGET

    Return a list of attachments associated to this message.

    Retrieves:
  • Attachment[]
    • childOutcomeTypesGET

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

    Retrieves:
  • OutcomeType[]
    • correctAnswerPUT

    Mark this reply as correct

    Availability:

    Must be authenticated, must be a creator of the question or a group admin, and must not have marked a reply correct already

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

    likesPOST

    Register that the requesting person likes this message.

    Availability:

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

    likesGET

    Return a paginated list of people who like this message.

    Retrieves:
  • Person[]
    • markedHelpfulGET

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

    Retrieves:
  • Person[]
    • markedUnhelpfulGET

    Return a paginated list of people who have marked this message 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 message.

    Retrieves:
  • Outcome[]
    • outcomeTypesGET

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

    Retrieves:
  • OutcomeType[]
    • correctAnswerDELETE

    Remove the correctAnswer from this reply

    Availability:

    Must be authenticated, must be a creator of the question or a group admin, and must have marked this reply correct already

    messagesGET

    Return a paginated list of replies to this message.

    Retrieves:
  • Message[]
    • messagesPOST

    Create a new reply to this message, and return a Message representing the new object.

    Takes:
    • Message fields describing the new message
    Retrieves:
  • Message describing the newly created message
    • selfGET

    Return an updated version of this message.

    Retrieves:
  • Message representing the updated message
    • selfPUT

    Update the information about this message.

    Retrieves:
  • Message representing the updated message
    • selfDELETE

    Delete this message and all messages associated with it.

    likesDELETE

    Delete the like of this message by the requesting person.

    Availability:

    Must be authenticated, and must have liked this message already

    answeredQuestionDELETE

    Un-register that the requesting person found that this message answered their own question.

    Availability:

    Must be authenticated, must not be the requesting person's own discussion, must be a discussion that was a question, and must have already indicated that this reply answered your question.

    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, and must have been previously 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