osapi.jive.corev3.places.Blog

A blog is a place that contains posts. A Blog belongs to a place or to a person. An example JSON representation looks like this:

Examples:
Example JSON

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

 {
   "type" : "blog",
   "name" : "Fred Flintstone's Blog",
   "parent" : "https://example.jiveon.com/api/core/v3/people/2001",
   "displayName" : "fred",
   "description" : "A blog by Fred",
   "status" : "Active",
   "contentTypes" : [ "post" ],
   "viewCount" : 6,
   "published" : "2011-09-23T22:46:58.669+0000",
   "updated" : "2011-09-23T22:46:58.669+0000",
   "visibleToExternalContributors" : false,
   "followerCount" : 0
 }
Create Personal Blog

Read Create Personal Blog to learn how to create a new personal blog.

Create Blog for a Place

Read Create Place Blog to learn how to create a new blog for a place.

Properties

PropertyTypeMode †Description
contentTypesString[]read-only↑

Blogs can only have Posts. Other content types cannot be added.

descriptionStringoptional↑

Human readable description of this place.

displayNameStringrequired↑

Display name of this place. It must be unique among places of the same type in this Jive instance. This value is used to compose the URL for the HTML presentation of this place in the Jive user interface, so its syntax must conform to the following rules:

  • TODO
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.

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.

nameStringrequired↑

Formal name of this place. It must be unique among places of the same type in this Jive instance.

parentStringrequired↑

URI of the place that contains this blog. URI may either be to a place, or to a person (for a personal blog).

parentContentSummaryread-only↑

Summary information about the content object that is the parent of this object.

Availability:

Will be present in search results only.

parentPlaceSummaryread-only↑

Summary information about the place that contains this object.

Availability:

Will be present in search results only.

publishedISO 8601 Dateread-only↑

Date and time when this place was originally created.

resourcesObjectread-only↑

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

statusStringread-only↑

Visibility status of this place ("Active", "Archived", "Deleted").

typeStringrequired↑

The object type of this object ("blog").

updatedISO 8601 Dateread-only↑

Date and time this place was most recently updated.

viewCountIntegerread-only↑

Number of times this place has been viewed.

Availability:

Will be present only for objects that support view counts

visibleToExternalContributorsBooleanoptional↑

Flag indicating that this place is potentially visible to external contributors.

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

Methods

↑
createStatic(static,options)
POST /places/1234/statics

Retrieves

Static

Description

Create a new static resource for this place with the specified characteristics, and return an entity describing it.

     {
         "filename" : "{filename of the static resource}"
     }

A description field may optionally be included as well.

Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Static describing the new static resource
    • Since: 3.1
    ↑
    destroy()
    DELETE /places/1234

    Retrieves

    --

    Description

    Delete this place and any related content.

    ↑
    get(options)
    GET /places/1234

    Retrieves

    Blog

    Description

    Return an updated version of this place.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Place describing this place
    • ↑
    getActivity(options)
    GET /places/1234/activities

    Retrieves

    Activity[]

    Description

    Return a paginated list of activities that have occurred within this place.

    Options:
    NameTypeRequiredDescription
    afterStringfalseDate and time representing the minimum timestamp for returned activities. Cannot specify both after and before
    beforeStringfalseDate and time representing the maximum timestamp for returned activities. Cannot specify both after and before
    countIntegerfalseMaximum number of activities to be returned
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Activity[]
    • ↑
    getContents(options)
    GET /contents?filter=place(%2Fplaces%2F1234)

    Retrieves

    Blog

    Description

    Return the first page of a paginated list of contents that are contained in this place.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    ↑
    getFollowers(options)
    GET /places/1234/followers

    Retrieves

    Person[]

    Description

    Return a paginated list of the people following this place.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseNumber of followers to be returned (default is 25)
    fieldsStringfalseNames of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first follower to be returned
    Retrieves:
  • Person[]
    • Since: 3.5
    ↑
    getFollowingIn(options)
    GET /places/1234/followingIn

    Retrieves

    Stream[]

    Description

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

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Stream[]
    • ↑
    getStatics(options)
    GET /places/1234/statics

    Retrieves

    Static[]

    Description

    Return the list of static resources associated with this place.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Static[]
    • ↑
    toURI()

    Retrieves

    String

    Description

    Retrieves:
  • A URI representing this entity, or undefined if no such URI exists.
    • ↑
    update(place,options)
    PUT /places/1234

    Retrieves

    Place

    Description

    Update the information about this place and return an updated entity.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Place describing this place

    • Resources

    ResourceMethodReturnsDescription
    avatarGETObject↑

    Return the binary content of the avatar image for this place.

    htmlGETObject↑

    URI of the HTML representation of this place.