Share

A Share is a way to share content or places with other users. If a content object is shared, both content and place fields will be present, describing the content object that is shared and the place that contains it. If a place is shared, only place will be present. An example JSON representation looks like this:

Example:

To create a share, POST to /shares. The minimum JSON required to create a Share:

 {
     "content" : {
         "type" : "text/html",
         "text" : "Hey, you should join in on this discussion!"
     },
     "participants" : [
         "http://jive.somecompany.com/api/core/v3/people/2345"
     ],
     "shared" : "http://jive.somecompany.com/api/core/v3/contents/12345"
 }

Fields

FieldTypeMode Description
authorPersonread-only

Author of this content object.

contentContentBodyrequired

Content of this content object.

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.

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.

likeCountIntegerread-only

Number of people who have liked this object.

Availability:

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

parentStringrequired

URI of the parent place (or person, for personal content) of this content object.

parentContentSummaryread-only

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

Availability:

Will be present in search results only.

parentPlaceSummaryread-only

Summary information about the place that contains this object.

Availability:

Will be present in search results only.

participantsPerson[]required

The people with which a content object or place has been shared.

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.

sharedContentread-only

The content object that was shared, if any. If a place was shared, this field will not be present.

sharedPlacePlaceread-only

The place containing the content object that was shared, if a content object was shared. If a place was shared, this will be the place.

statusStringread-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
subjectStringread-only

Subject of this content object.

tagsString[]optional

Tags associated with this object.

Availability:

Will be present only for object types that support tags

typeStringread-only

The object type of this object ("share").

updatedISO 8601 Dateread-only

Date and time this content object was most recently updated.

viewCountIntegerread-only

Number of times this content object has been viewed.

Availability:

Will be present only for objects that support view counts

visibleToExternalContributorsBooleanread-only

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

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

Resources

ResourceMethodDescription
commentsPOST

Add a comment about this share.

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

    Return the HTML representation of this share.

    readPOST

    Mark this share as having been read.

    Since: 3.2
    readDELETE

    Mark this share as unread.

    Since: 3.2
    selfGET

    Return an updated version of this share.

    Retrieves:
  • Share describing this content object
  • selfPUT

    Update the information about this content object.

    Retrieves:
  • Content representing the updated content object
  • selfDELETE

    Delete this content object and any related comments and other related information.