This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.

osapi.jive.corev3.contents.Idea

Jive Core API entity representing an idea. See also the Vote and Stage classes.

Availability:

Available only when the Ideation plugin is installed in this Jive instance

Example:

Example JSON

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

 {
     "type" : "idea",
     "score" : 0,
     "stage" : "Active",
     "commentCount" : 0,
     "authorshipPolicy" : "open",
     "voteCount" : 1,
     "voted" : true,
     "parent" : "https://example.jiveon.com/api/core/v3/places/1011",
     "visibility" : "place",
     "categories" : [ ],
     "authorship" : "open",
     "content" : {
       "type" : "text/html",
       "text" : "<body><p>This is so cool.</p></body>"
     },
     "subject" : "Another Great Idea",
     "status" : "published",
     "viewCount" : 1,
     "published" : "2012-05-30T19:44:18.751+0000",
     "replyCount" : 0,
     "updated" : "2012-05-30T19:44:19.540+0000",
     "visibleToExternalContributors" : false,
     "tags" : [ ],
     "followerCount" : 1,
     "id" : "1004",
     "author" : {
          //Person JSON appears here
      }
 }

Since: 3.1

Properties

Property	Type	Mode †	Description
`author`	`Person`	read-only	↑ Author of this content object.
`authors`	`Person[]`	optional	↑ List of people who are authors on this content. Authors are allowed to edit the content. This value is used only when authorship is limited.
`authorship`	`String`	optional	↑ The authorship policy for this content. open - anyone with appropriate permissions can edit the content. Default when visibility is place. author - only the author can edit the content. Default when visibility is hidden or all. limited - only those users specified by authors can edit the content. If authors was not specified then users will be used instead when visibility is people. Default when visibility is people.
`authorshipPolicy`	`String`	optional	↑ Authorship policy for this idea (`open`, `single`, or `multiple`.
`categories`	`String[]`	optional	↑ Categories associated with this object. Places define the list of possible categories.
`commentCount`	`Integer`	read-only	↑ Number of comments (included nested comments) associated with this idea.
`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.
`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.
`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.
`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.
`score`	`Integer`	read-only	↑ Current score for this idea.
`stage`	`String`	optional	↑ Current stage for this idea.
`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 for this object ("idea"). 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.
`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 content object. Valid values are: all - anyone with appropriate permissions can see the content. Default when visibility, parent and users were not specified. hidden - only the author can see the content. 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.
`voteCount`	`Integer`	read-only	↑ Number of votes on this idea so far.
`voted`	`Boolean`	read-only	↑ Flag indicating whether or not the requesting user has voted on this idea or not.

Methods

↑

createComment(comment,options)
POST /contents/1234/comments

Retrieves

Comment

Description

Add a comment about this content object.

The minimum JSON object needed to create a comment is:

     {
         "content": {"type": "text/html", "text": "<body><p>This is a new comment</p></body>"},
     }

Takes:

Comment describing the new comment

Options:

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

Retrieves:

Comment representing the recorded comment

↑

destroy()
DELETE /contents/1234

Retrieves

--

Description

Delete this discussion and all messages associated with it.

↑

get(options)
GET /contents/1234

Retrieves

Idea

Description

Return an updated version of this idea.

Options:

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

Retrieves:

Idea representing the updated idea

↑

getComments(options)
GET /contents/1234/comments

Retrieves

Comment[]

Description

Return a paginated list of the comments about this content object.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of comments to be returned (default is 25)
anchor	String	false	optional URI for a comment 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 comments will be returned.
excludeReplies	Boolean	false	Flag indicating that replies to the direct comments about this direct message should be excluded (default is false)
fields	String	false	The names of the fields to be returned
hierarchical	Boolean	false	Flag indicating that comments should be returned in hierarchical order instead of chronological order (default is true)
startIndex	Integer	false	Zero-relative index of the first comment to be returned (default is zero)

Retrieves:

Comment[]

↑

getFollowingIn(options)
GET /contents/1234/followingIn

Retrieves

Stream[]

Description

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

Options:

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

Retrieves:

Stream[]

↑

Requires ModuleWhat's this?

This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.

getVotes()
GET /idea-type-plugin/v1/ideaVotes/1234

Retrieves

Vote[]

Description

Return a list of the current votes on this idea.

Retrieves:

Vote[]

↑

markRead()
POST /contents/1234/read

Retrieves

--

Description

Mark this idea as having been read.

Since: 3.2

↑

markUnread()
DELETE /contents/1234/read

Retrieves

--

Description

Mark this idea 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.

↑

update(multipartbody,options)
PUT /contents/1234

Retrieves

Idea

Description

Update the information about this idea.

Options:

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

Idea representing the updated idea

↑

Requires ModuleWhat's this?

This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.

voteDown()
POST /idea-type-plugin/v1/ideaVotes/1234

Retrieves

Object

Description

Casts an unfavorable vote, against this idea.

↑

Requires ModuleWhat's this?

This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.

voteUp()
POST /idea-type-plugin/v1/ideaVotes/1234

Retrieves

Object

Description

Casts a favorable vote, supporting this idea.

Resources

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