Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
IdeaVote
IdeaVote Service
Web service endpoints for votes on ideas.
Availability:
Available only when the Ideation plugin is installed in this Jive instance
Since: 3.1
Jump to
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Create Vote
POST /ideaVotes/{contentID}
Cast a vote on the specified idea, replacing any previous vote by the requesting person. The
incoming JSON must include a boolean promote
field that is true
if the
requestor is promoting this idea, or false
if the requestor is demoting it.
Path Parameters:
Name | Type | Required | Description |
---|---|---|---|
contentID | String | true | The ID of the content object for which to cast a "promote" vote |
Takes:
true
if not present)Retrieves:
Return Status:
HTTP Status Code | Description |
---|---|
400 (Bad Request) | If any input field is malformed, or the ID does not specify an idea |
409 (Conflict) | You attempted to vote on an issue for which voting has been disabled |
403 (Forbidden) | If you are not allowed to access the specified content object |
410 (Gone) | If this Jive instance is not licensed for the Ideation module |
404 (Not Found) | If the specified content object does not exist |
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Get Votes
GET /ideaVotes/{contentID}
Return a paginated list of votes on the specified idea.
Path Parameters:
Name | Type | Required | Description |
---|---|---|---|
contentID | String | true | The ID of the idea content object for which to retrieve votes |
Query Parameters:
Name | Type | Required | Description |
---|---|---|---|
startIndex | Integer | false | The zero-relative index of the first vote to be returned |
count | Integer | false | The number of votes to be returned |
fields | String | false | The names of the fields to be returned |
Return Status:
HTTP Status Code | Description |
---|---|
400 (Bad Request) | If any input field is malformed, or the ID does not specify an idea |
403 (Forbidden) | If you are not allowed to access the specified content object |
410 (Gone) | If this Jive instance is not licensed for the Ideation module |
404 (Not Found) | If the specified content object does not exist |