Favorite

A Favorite is an external URL saved as a bookmark in Jive. The favoriteObject field contains an ExternalURL type with its own JSON structure.

Examples:

Example JSON

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

{
  "type" : "favorite",
  "status" : "published",
  "subject" : "Scientists find anti-Alzheimer's gene mutation - Yahoo! News",
  "content" : {
    "type" : "text/html",
    "text" : "Important news"
  },
  "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"
  },
  "favoriteObject" : {
    "type" : "url",
    "url" : "http://news.yahoo.com/scientists-anti-alzheimers-gene-mutation-151901443.html",
    "published" : "2012-07-12T19:13:26.977+0000",
    "updated" : "2012-07-12T19:13:52.230+0000",
    "id" : "1001",
    "resources" : {
      "self" : {
        "ref" : "https://example.jiveon.com/api/core/v3/urls/1001",
        "allowed" : [ "GET" ]
      },
      "html" : {
        "ref" : "https://example.jiveon.com/bookmarks/1001",
        "allowed" : [ "GET" ]
      }
    }
  },
  "visibleToExternalContributors" : false,
  "private" : false,
  "followerCount" : 0,
  "published" : "2012-07-12T19:13:51.887+0000",
  "updated" : "2012-07-12T19:13:51.887+0000",
  "tags" : [ "health" ],
  "id" : "1001",
  "resources" : {
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/contents/1245",
      "allowed" : [ "DELETE", "GET", "PUT" ]
    },
    "html" : {
      "ref" : "https://example.jiveon.com/bookmarks/1001",
      "allowed" : [ "GET" ]
    }
  }
}

Simple Favorite Creation

POST to createContent(entity, published, updated, fields) /contents} creates a new favorite. The minimum set of fields you must include are:

 {
  "content":
      {
      "type": "text/html",
      "text": "<body><p>Some interesting text</p></body>"
      },
  "favoriteObject" : {
    "type" : "url",
    "url" : "http://news.yahoo.com/scientists-anti-alzheimers-gene-mutation-151901443.html"
  },
  "subject" : "Scientists find anti-Alzheimer's gene mutation - Yahoo! News",
  "type" : "favorite"
 }

Retrieve Favorite

GET to /contents/{contentID} to return a given favorite. The service URL can be found in the self resource under resources.

Update Favorite

After you have retrieved a favorite and made the desired changes, PUT to /contents/{contentID} passing the updated information in the request body. The service URL can be found in the self resource under resources.

Delete Favorite

DELETE to /contents/{contentID} to delete the specified discussion. The service URL can be found in the self resource under resources.

Fields

Field	Type	Mode †	Description
`abuseCount`	`Integer`	read-only	Number of abuse reports associated with this content object.
`author`	`Person`	read-only	Author of this content object.
`content`	`ContentBody`	required	Content of this content object.
`contentID`	`String`	read-only	Internal Jive ID associated with the content.
`contentImages`	`Image[]`	read-only	A list of Image objects providing metadata about images embedded within this content.
`contentVideos`	`ContentVideo[]`	read-only	A list of ContentVideo objects providing metadata about videos embedded within this content.
`favoriteCount`	`Integer`	read-only	Number of people who have bookmarked this object. Availability: Will be present only for object types that support being bookmarked. Since: 3.11
`favoriteObject`	`Object`	required	The favorite object that was saved. When creating a favorite, the fields type and url are required.
`followerCount`	`Integer`	read-only	Number of people following this object. Availability: Will be present only for object types that support being followed.
`highlightBody`	`String`	read-only	Highlight snippet of a search match in the body or description. Availability: Will be present in search results only.
`highlightSubject`	`String`	read-only	Highlight snippet of a search match in the subject or name. Availability: Will be present in search results only.
`highlightTags`	`String`	read-only	Highlight snippet of a search match in tags. Availability: Will be present in search results only.
`iconCss`	`String`	read-only	CSS Style to locate icon within sprite.
`id`	`String`	read-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.
`lastActivityDate`	`ISO 8601 Date`	read-only	Date and time when this had its last activity. Since: 3.12
`likeCount`	`Integer`	read-only	Number of people who have liked this object. Availability: Will be present only for object types that support being liked.
`parentContent`	`Summary`	read-only	Summary information about the content object that is the parent of this object. Availability: Will be present in search results only.
`parentContentVisible`	`Boolean`	read-only	Flag indicating that the content parent's contents are visible to the viewer.
`parentPlace`	`Summary`	read-only	Summary information about the place that contains this object. Availability: Will be present in search results only.
`parentVisible`	`Boolean`	read-only	Flag indicating that the content parent is visible to the viewer.
`private`	`Boolean`	optional	Flag indicating that this favorite is private, and thus not shared.
`published`	`ISO 8601 Date`	read-only	Date and time when this content object was originally created.
`replyCount`	`Integer`	read-only	Number of replies to this object. Availability: Will be present only for object types that support replies.
`resources`	`Object`	read-only	Resource links (and related permissions for the requesting person) relevant to this object.
`searchRankings`	`Object`	read-only	A map of search result scores including social signals. Availability: Will be present in search results only.
`status`	`String`	read-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
`subject`	`String`	required	Subject of this content object.
`tags`	`String[]`	optional	Tags associated with this object. Availability: Will be present only for object types that support tags
`type`	`String`	required	The object type of this object ("favorite"). This field is required when creating new content.
`updated`	`ISO 8601 Date`	read-only	Date and time this content object was most recently updated.
`viewCount`	`Integer`	read-only	Number of times this content object has been viewed. Availability: Will be present only for objects that support view counts
`visibleToExternalContributors`	`Boolean`	read-only	Flag indicating that this content object is potentially visible to external contributors.
`followed`	`Boolean`	read-only	Whether the current user is following this object. Availability: Will be present only for object types that support being followed.
`promotedResult`	`Boolean`	read-only	A boolean determining whether this search result is a promoted result Availability: Will be present in search results only.

Resources

Resource	Method	Description
`childOutcomeTypes`	`GET`	Return a paginated list of possible outcomes types on the content object's children. Retrieves: OutcomeType[]
`extprops`	`DELETE`	Deletes all extended properties for content. Availability: Content should be editable to caller.
`extprops`	`GET`	Returns extended properties for content. Availability: Content should be visible to caller. Retrieves: ExtProps[]
`extprops`	`POST`	Creates extended properties for content. { "any prop name": "any val", "any prop2 name": "any val" } Availability: Content should be editable to caller. Retrieves: ExtProps[]
`html`	`GET`	Return the HTML representation of this content object.
`outcomes`	`POST`	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: Outcome the outcome to be created. Retrieves: Outcome Representation of the newly created outcome
`outcomes`	`GET`	Return a paginated list of outcomes on the content. Retrieves: Outcome[]
`outcomeTypes`	`GET`	Return a paginated list of possible outcomes types on the content. Retrieves: OutcomeType[]
`self`	`GET`	Return an updated version of this content object. Retrieves: Content describing this content object
`self`	`PUT`	Update the information about this content object. Retrieves: Content representing the updated content object
`self`	`DELETE`	Delete this content object and any related comments and other related information.

Favorite

Examples:

Example JSON

Simple Favorite Creation

Retrieve Favorite

Update Favorite

Delete Favorite

Fields

Availability:

Since: 3.11

Availability:

Availability:

Availability:

Availability:

Since: 3.12

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Resources

Retrieves:

Availability:

Availability:

Retrieves:

Availability:

Retrieves:

Availability:

Takes:

Retrieves:

Retrieves:

Retrieves:

Retrieves:

Retrieves: