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" }, "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 /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 |
|---|---|---|---|
| Person | read-only | Author of this content object. |
content | ContentBody | required | Content of this content object. |
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. |
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. |
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. |
parentPlace | Summary | read-only | Summary information about the place that contains this object. Availability:Will be present in search results only. |
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. |
status | String | read-only | Published status of this content object.
|
subject | String | required | Subject of this content object. |
| 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. |
Resources
| Resource | Method | Description |
|---|---|---|
html | GET | Return the HTML representation of this content object. |
self | GET | Return an updated version of this content object. Retrieves: |
self | PUT | Update the information about this content object. Retrieves: |
self | DELETE | Delete this content object and any related comments and other related information. |