Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.

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 including important fields and a Document's resources. See the tables below for a list of all fields and resources.

 {
     "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,
     "resources" : {
       "votes" : {
         "ref" : "https://example.jiveon.com/api/core/ext/idea-type-plugin/v1/votes/1200",
         "allowed" : [ "GET" ]
       },
       "self" : {
         "ref" : "https://example.jiveon.com/api/core/v3/contents/1200",
         "allowed" : [ "GET", "PUT", "DELETE" ]
       },
       "html" : {
         "ref" : "https://example.jiveon.com/ideas/1004",
         "allowed" : [ "GET" ]
       },
       "followingIn" : {
         "ref" : "https://example.jiveon.com/api/core/v3/contents/1200/followingIn",
         "allowed" : [ "GET" ]
       },
       "comments" : {
         "ref" : "https://example.jiveon.com/api/core/v3/contents/1200/comments",
         "allowed" : [ "GET", "POST" ]
       }
     },
     "id" : "1004",
     "author" : {
          //Person JSON appears here
     }
   }
Since: 3.1

Fields

FieldTypeMode †Description
abuseCountIntegerread-only

Number of abuse reports associated with this content object.

authorPersonread-only

Author of this content object.

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

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

Authorship policy for this idea (open, single, or multiple.

categoriesString[]optional

Categories associated with this object. Places define the list of possible categories.

commentCountIntegerread-only

Number of comments (included nested comments) associated with this idea.

contentContentBodyrequired

Content of this content object.

contentIDStringread-only

Internal Jive ID associated with the content.

contentImagesImage[]read-only

A list of Image objects providing metadata about images embedded within this content.

contentVideosContentVideo[]read-only

A list of ContentVideo objects providing metadata about videos embedded within this content.

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

favoriteCountIntegerread-only

Number of people who have bookmarked this object.

Availability:

Will be present only for object types that support being bookmarked.

Since: 3.11
followerCountIntegerread-only

Number of people following this object.

Availability:

Will be present only for object types that support being followed.

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.

lastActivityDateISO 8601 Dateread-only

Date and time when this had its last activity.

Since: 3.12
likeCountIntegerread-only

Number of people who have liked this object.

Availability:

Will be present only for object types that support being liked.

outcomeTypesOutcomeType[]optional

A list of valid outcome types that can be set on this piece of content

parentStringoptional

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

parentContentSummaryread-only

Summary information about the content object that is the parent of this object.

Availability:

Will be present in search results only.

parentContentVisibleBooleanread-only

Flag indicating that the content parent's contents are visible to the viewer.

parentPlaceSummaryread-only

Summary information about the place that contains this object.

Availability:

Will be present in search results only.

parentVisibleBooleanread-only

Flag indicating that the content parent is visible to the viewer.

promoteBooleanread-only

Flag indicating that requesting user vote for (true) or against (false) this idea.

Availability:

Will be present only when requesting user casted a vote.

Since: 3.11
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.

scoreIntegerread-only

Current score for this idea.

searchRankingsObjectread-only

A map of search result scores including social signals.

Availability:

Will be present in search results only.

stageStringoptional

Current stage for this idea.

statusStringread-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
subjectStringrequired

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 for this object ("idea"). This field is required when creating new content.

updatedISO 8601 Dateread-only

Date and time this content object was most recently updated.

usersPerson[]optionalThe 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.
viewCountIntegerread-only

Number of times this content object has been viewed.

Availability:

Will be present only for objects that support view counts

visibilityStringoptional

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

Flag indicating that this content object is potentially visible to external contributors.

voteCountIntegerread-only

Number of votes on this idea so far.

votedBooleanread-only

Flag indicating whether or not the requesting user has voted on this idea or not.

followedBooleanread-only

Whether the current user is following this object.

Availability:

Will be present only for object types that support being followed.

promotedResultBooleanread-only

A boolean determining whether this search result is a promoted result

Availability:

Will be present in search results only.

†
→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Resources

ResourceMethodDescription
childOutcomeTypesGET

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

Retrieves:
  • OutcomeType[]
    • commentsPOST

    Add a comment about this content object.

    The minimum JSON object needed to create a comment is:

         {
         "content": {"type": "text/html", "text": "
    This is a new comment
    "},
     }
    Takes:
    Retrieves:
  • Comment representing the recorded comment
    • commentsGET

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

    Retrieves:
  • Comment[]
    • extpropsDELETE

    Deletes all extended properties for content.

    Availability:

    Content should be editable to caller.

    extpropsGET

    Returns extended properties for content.

    Availability:

    Content should be visible to caller.

    Retrieves:
  • ExtProps[]
    • extpropsPOST

    Creates extended properties for content.

     {
  "any prop name": "any val",
  "any prop2 name": "any val"
 }
    Availability:

    Content should be editable to caller.

    Retrieves:
  • ExtProps[]
    • followingInGET

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

    Retrieves:
  • Stream[]
    • htmlGET

    Return the HTML representation of this idea.

    readPOST

    Mark this idea as having been read.

    Since: 3.2
    readDELETE

    Mark this idea as having not been read.

    Since: 3.2
    outcomesPOST

    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 content, and must not have the same outcome type on this comment already

    Takes:
    Retrieves:
  • Outcome Representation of the newly created outcome
    • outcomesGET

    Return a paginated list of outcomes on the content.

    Retrieves:
  • Outcome[]
    • outcomeTypesGET

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

    Retrieves:
  • OutcomeType[]
    • selfGET

    Return an updated version of this idea.

    Retrieves:
  • Idea representing the updated idea
    • selfPUT

    Update the information about this idea.

    Retrieves:
  • Idea representing the updated idea
    • selfDELETE

    Delete this discussion and all messages associated with it.

    votesPOST
    Requires ModuleWhat's this?
    This capability is implemented by a Jive Module.
    This feature may not be available on all Jive instances.

    Casts an unfavorable vote, against this idea.

    votesGET
    Requires ModuleWhat's this?
    This capability is implemented by a Jive Module.
    This feature may not be available on all Jive instances.

    Return a list of the current votes on this idea.

    Retrieves:
  • Vote[]
    • votesPOST
    Requires ModuleWhat's this?
    This capability is implemented by a Jive Module.
    This feature may not be available on all Jive instances.

    Casts a favorable vote, supporting this idea.