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

Resources

html GET

Properties

Property	Type	Mode †	Description
`abuseCount`	`Integer`	read-only	↑ Number of abuse reports associated with this content object.
`answer`	`Boolean`	optional	↑ Flag indicating that this message contains the correct answer to the question posed in this discussion.
`answeredQuestionCount`	`Integer`	read-only	↑ Number of people who found this reply answered their question. Availability: Will be present only for replies that were marked correct.
`attachments`	`Attachment[]`	optional	↑ List of attachments to this message (if any).
`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.
`discussion`	`String`	read-only	↑ URI of the discussion that this message belongs to.
`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
`followerCount`	`Integer`	read-only	↑ Number of people following this object. Availability: Will be present only for object types that support being followed.
`fromQuest`	`String`	optional	↑ Flag indicating that this document was created as part of a quest. Since: 3.2
`helpful`	`Boolean`	optional	↑ Flag indicating that this message contains a helpful answer to the question posed in this discussion.
`helpfulCount`	`Integer`	read-only	↑ Number of people who marked this reply as helpful Availability: Will be present for replies 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.
`messageTarget`	`String`	read-only	↑ Information that is available when the message was posted via an external system. Since: 3.3
`onBehalfOf`	`OnBehalfOf`	optional	↑ 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
`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
`parent`	`String`	optional	↑ 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).
`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.
`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.
`question`	`Boolean`	optional	↑ Flag indicating that this message is a question
`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.
`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.
`tags`	`String[]`	optional	↑ Tags associated with this object. Availability: Will be present only for object types that support tags
`type`	`String`	required	↑ The object type of this object ("discussion"). 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 replies 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.
`via`	`Via`	optional	↑ Information that is available when the message was posted via an external system. Since: 3.3
`viewCount`	`Integer`	read-only	↑ Number of times this content object has been viewed. Availability: Will be present only for objects that support view counts
`visibleToExternalContributors`	`Boolean`	read-only	↑ Flag indicating that this content object is potentially visible to external contributors.

Methods

↑

answeredQuestion()
POST /messages/1234/answeredQuestion

Retrieves

Object

Description

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.

↑

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(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 /messages/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

↑

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:

Name	Type	Required	Description
fields	String	false	The 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:

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

Retrieves:

Message representing the updated message

↑

getAnsweredQuestions()
GET /messages/1234/answeredQuestion

Retrieves

Person[]

Description

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

Retrieves:

Person[]

↑

getAttachments(options)
GET /attachments/messages/1234

Retrieves

Attachment[]

Description

Return a list of attachments associated to this message.

Options:

Name	Type	Required	Description
fields	String	false	The 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:

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

↑

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 /messages/1234/likes

Retrieves

Person[]

Description

Return a paginated list of people who like this message.

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 /messages/1234/helpful

Retrieves

Person[]

Description

Return a paginated list of people who have marked this message 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 /messages/1234/unhelpful

Retrieves

Person[]

Description

Return a paginated list of people who have marked this message 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 /messages/1234/outcomes

Retrieves

Outcome[]

Description

Return a paginated list of outcomes on the message.

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 /messages/1234/outcomeTypes

Retrieves

OutcomeType[]

Description

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

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

↑

getReplies(options)
GET /messages/1234/messages

Retrieves

Message[]

Description

Return a paginated list of replies to this message.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of replies to return (default is 25)
anchor	String	false	optional 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.
excludeReplies	Boolean	false	Flag indicating whether to exclude replies (and therefore return direct replies only)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first reply to return (default is 0)

Retrieves:

Message[]

↑

like()
POST /messages/1234/likes

Retrieves

--

Description

Availability:

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

↑

markHelpful()
POST /messages/1234/helpful

Retrieves

--

Description

Availability:

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

↑

markUnhelpful()
POST /messages/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

↑

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

↑

unmarkAnsweredQuestion()
DELETE /messages/1234/answeredQuestion

Retrieves

Object

Description

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.

↑

unmarkHelpful()
DELETE /messages/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, and must have been previously marked helpful by the requesting person

↑

unmarkUnhelpful()
DELETE /messages/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(multipartbody,options)
PUT /messages/1234

Retrieves

Message

Description

Update the information about this message.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned
minor	String	false	Flag indicating that this is a minor update and should not trigger events (true) or not (false)

Retrieves:

Message representing the updated message

Resources

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

osapi.jive.corev3.contents.Message

Example:

Example JSON

Properties

Methods

Resources

Properties

Availability:

Availability:

Since: 3.11

Availability:

Since: 3.2

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Since: 3.12

Availability:

Since: 3.3

Since: 3.3

Availability:

Since: 3.3

Availability:

Since: 3.3

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Since: 3.3

Availability:

Methods

Retrieves

Description

Availability:

Retrieves

Description

Availability:

Retrieves

Description

Availability:

Options:

Retrieves:

Retrieves

Description

Availability:

Takes:

Options:

Retrieves:

Retrieves

Description

Takes:

Options:

Retrieves:

Retrieves

Description

Availability:

Retrieves

Description

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Availability: