osapi.jive.corev3.contents.Discussion

A Discussion is the beginning of a conversation. A Discussion can be explicitly marked as a question by setting the question field to true. Messages are replies to the discussion, and replies to the replies are also possible.

Example:

Example JSON

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

 {
   "type" : "discussion",
   "status" : "published",
   "subject" : "New Discussion",
   "content" : {
     "type" : "text/html",
     "text" : "<p>Text of the discussion</p>"
   },
   "author" : {
     "name" : {
       "formatted" : "Administrator"
     },
     "type" : "person",
     "displayName" : "Administrator",
     "id" : "1"
   },
   "question" : false,
   "visibility" : "all",
   "visibleToExternalContributors" : false,
   "viewCount" : 0,
   "replyCount" : 0,
   "followerCount" : 0,
   "likeCount" : 0,
   "published" : "2012-07-09T18:50:30.066+0000",
   "updated" : "2012-07-09T18:50:30.066+0000",
   "tags" : ["important" ]
 }

Properties

Property	Type	Mode †	Description
`abuseCount`	`Integer`	read-only	↑ Number of abuse reports associated with this content object.
`answer`	`String`	read-only	↑ URI of the correct answer (if any) to this discussion, if it is a question. Availability: Only present on a discussion marked as a question, with a message marked as the correct answer Since: 3.2
`archived`	`Boolean`	read-only	↑ Flag indicating that this discussion is archived.
`attachments`	`Attachment[]`	optional	↑ List of attachments to this discussion (if any).
`author`	`Person`	read-only	↑ Author of this content object.
`categories`	`String[]`	optional	↑ Categories associated with this object. Places define the list of possible categories.
`content`	`ContentBody`	required	↑ Content of this content object.
`contentID`	`String`	read-only	↑ Internal Jive ID associated with the content.
`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.
`extendedAuthors`	`Person[]`	optional	↑ List of people who have been granted authorship on this content, who would normally not have access to it. Extended authors are allowed to edit the content. This value is used only when authorship is limited.
`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.
`helpful`	`String[]`	read-only	↑ URIs of messages that have been marked "helpful", if this discussion is a question. Availability: Only present on a discussion marked as a question, with at least one message marked as a helpful answer Since: 3.2
`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.
`isFollowed`	`Boolean`	read-only	↑ Whether the current user is following this object. Availability: Will be present only for object types that support being followed.
`isPromotedResult`	`Boolean`	read-only	↑ A boolean determining whether this search result is a promoted result Availability: Will be present in search results 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.
`onBehalfOf`	`OnBehalfOf`	optional	↑ Information that is available when the discussion 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 place of this content object. When visibility is place then the URI points to a place (and is required on create). Otherwise, this field is not part of the returned JSON (and must not be included on create).
`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`	read-only	↑ Flag indicating that this discussion is a question.
`replyCount`	`Integer`	read-only	↑ Number of replies to this object. Availability: Will be present only for object types that support replies.
`resolved`	`String`	optional	↑ If this discussion is a question, this field will contain the resolution state ("open", "resolved", "assumed_resolved"). If the current state is "open", it may be changed to "assumed_resolved" by the author or a moderator. Availability: Only present on a discussion marked as a question Since: 3.2
`resources`	`Object`	read-only	↑ Resource links (and related permissions for the requesting person) relevant to this object.
`restrictReplies`	`Boolean`	read-only	↑ Flag indicating that old messages replying to this discussion will be visible, but new messages (or changes to the structured outcome settings on messages) will not be allowed. Since: 3.4
`sameQuestionCount`	`Integer`	read-only	↑ Number of people who found that they have the same question. Availability: Will be present only for threads that are not yet marked correct.
`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`	required	↑ 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	↑
`updated`	`ISO 8601 Date`	read-only	↑ Date and time this content object was most recently updated.
`users`	`Person[]`	optional	↑ The list of users that can see the content. On create or update, provide a list of Person URIs or Person entities. On get, returns a list of Person entities. This value is used only when visibility is people.
`via`	`Via`	optional	↑ Information that is available when the discussion 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
`visibility`	`String`	optional	↑ The visibility policy for this discussion. Valid values are: all - anyone with appropriate permissions can see the content. Default when visibility, parent and users were not specified. people - only those users specified by users can see the content. Default when visibility and parent were not specified but users was specified. place - place permissions specify which users can see the content. Default when visibility was not specified but parent was specified.
`visibleToExternalContributors`	`Boolean`	read-only	↑ Flag indicating that this content object is potentially visible to external contributors.

Methods

↑

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 /contents/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 content, 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/contents/1234

Retrieves

Message

Description

Create a new reply to this discussion, 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(options)
DELETE /contents/1234

Retrieves

--

Description

Delete this discussion and all messages associated with it.

↑

get(options)
GET /contents/1234

Retrieves

Discussion

Description

Return an updated version of this discussion.

Options:

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

Retrieves:

Discussion representing the updated discussion

↑

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

↑

getFollowers(options)
GET /contents/1234/followers

Retrieves

Person[]

Description

Return a paginated list of the people following this content.

Options:

Name	Type	Required	Description
count	Integer	false	Number of followers to be returned (default is 25)
fields	String	false	Names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first follower to be returned

Retrieves:

Person[]

Since: 3.5

↑

getFollowingIn(options)
GET /contents/1234/followingIn

Retrieves

Stream[]

Description

Return the list of custom streams in which the requesting person is following this discussion (if any).

Options:

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

Retrieves:

Stream[]

↑

getLikes(options)
GET /contents/1234/likes

Retrieves

Person[]

Description

Return a paginated list of people who like this discussion.

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 /contents/1234/outcomes

Retrieves

Outcome[]

Description

Return a paginated list of outcomes on the content.

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

Retrieves

OutcomeType[]

Description

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

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/contents/1234

Retrieves

Message[]

Description

Return a paginated list of replies to this discussion.

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 that direct replies only are requested (true), or the entire tree of replies are requested (false)
hierarchical	Boolean	false	Flag indicating that replies should be returned in hierarchical order instead of chronological order. Since v3.1
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[]

↑

getSameQuestions()
GET /contents/1234/sameQuestion

Retrieves

Person[]

Description

Return a paginated list of people who also have the same question.

Retrieves:

Person[]

↑

like()
POST /contents/1234/likes

Retrieves

--

Description

Availability:

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

↑

markRead()
POST /contents/1234/read

Retrieves

--

Description

Mark this discussion as having been read.

Since: 3.2

↑

markSameQuestion()
POST /contents/1234/sameQuestion

Retrieves

Object

Description

Availability:

Must be authenticated, must not be your own discussion, and must not have not indicated that you have the same question.

↑

markUnread()
DELETE /contents/1234/read

Retrieves

--

Description

Mark this discussion as having not been read.

Since: 3.2

↑

toURI()

Retrieves

String

Description

Retrieves:

A URI representing this entity, or undefined if no such URI exists.

↑

unlike()
DELETE /contents/1234/likes

Retrieves

--

Description

Delete the like of this discussion by the requesting person.

Availability:

Must be authenticated, and must have liked this discussion already

↑

unmarkSameQuestion()
DELETE /contents/1234/sameQuestion

Retrieves

Object

Description

Availability:

Must be authenticated, must not be your own discussion, and must not have not indicated that you have the same question.

↑

update(multipartbody,options)
PUT /contents/1234

Retrieves

Discussion

Description

Update the information about this discussion.

Options:

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

Retrieves:

Discussion representing the updated discussion

Resources

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

osapi.jive.corev3.contents.Discussion

Example:

Example JSON

Properties

Methods

Resources

Properties

Availability:

Since: 3.2

Availability:

Since: 3.11

Availability:

Availability:

Since: 3.2

Availability:

Availability:

Availability:

Availability:

Availability:

Since: 3.12

Availability:

Since: 3.3

Availability:

Since: 3.3

Availability:

Since: 3.3

Availability:

Availability:

Availability:

Availability:

Since: 3.2

Since: 3.4

Availability:

Availability:

Availability:

Since: 3.3

Availability:

Methods

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

Options:

Retrieves:

Retrieves

Description

Availability:

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Since: 3.5

Retrieves

Description

Options: