ExternalStreamActivity

A tile stream entry from an external activity integration.

Example:
Example JSON

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

{
    "type" : "tilestreamentry",
    "status" : "published",
    "subject" : "My new external activity",
    "content" : {
      "type" : "text/html",
      "text" : "<span>My new external activity</span>"
    },
    "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"
    },
    "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" : [ ],
    "id" : "1012",
    "resources" : {
      "likes" : {
        "ref" : "https://example.jiveon.com/api/core/v3/contents/1251/likes",
        "allowed" : [ "GET" ]
      },
      "self" : {
        "ref" : "https://example.jiveon.com/api/core/v3/contents/1251",
        "allowed" : [ "GET", "DELETE", "PUT" ]
      },
      "html" : {
        "ref" : "https://example.jiveon.com/external/1012",
        "allowed" : [ "GET" ]
      },
      "followingIn" : {
        "ref" : "https://example.jiveon.com/api/core/v3/contents/1251/followingIn",
        "allowed" : [ "GET" ]
      },
      "comments" : {
        "ref" : "https://example.jiveon.com/api/core/v3/contents/1251/comments",
        "allowed" : [ "GET", "POST" ]
      }
    }
 }

Fields

FieldTypeMode †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.

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.

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

    Return metadata about the images attached to this status update.

    Retrieves:
  • Image[]
    • 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 update (if any).

    Retrieves:
  • Stream[]
    • htmlGET

    Return the HTML representation of this content object.

    likesPOST

    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

    likesGET

    Return a paginated list of people who like this update.

    Retrieves:
  • Person[]
    • readPOST

    Mark this update as having been read.

    Since: 3.2
    readDELETE

    Mark this update 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 content object.

    Retrieves:
  • Content 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.

    likesDELETE

    Delete the like of this update by the requesting person.

    Availability:

    Must be authenticated, and must have liked this update already