Poll

The Poll content type for conducting informal surveys.

Example:

Example JSON

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

{
  "type" : "poll",
  "status" : "published",
  "subject" : "Poll for colors",
  "content" : {
    "type" : "text/html",
    "text" : "<body><p>Which color is your favorite?</p></body>"
  },
  "contentImages" : [ {
    "id" : "1055",
    "contentType" : "image/jpeg",
    "name" : "pic.jpeg",
    "ref" : "http://example.jiveon.com/api/core/v3/attachments/file/1055/data",
    "size" : 5953,
    "width" : 251,
    "height" : 201,
    "type" : "image"
  } ],
  "author" : {
    "name" : {
      "formatted" : "Administrator"
    },
    "type" : "person",
    "displayName" : "Administrator",
    "id" : "1"
  },
  "visibility" : "all",
  "visibleToExternalContributors" : false,
  "options" : [ "Blue", "Yellow", "Red" ],
  "votes" : [ ],
  "voteCount" : 0,
  "viewCount" : 1,
  "replyCount" : 0,
  "followerCount" : 0,
  "likeCount" : 0,
  "published" : "2012-07-12T21:38:36.400+0000",
  "updated" : "2012-07-12T21:38:36.402+0000",
  "tags" : [ "general_interest" ],
  "id" : "1008",
  "resources" : {
    "likes" : {
      "ref" : "https://example.jiveon.com/api/core/v3/contents/1247/likes",
      "allowed" : [ "GET" ]
    },
    "votes" : {
      "ref" : "https://example.jiveon.com/api/core/v3/votes/1247",
      "allowed" : [ "GET", "POST" ]
    },
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/contents/1247",
      "allowed" : [ "DELETE", "GET", "PUT" ]
    },
    "html" : {
      "ref" : "https://example.jiveon.com/polls/1008",
      "allowed" : [ "GET" ]
    },
    "followingIn" : {
      "ref" : "https://example.jiveon.com/api/core/v3/contents/1247/followingIn",
      "allowed" : [ "GET" ]
    },
    "comments" : {
      "ref" : "https://example.jiveon.com/api/core/v3/contents/1247/comments",
      "allowed" : [ "GET", "POST" ]
    }
  }
}

Fields

