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>"
  },
  "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

FieldTypeMode †Description
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.

optionsString[]required

The options available to be voted on for this poll.

parentStringoptional

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).

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.

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.

statusStringread-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
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 ("poll"). This field is required when creating new content.

updatedISO 8601 Dateread-only

Date and time this content object was most recently updated.

usersPerson[]optionalThe 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.
viewCountIntegerread-only

Number of times this content object has been viewed.

Availability:

Will be present only for objects that support view counts

visibilityStringoptional

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.
visibleToExternalContributorsBooleanread-only

Flag indicating that this content object is potentially visible to external contributors.

voteCountIntegerread-only

The current number of votes on this poll.

votesString[]read-only

The options voted by the user making the request.

†
→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Resources

ResourceMethodDescription
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 poll (if any).

    Retrieves:
  • Stream[]
    • htmlGET

    Return the HTML representation of this content object.

    likesPOST

    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

    likesGET

    Return a paginated list of people who like this poll.

    Retrieves:
  • Person[]
    • readPOST

    Mark this poll as having been read.

    Since: 3.2
    readDELETE

    Mark this poll 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 poll by the requesting person.

    Availability:

    Must be authenticated, and must have liked this poll already

    votesPOST

    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
    votesGET

    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.