Post
A Post
represents a blog post. An example JSON representation looks like this:
Examples:
Example JSON
JSON including important fields and a Post's resources. See the tables below for a list of all fields and resources.
{ "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" : [ ], "id" : "1001", "resources" : { "likes" : { "ref" : "https://example.jiveon.com/api/core/v3/contents/1174/likes", "allowed" : [ "GET" ] }, "self" : { "ref" : "https://example.jiveon.com/api/core/v3/contents/1174", "allowed" : [ "PUT", "DELETE", "GET" ] }, "html" : { "ref" : "https://example.jiveon.com/people/admin/blog/2012/06/25/New-Post", "allowed" : [ "GET" ] }, "attachments" : { "ref" : "https://example.jiveon.com/api/core/v3/attachments/contents/1174", "allowed" : [ "POST", "GET" ] }, "followingIn" : { "ref" : "https://example.jiveon.com/api/core/v3/contents/1174/followingIn", "allowed" : [ "GET" ] }, "comments" : { "ref" : "https://example.jiveon.com/api/core/v3/contents/1174/comments", "allowed" : [ "POST", "GET" ] } } }
Create Post in Personal Blog
POST to /contents creates a new blog post. The minimum set of fields you must include are:
{ "content": { "type": "text/html", "text": "<body><p>Some interesting text</p></body>" }, "subject": "New Post in Personal Blog", "type": "post" }
Fields
Field | Type | Mode † | Description |
---|---|---|---|
attachments | Attachment[] | optional | List of attachments to this post (if any). |
| 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.
|
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 ("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. |
Resources
Resource | Method | Description |
---|---|---|
attachments | GET | Return a list of attachments associated to this blog post. Retrieves: |
comments | POST | Add a comment about this content object. The minimum JSON object needed to create a comment is: { "content": {"type": "text/html", "text": " Takes:
Retrieves: |
comments | GET | Return a paginated list of the comments about this content object. Retrieves: |
followers | GET | Return a paginated list of the people following this content. Retrieves:Since: 3.5 |
followingIn | GET | Return the list of custom streams in which the requesting person is following this blog post (if any). Retrieves: |
html | GET | Return the HTML representation of this content object. |
likes | POST | Register that the requesting person likes this blog post. Availability:Must be authenticated, must not be your own blog post, and must not have liked this blog post already |
likes | GET | Return a paginated list of people who like this blog post. Retrieves: |
read | POST | Mark this post as having been read. Since: 3.2 |
read | DELETE | Mark this post as having not been read. Since: 3.2 |
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. |
likes | DELETE | Delete the like of this blog post by the requesting person. Availability:Must be authenticated, and must have liked this blog post already |