osapi.jive.corev3.contents.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).

Example:
Example JSON

JSON with the most important data for a Message. See the table below for a list of all fields.

 {
 "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" : [ ]
 }

Properties

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

contentImagesImage[]read-only
contentVideosObject[]read-only
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.

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.

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

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

Methods

correctAnswer()
PUT /messages/1234/correctAnswer

Retrieves

--

Description

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

createExtProps(extprop,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:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • ExtProps[]
  • createOutcome(outcome,options)
    POST /messages/1234/outcomes

    Retrieves

    Outcome

    Description

    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:
    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned.
    Retrieves:
  • Outcome Representation of the newly created outcome
  • createReply(message,options)
    POST /messages/1234/messages

    Retrieves

    Message

    Description

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

    Takes:
    • Message fields describing the new message
    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Message describing the newly created message
  • deleteExtProps()
    DELETE /contents/1234/extprops

    Retrieves

    --

    Description

    Deletes all extended properties for content.

    Availability:

    Content should be editable to caller.

    destroy()
    DELETE /messages/1234

    Retrieves

    --

    Description

    Delete this message and all messages associated with it.

    get(options)
    GET /messages/1234

    Retrieves

    Message

    Description

    Return an updated version of this message.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Message representing the updated message
  • getAttachments(options)
    GET /attachments/messages/1234

    Retrieves

    Attachment[]

    Description

    Return a list of attachments associated to this message.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Attachment[]
  • getChildOutcomeTypes(options)
    GET /contents/1234/childOutcomeTypes

    Retrieves

    OutcomeType[]

    Description

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

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of outcome types to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first person to return (default is 0)
    Retrieves:
  • OutcomeType[]
  • getExtProps(options)
    GET /contents/1234/extprops

    Retrieves

    ExtProps

    Description

    Returns extended properties for content.

    Availability:

    Content should be visible to caller.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • ExtProps[]
  • getLikes(options)
    GET /messages/1234/likes

    Retrieves

    Person[]

    Description

    Return a paginated list of people who like this message.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of people to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first person to return (default is 0)
    Retrieves:
  • Person[]
  • getOutcomes(options)
    GET /messages/1234/outcomes

    Retrieves

    Outcome[]

    Description

    Return a paginated list of outcomes on the message.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of outcomes to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first person to return (default is 0)
    Retrieves:
  • Outcome[]
  • getOutcomeTypes(options)
    GET /messages/1234/outcomeTypes

    Retrieves

    OutcomeType[]

    Description

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

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of outcome types to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first person to return (default is 0)
    Retrieves:
  • OutcomeType[]
  • getReplies(options)
    GET /messages/1234/messages

    Retrieves

    Message[]

    Description

    Return a paginated list of replies to this message.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of replies to return (default is 25)
    anchorStringfalseoptional URI for a message 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 messages will be returned.
    excludeRepliesBooleanfalseFlag indicating whether to exclude replies (and therefore return direct replies only)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first reply to return (default is 0)
    Retrieves:
  • Message[]
  • like()
    POST /messages/1234/likes

    Retrieves

    --

    Description

    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

    removeCorrectAnswer()
    DELETE /messages/1234/correctAnswer

    Retrieves

    --

    Description

    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

    toURI()

    Retrieves

    String

    Description

    Retrieves:
  • A URI representing this entity, or undefined if no such URI exists.
  • unlike()
    DELETE /messages/1234/likes

    Retrieves

    --

    Description

    Delete the like of this message by the requesting person.

    Availability:

    Must be authenticated, and must have liked this message already

    update(multipartbody,options)
    PUT /messages/1234

    Retrieves

    Message

    Description

    Update the information about this message.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    minorStringfalseFlag indicating that this is a minor update and should not trigger events (true) or not (false)
    Retrieves:
  • Message representing the updated message
  • Resources

    ResourceMethodReturnsDescription
    htmlGETObject

    Return the HTML representation of this message.