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>"
 },
 "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
answerBooleanoptional

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

attachmentsAttachment[]optional

List of attachments to this message (if any).

authorPersonread-only

Author of this content object.

contentContentBodyrequired

Content of this content object.

discussionStringread-only

URI of the discussion that this message belongs to.

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.

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.

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.

likeCountIntegerread-only

Number of people who have liked this object.

Availability:

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

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

parentPlaceSummaryread-only

Summary information about the place that contains this object.

Availability:

Will be present in search results only.

publishedISO 8601 Dateread-only

Date and time when this content object was originally created.

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.

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

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.

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

Resources

ResourceMethodDescription
attachmentsGET

Return a list of attachments associated to this message.

Retrieves:
  • Attachment[]
    • 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

    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[]
    • 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