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

FieldTypeMode Description
attachmentsAttachment[]optional

List of attachments to this post (if any).

authorPersonread-only

Author of this content object.

categoriesString[]optional

Categories associated with this object. Places define the list of possible categories.

contentContentBodyrequired

Content of this content object.

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.

parentStringoptional

URI of the blog of this post. If no parent is specified during creation then the post will be created in the 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.

permalinkStringread-only

Permanent URI for the HTML version of this post.

publishDateISO 8601 Dateoptional

Date and time at which this post should be made visible.

publishedISO 8601 Dateread-only

Date and time when this content object was originally created.

replyCountIntegerread-only

Number of replies to this object.

Availability:

Will be present only for object types that support replies.

resourcesObjectread-only

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

restrictCommentsBooleanoptionalFlag 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.
statusStringread-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
subjectStringrequired

Subject of this content object.

tagsString[]optional

Tags associated with this object.

Availability:

Will be present only for object types that support tags

typeStringrequired

The object type of this object ("post"). This field is required when creating new content.

updatedISO 8601 Dateread-only

Date and time this content object was most recently updated.

viewCountIntegerread-only

Number of times this content object has been viewed.

Availability:

Will be present only for objects that support view counts

visibleToExternalContributorsBooleanread-only

Flag indicating that this content object 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

Resources

ResourceMethodDescription
attachmentsGET

Return a list of attachments associated to this blog post.

Retrieves:
  • Attachment[]
  • commentsPOST

    Add a comment about this content object.

    The minimum JSON object needed to create a comment is:

         {
             "content": {"type": "text/html", "text": "

    This is a new comment

    "}, }
    Takes:
    Retrieves:
  • Comment representing the recorded comment
  • commentsGET

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

    Retrieves:
  • Comment[]
  • followersGET

    Return a paginated list of the people following this content.

    Retrieves:
  • Person[]
  • Since: 3.5
    followingInGET

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

    Retrieves:
  • Stream[]
  • htmlGET

    Return the HTML representation of this content object.

    likesPOST

    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

    likesGET

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

    Retrieves:
  • Person[]
  • readPOST

    Mark this post as having been read.

    Since: 3.2
    readDELETE

    Mark this post as having not been read.

    Since: 3.2
    selfGET

    Return an updated version of this content object.

    Retrieves:
  • Content describing this content object
  • selfPUT

    Update the information about this content object.

    Retrieves:
  • Content representing the updated content object
  • selfDELETE

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

    likesDELETE

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

    Availability:

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