Field	Type	Mode †	Description
`abuseCount`	`Integer`	read-only	Number of abuse reports associated with this content object.
`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.
`contentID`	`String`	read-only	Internal Jive ID associated with the content.
`contentImages`	`Image[]`	read-only	A list of Image objects providing metadata about images embedded within this content.
`contentVideos`	`ContentVideo[]`	read-only	A list of ContentVideo objects providing metadata about videos embedded within this content.
`endDate`	`ISO 8601 Date`	read-only	Date and time at which voting for this poll should end. When this field is not present the poll has no end date and can be manually closed. Since: 3.9
`expirationDate`	`ISO 8601 Date`	read-only
`extendedAuthors`	`Person[]`	optional	List of people who have been granted authorship on this content, who would normally not have access to it. Extended authors are allowed to edit the content. This value is used only when authorship is limited.
`favoriteCount`	`Integer`	read-only	Number of people who have bookmarked this object. Availability: Will be present only for object types that support being bookmarked. Since: 3.11
`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.
`iconCss`	`String`	read-only	CSS Style to locate icon within sprite.
`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.
`lastActivityDate`	`ISO 8601 Date`	read-only	Date and time when this had its last activity. Since: 3.12
`likeCount`	`Integer`	read-only	Number of people who have liked this object. Availability: Will be present only for object types that support being liked.
`options`	`String[]`	required	The options available to be voted on for this poll.
`optionsImages`	`PollOptionImage[]`	required	Images associated to the options available to be voted on for this poll. Since: 3.8
`outcomeTypes`	`OutcomeType[]`	optional	A list of valid outcome types that can be set on this piece of content
`parent`	`String`	optional	URI of the parent place of this content object. When visibility is place then the URI points to a place (and is required on create). Otherwise, this field is not part of the returned JSON (and must not be included on create).
`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.
`parentContentVisible`	`Boolean`	read-only	Flag indicating that the content parent's contents are visible to the viewer.
`parentPlace`	`Summary`	read-only	Summary information about the place that contains this object. Availability: Will be present in search results only.
`parentVisible`	`Boolean`	read-only	Flag indicating that the content parent is visible to the viewer.
`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.
`searchRankings`	`Object`	read-only	A map of search result scores including social signals. Availability: Will be present in search results only.
`startDate`	`ISO 8601 Date`	read-only	Date and time at which voting for this poll should start. Since: 3.9
`status`	`String`	read-only	Published status of this content object. `incomplete` - Content object is in draft mode `awaiting moderation` - Content object is waiting for moderation by an approver `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.
`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 ("poll"). This field is required when creating new content.
`updated`	`ISO 8601 Date`	read-only	Date and time this content object was most recently updated.
`users`	`Person[]`	optional	The list of users that can see the content. On create or update, provide a list of Person URIs or Person entities. On get, returns a list of Person entities. This value is used only when visibility is people.
`viewCount`	`Integer`	read-only	Number of times this content object has been viewed. Availability: Will be present only for objects that support view counts
`visibility`	`String`	optional	The visibility policy for this content object. Valid values are: all - anyone with appropriate permissions can see the content. Default when visibility, parent and users were not specified. hidden - only the author can see the content. people - only those users specified by users can see the content. Default when visibility and parent were not specified but users was specified. place - place permissions specify which users can see the content. Default when visibility was not specified but parent was specified.
`visibleToExternalContributors`	`Boolean`	read-only	Flag indicating that this content object is potentially visible to external contributors.
`voteCount`	`Integer`	read-only	The current number of votes on this poll.
`voteDates`	`ISO 8601 Date[]`	read-only	The dates the user making the request voted. These dates align with the votes list.
`votes`	`String[]`	read-only	The options voted by the user making the request.
`followed`	`Boolean`	read-only	Whether the current user is following this object. Availability: Will be present only for object types that support being followed.
`promotedResult`	`Boolean`	read-only	A boolean determining whether this search result is a promoted result Availability: Will be present in search results only.

Resources

Resource	Method	Description
`childOutcomeTypes`	`GET`	Return a paginated list of possible outcomes types on the content object's children. Retrieves: OutcomeType[]
`comments`	`POST`	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: Comment describing the new comment Retrieves: Comment representing the recorded comment
`comments`	`GET`	Return a paginated list of the comments about this content object. Retrieves: Comment[]
`extprops`	`DELETE`	Deletes all extended properties for content. Availability: Content should be editable to caller.
`extprops`	`GET`	Returns extended properties for content. Availability: Content should be visible to caller. Retrieves: ExtProps[]
`extprops`	`POST`	Creates extended properties for content. { "any prop name": "any val", "any prop2 name": "any val" } Availability: Content should be editable to caller. Retrieves: ExtProps[]
`followers`	`GET`	Return a paginated list of the people following this content. Retrieves: Person[] Since: 3.5
`followingIn`	`GET`	Return the list of custom streams in which the requesting person is following this poll (if any). Retrieves: Stream[]
`html`	`GET`	Return the HTML representation of this content object.
`likes`	`POST`	Register that the requesting person likes this poll. Availability: Must be authenticated, must not be your own poll, and must not have liked this poll already
`likes`	`GET`	Return a paginated list of people who like this poll. Retrieves: Person[]
`read`	`POST`	Mark this poll as having been read. Since: 3.2
`read`	`DELETE`	Mark this poll as having not been read. Since: 3.2
`outcomes`	`POST`	Register that the requesting person created the outcome. Here is an example of a JSON with the minimum set of fields you must include: { "outcomeType": { "id": 1 } } Availability: Must be authenticated, must not be able to read the content, and must not have the same outcome type on this comment already Takes: Outcome the outcome to be created. Retrieves: Outcome Representation of the newly created outcome
`outcomes`	`GET`	Return a paginated list of outcomes on the content. Retrieves: Outcome[]
`outcomeTypes`	`GET`	Return a paginated list of possible outcomes types on the content. Retrieves: OutcomeType[]
`self`	`GET`	Return an updated version of this content object. Retrieves: Content describing this content object
`self`	`PUT`	Update the information about this content object. Retrieves: Content representing the updated content object
`self`	`DELETE`	Delete this content object and any related comments and other related information.
`likes`	`DELETE`	Delete the like of this poll by the requesting person. Availability: Must be authenticated, and must have liked this poll already
`votes`	`POST`	Cast a vote on this poll. Some polls allow multiple votes or a single vote. [ "Blue" ] Takes: entity JSON array with the options the user is voting for
`votes`	`GET`	Return the number of votes each option received on this poll. { "list": [ { "count": 1, "option": "Blue" }, { "count": 0, "option": "Yellow" }, { "count": 1, "option": "Red" } ] } Retrieves: JSON array where each entry has an option attribute and a count attribute that holds the number of votes the option received.

Poll

Example:

Example JSON

Fields

Since: 3.9

Availability:

Since: 3.11

Availability:

Availability:

Availability:

Availability:

Since: 3.12

Availability:

Since: 3.8

Availability:

Availability:

Availability:

Availability:

Since: 3.9

Availability:

Availability:

Availability:

Availability:

Resources

Retrieves:

Takes:

Retrieves:

Retrieves:

Availability:

Availability:

Retrieves:

Availability:

Retrieves:

Retrieves:

Since: 3.5

Retrieves:

Availability:

Retrieves:

Since: 3.2

Since: 3.2

Availability:

Takes:

Retrieves:

Retrieves:

Retrieves:

Retrieves:

Retrieves:

Availability:

Takes:

Retrieves: