Slide

A Slide must be related to a particular place (Carousel). Slides show up in a widget that the place lives in.

Example:
Example JSON

JSON including important fields and a Slide's resources. See the tables below for a list of all fields and resources.

{
  "type" : "slide",
  "status" : "published",
  "subject" : "Can fracking pollute water? Study tries to answer - Yahoo! News",
  "parent" : "https://example.jiveon.com/api/core/v3/places/1001",
  "content" : {
    "type" : "text/html",
    "text" : "<body><p>This is an important slide</p></body>"
  },
  "contentImages" : [ {
   "id" : "1055",
   "contentType" : "image/jpeg",
   "name" : "pic.jpeg",
   "ref" : "http://example.jiveon.com/api/core/v3/attachments/file/1055/data",
   "size" : 5953,
   "width" : 251,
   "height" : 201,
   "type" : "image"
  } ],
  "author" : {
    "name" : {
      "formatted" : "Administrator"
    },
    "type" : "person",
    "displayName" : "Administrator",
    "id" : "1"
  },
  "targetLink" : "http://news.yahoo.com/fracking-pollute-water-study-tries-answer-174343650.html",
  "image" : "https://example.jiveon.com/servlet/JiveServlet/downloadImage/22-1001-1028/campbell_med_good.jpg",
  "publishDate" : "2012-07-11T23:06:35.700+0000",
  "published" : "2012-07-11T23:06:35.696+0000",
  "updated" : "2012-07-11T23:06:35.714+0000",
  "resources" : {
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/slides/1001",
      "allowed" : [ "PUT", "DELETE", "GET" ]
    },
    "html" : {
      "ref" : "https://example.jiveon.com/",
      "allowed" : [ "GET" ]
    }
  }
 }

Fields

FieldTypeMode †Description
abuseCountIntegerread-only

Number of abuse reports associated with this content object.

authorPersonread-only

Author of this content object.

contentContentBodyrequired

Content of this content object.

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.

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.

imageStringrequired

The display URL for the image associated with this Slide.

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.

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.

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.

publishDateISO 8601 Dateoptional

The date and time after which the slide should start being displayed. If no publish date is specified during creation then it will default to now.

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.

searchRankingsObjectread-only

A map of search result scores including social signals.

Availability:

Will be present in search results only.

sortKeyIntegeroptional

An integer. When several published slides are displayed, they'll be ordered by descending sortKey.

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.

targetLinkStringrequired

The URI that the slide should link to when displayed.

typeStringrequired

The object type for this object ("slide"). This field is required when creating new content.

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.

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

    Return the HTML representation of this content object.

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

    Retrieves:
  • Slide describing this slide
    • selfPUT

    Update the information about this slides.

    Retrieves:
  • Slide representing the updated slide
    • selfDELETE

    Delete this slide.