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
`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
`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.
`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.
`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.
`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
`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.
`parentPlace`	`Summary`	read-only	↑ Summary information about the place that contains this object. Availability: Will be present in search results only.
`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.
`status`	`String`	read-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
`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.
`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

↑

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

↑

destroy()
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

↑

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

↑

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

↑

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

↑

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

↑

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:

Availability:

Since: 3.2

Availability:

Availability:

Availability:

Availability:

Since: 3.3

Availability:

Availability:

Availability:

Availability:

Since: 3.2

Availability:

Since: 3.3

Availability:

Methods

Retrieves

Description

Takes:

Options:

Retrieves:

Retrieves

Description

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Since: 3.5

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Availability:

Retrieves

Description

Since: 3.2

Retrieves

Description

Since: 3.2

Retrieves

Description

Retrieves:

Retrieves

Description

Availability:

Retrieves

Description

Options:

Retrieves:

Resources