Announcement

An Announcement can be either a system announcement (visible to everyone) or related to a particular place. Announcements show up in a user's Inbox and on the right sidebar for system announcements.

Examples:

Example JSON

JSON including important fields and an Announcement's resources. See the tables below for a list of all fields and resources.

{
  "type" : "announcement",
  "status" : "published",
  "subject" : "Can fracking pollute water? Study tries to answer - Yahoo! News",
  "parent" : "https://example.jiveon.com/api/core/v3/places/1001",
  "content" : {
    "type" : "text/html",
    "text" : "<body><p>This is an important announcement</p></body>"
  },
  "author" : {
    "name" : {
      "formatted" : "Administrator"
    },
    "type" : "person",
    "displayName" : "Administrator",
    "id" : "1"
  },
  "subjectURI" : "http://news.yahoo.com/fracking-pollute-water-study-tries-answer-174343650.html",
  "image" : "https://example.jiveon.com/servlet/JiveServlet/downloadImage/22-1001-1028/campbell_med_good.jpg",
  "endDate" : "2012-07-19T06:59:59.000+0000",
  "publishDate" : "2012-07-11T23:06:35.700+0000",
  "published" : "2012-07-11T23:06:35.696+0000",
  "updated" : "2012-07-11T23:06:35.714+0000",
  "resources" : {
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/announcements/1001",
      "allowed" : [ "PUT", "DELETE", "GET" ]
    },
    "html" : {
      "ref" : "https://example.jiveon.com/",
      "allowed" : [ "GET" ]
    }
  }
 }

Create System Announcement

POST to /announcements creates a new system announcement. The minimum set of fields you must include are:

 {
  "content":
      {
      "type": "text/html",
      "text": "<body><p>Some interesting text</p></body>"
      },
  "subject": "Free beer for everyone",
  "type": "announcement"
 }

Create Announcement

POST to /places/{placeID}/announcements creates a new announcement in a place. The minimum set of fields you must include are:

 {
  "content":
      {
      "type": "text/html",
      "text": "<body><p>Some interesting text</p></body>"
      },
  "subject": "Free beer for everyone",
  "type": "announcement"
 }

Fields

Field	Type	Mode †	Description
`author`	`Person`	read-only	Author of this content object.
`content`	`ContentBody`	required	Content of this content object.
`endDate`	`ISO 8601 Date`	optional	The date and time after which this announcement should no longer be displayed. If no end date is specified during creation then it will default to a week since publish date.
`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.
`image`	`String`	optional	The display URL for the image associated with this Announcement. May be null for announcements that don't have an image.
`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 parent place (or person, for personal content) of this content object. If no parent is specified then the root space will be used as the parent.
`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.
`publishDate`	`ISO 8601 Date`	optional	The date and time after which the announcement should start being displayed. If no publish date is specified during creation then it will default to now.
`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.
`sortKey`	`Integer`	optional	An integer. When several unexpired announcements are displayed, they'll be ordered by descending sortKey.
`status`	`String`	read-only	Published status of this content object. `incomplete` - Content object is in draft mode `pending_approval` - Content object is waiting for approval `rejected` - Content object has been rejected for publication by an approver `published` - Content object has been published
`subject`	`String`	required	Subject of this content object.
`subjectURI`	`String`	optional	The URI that the subject should link to when displayed. May be null.
`subjectURITargetType`	`String`	read-only	The entity type that the subjectURI property links to. Null if the link target is external, unknown to the CoreObjectTypeProvider, or if subjectURI is null. This property is read-only.
`type`	`String`	required	The object type for this object ("announcement"). 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
`html`	`GET`	Return the HTML representation of this content object.
`read`	`POST`	Mark this announcement as having been read. Since: 3.2
`read`	`DELETE`	Mark this announcement as having not been read. Since: 3.2
`self`	`GET`	Return an updated version of this announcement. Retrieves: Announcement describing this announcement
`self`	`PUT`	Update the information about this announcement. Retrieves: Announcement representing the updated announcement
`self`	`DELETE`	Delete this announcement.

Announcement

Examples:

Example JSON

Create Announcement

Fields

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Resources

Since: 3.2

Since: 3.2

Retrieves:

Retrieves: