osapi.jive.corev3.contents.Post

A Post represents a blog post. An example JSON representation looks like this:

Examples:

Example JSON

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

{
  "type" : "post",
  "status" : "published",
  "subject" : "New Post",
  "parent" : "https://example.jiveon.com/api/core/v3/places/1173",
  "content" : {
    "type" : "text/html",
    "text" : "<p>Post text</p>"
  },
  "author" : {
    "name" : {
      "formatted" : "Administrator"
    },
    "type" : "person",
    "displayName" : "Administrator",
    "id" : "1"
  },
  "visibleToExternalContributors" : false,
  "restrictComments" : false,
  "permalink" : "New-Post",
  "viewCount" : 0,
  "replyCount" : 0,
  "followerCount" : 1,
  "likeCount" : 0,
  "publishDate" : "2012-06-25T23:29:00.000+0000",
  "published" : "2012-06-25T23:29:19.135+0000",
  "updated" : "2012-06-25T23:29:19.135+0000",
  "tags" : [ ],
  "attachments" : [ ]
}

Create Post in Personal Blog

Read create() to learn how to create a new blog post.

Properties

Property	Type	Mode †	Description
`attachments`	`Attachment[]`	optional	↑ List of attachments to this post (if any).
`author`	`Person`	read-only	↑ Author of this content object.
`categories`	`String[]`	optional	↑ Categories associated with this object. Places define the list of possible categories.
`content`	`ContentBody`	required	↑ Content of this content object.
`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.
`parent`	`String`	optional	↑ URI of the blog of this post. If no parent is specified during creation then the post will be created in the personal blog.
`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.
`permalink`	`String`	read-only	↑ Permanent URI for the HTML version of this post.
`publishDate`	`ISO 8601 Date`	optional	↑ Date and time at which this post should be made visible.
`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.
`restrictComments`	`Boolean`	optional	↑ Flag indicating that old comments will be visible but new comments are not allowed. If not restricted then anyone with appropriate permissions can comment on the content.
`status`	`String`	read-only	↑ Published status of this content object. `incomplete` - Post is in draft mode `pending_approval` - Post is waiting for approval `rejected` - Post has been rejected for publication by an approver `scheduled` - Post has been scheduled to be published on a given date `published` - Post 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 ("post"). 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.

Methods

↑

createComment(comment,options)
POST /contents/1234/comments

Retrieves

Comment

Description

Add a comment about this content object.

The minimum JSON object needed to create a comment is:

     {
         "content": {"type": "text/html", "text": "<body><p>This is a new comment</p></body>"},
     }

Takes:

Comment describing the new comment

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Comment representing the recorded comment

↑

destroy()
DELETE /contents/1234

Retrieves

--

Description

Delete this content object and any related comments and other related information.

↑

get(options)
GET /contents/1234

Retrieves

Post

Description

Return an updated version of this content object.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Content describing this content object

↑

getAttachments(options)
GET /attachments/contents/1234

Retrieves

Attachment[]

Description

Return a list of attachments associated to this blog post.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Attachment[]

↑

getComments(options)
GET /contents/1234/comments

Retrieves

Comment[]

Description

Return a paginated list of the comments about this content object.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of comments to be returned (default is 25)
anchor	String	false	optional URI for a comment to anchor at. Specifying a anchor will try to return the page containing the anchor. If the anchor could not be found then the first page of comments will be returned.
excludeReplies	Boolean	false	Flag indicating that replies to the direct comments about this direct message should be excluded (default is false)
fields	String	false	The names of the fields to be returned
hierarchical	Boolean	false	Flag indicating that comments should be returned in hierarchical order instead of chronological order (default is true)
startIndex	Integer	false	Zero-relative index of the first comment to be returned (default is zero)

Retrieves:

Comment[]

↑

getFollowers(options)
GET /contents/1234/followers

Retrieves

Person[]

Description

Return a paginated list of the people following this content.

Options:

Name	Type	Required	Description
count	Integer	false	Number of followers to be returned (default is 25)
fields	String	false	Names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first follower to be returned

Retrieves:

Person[]

Since: 3.5

↑

getFollowingIn(options)
GET /contents/1234/followingIn

Retrieves

Stream[]

Description

Return the list of custom streams in which the requesting person is following this blog post (if any).

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Stream[]

↑

getLikes(options)
GET /contents/1234/likes

Retrieves

Person[]

Description

Return a paginated list of people who like this blog post.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of people to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

Person[]

↑

like()
POST /contents/1234/likes

Retrieves

--

Description

Availability:

Must be authenticated, must not be your own blog post, and must not have liked this blog post already

↑

markRead()
POST /contents/1234/read

Retrieves

--

Description

Mark this post as having been read.

Since: 3.2

↑

markUnread()
DELETE /contents/1234/read

Retrieves

--

Description

Mark this post as having not been read.

Since: 3.2

↑

toURI()

Retrieves

String

Description

Retrieves:

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

↑

unlike()
DELETE /contents/1234/likes

Retrieves

--

Description

Delete the like of this blog post by the requesting person.

Availability:

Must be authenticated, and must have liked this blog post already

↑

update(multipartbody,options)
PUT /contents/1234

Retrieves

Content

Description

Update the information about this content object.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Content representing the updated content object

Resources

Resource	Method	Returns	Description
`html`	`GET`	`Object`	↑ Return the HTML representation of this content object.