osapi.jive.corev3.contents.ExternalURL

External URL saved as part of a Favorite. See that object for an example of creating a new bookmark. An example JSON representation looks like this:

{
  "type" : "url",
  "subject" : "Scientists find anti-Alzheimer's gene mutation - Yahoo! News",
  "content" : {
    "type" : "text/html",
    "text" : "Important news"
  },
  "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",
  "tags" : [ "health" ],
  "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" ]
    }
  }
}

Properties

PropertyTypeMode †Description
authorPersonread-only↑

First author of this external URL. Only the first person that bookmarked this URL is returned.

contentObjectread-only↑

The content of this entity.

followerCountIntegerread-only↑

Number of people following this object.

Availability:

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

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.

likeCountIntegerread-only↑

Number of people who have liked this object.

Availability:

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

publishedISO 8601 Dateread-only↑

The date and time this external URL was originally created.

resourcesObjectread-only↑

Resource links (and related permissions for the requesting person) relevant to this object.

subjectStringread-only↑

The subject of this bookmark.

tagsString[]optional↑

Tags associated with this object.

Availability:

Will be present only for object types that support tags

typeStringread-only↑

The object type of this object ("url")

updatedISO 8601 Dateread-only↑

The date and time at which this external URL was last updated.

urlStringread-only↑

The external URL that was bookmarked.

†
→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Methods

↑
get(options)
GET /urls/1234

Retrieves

ExternalURL

Description

Return an updated version of this external URL.

Options:
NameTypeRequiredDescription
fieldsStringfalseThe names of the fields to be returned
Retrieves:
  • Announcement describing this external URL
    • ↑
    toURI()

    Retrieves

    String

    Description

    Retrieves:
  • A URI representing this entity, or undefined if no such URI exists.