osapi.jive.corev3.contents.ExternalStreamActivity

A tile stream entry from an external activity integration.

Example:
Example JSON

JSON with the most important data for a Tile Stream Entry. See the table below for a list of all fields.

{
    "type" : "update",
    "status" : "published",
    "subject" : "My new external activity",
    "content" : {
      "type" : "text/html",
      "text" : "<span>My new external activity</span>"
    },
    "author" : {
      "name" : {
        "formatted" : "Administrator"
      },
      "type" : "person",
      "displayName" : "Administrator",
      "id" : "1"
    },
    "parentPlace" : {
      "name" : "Integration Group",
      "id" : "1",
      "type" : "group",
      "uri" : "https://example.jiveon.com/api/core/v3/places/1",
      "html" : "https://example.jiveon.com/groups/group1341876961250"
    },
    "visibleToExternalContributors" : false,
    "highlightBody" : "My new <em class=\"jive-hilite\">external activity</em>",
    "highlightSubject" : "My new <em class=\"jive-hilite\">external activity</em>",
    "viewCount" : 0,
    "replyCount" : 0,
    "followerCount" : 1,
    "likeCount" : 0,
    "published" : "2012-07-13T23:26:49.669+0000",
    "updated" : "2012-07-13T23:26:49.669+0000",
    "tags" : [ ]
 }

Properties

PropertyTypeMode Description
abuseCountIntegerread-only

Number of abuse reports associated with this content object.

actionObjectrequired
actorObjectread-only
attachmentsAttachment[]optional

List of attachments to this external object.

authorPersonread-only

Author of this content object.

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.

externalIDStringread-only
externalStreamIDIntegerread-only
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.

isFollowedBooleanread-only

Whether the current user is following this object.

Availability:

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

isPromotedResultBooleanread-only

A boolean determining whether this search result is a promoted result

Availability:

Will be present in search results only.

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

objectObjectread-only
outcomeCountsObjectread-only

Map of structured outcome type names that have been assigned to this content object, and a count of how many times they appear. For top level content objects like Discussion, Document, File, and Post, outcomes assigned to child comments and messages will also be included.

Availability:

Only available for content object types that support structured outcomes

Since: 3.3
outcomeTypeNamesString[]read-only

List of structured outcome type names that have been assigned to this content object. For top level content objects like Discussion, File, and Document, outcomes assigned to child comments and messages will also be included.

Availability:

Only available for content object types that support structured outcomes

Since: 3.3
outcomeTypesOutcomeType[]optional

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

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.

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

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

typeCodeIntegerread-only
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
→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

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:
Options:
NameTypeRequiredDescription
fieldsStringfalseThe names of the fields to be returned
Retrieves:
  • Comment representing the recorded comment
  • createExtProps(uriinfo,options)
    POST /contents/1234/extprops

    Retrieves

    ExtProps[]

    Description

    Creates extended properties for content.

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

    Content should be editable to caller.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • ExtProps[]
  • createOutcome(outcome,options)
    POST /contents/1234/outcomes

    Retrieves

    Outcome

    Description

    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:
    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned.
    Retrieves:
  • Outcome Representation of the newly created outcome
  • deleteExtProps()
    DELETE /contents/1234/extprops

    Retrieves

    --

    Description

    Deletes all extended properties for content.

    Availability:

    Content should be editable to caller.

    destroy(options)
    DELETE /contents/1234

    Retrieves

    --

    Description

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

    get(options)
    GET /contents/1234

    Description

    Return an updated version of this content object.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Content describing this content object
  • getChildOutcomeTypes(options)
    GET /contents/1234/childOutcomeTypes

    Retrieves

    OutcomeType[]

    Description

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

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of outcome types to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first person to return (default is 0)
    Retrieves:
  • OutcomeType[]
  • getComments(options)
    GET /contents/1234/comments

    Retrieves

    Comment[]

    Description

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

    Options:
    NameTypeRequiredDescription
    outcomeTypeStringfalseThe type name of outcomes to filter by.
    countIntegerfalseThe maximum number of comments to be returned (default is 25)
    anchorStringfalseoptional 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.
    excludeRepliesBooleanfalseFlag indicating that replies to the direct comments about this direct message should be excluded (default is false)
    fieldsStringfalseThe names of the fields to be returned
    hierarchicalBooleanfalseFlag indicating that comments should be returned in hierarchical order instead of chronological order (default is true)
    startIndexIntegerfalseZero-relative index of the first comment to be returned (default is zero)
    Retrieves:
  • Comment[]
  • getContentImages(options)
    GET /images/contents/1234

    Retrieves

    Image[]

    Description

    Return metadata about the images attached to this status update.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Image[]
  • getExtProps(options)
    GET /contents/1234/extprops

    Retrieves

    ExtProps

    Description

    Returns extended properties for content.

    Availability:

    Content should be visible to caller.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • ExtProps[]
  • getFollowingIn(options)
    GET /contents/1234/followingIn

    Retrieves

    Stream[]

    Description

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

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe 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 update.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of people to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first person to return (default is 0)
    Retrieves:
  • Person[]
  • getOutcomes(options)
    GET /contents/1234/outcomes

    Retrieves

    Outcome[]

    Description

    Return a paginated list of outcomes on the content.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of outcomes to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first person to return (default is 0)
    Retrieves:
  • Outcome[]
  • getOutcomeTypes(options)
    GET /contents/1234/outcomeTypes

    Retrieves

    OutcomeType[]

    Description

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

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of outcome types to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first person to return (default is 0)
    Retrieves:
  • OutcomeType[]
  • like()
    POST /contents/1234/likes

    Retrieves

    --

    Description

    Register that the requesting person likes this update.

    Availability:

    Must be authenticated, must not be your own update, and must not have liked this update already

    markRead()
    POST /contents/1234/read

    Retrieves

    --

    Description

    Mark this update as having been read.

    Since: 3.2
    markUnread()
    DELETE /contents/1234/read

    Retrieves

    --

    Description

    Mark this update 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 update by the requesting person.

    Availability:

    Must be authenticated, and must have liked this update already

    update(multipartbody,options)
    PUT /contents/1234

    Retrieves

    Content

    Description

    Update the information about this content object.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Content representing the updated content object
  • Resources

    ResourceMethodReturnsDescription
    htmlGETObject

    Return the HTML representation of this content object.