static
osapi.jive.corev3.discussions
A static class for getting and creating
Discussions
. A list of
Discussions can be retrieved or a single Discussion can be retrieved by URI.Methods
↑
Discussion describing the newly created discussion
create(discussion,options)
POST /contents
Retrieves
Discussion
Description
Create a new discussion with specified characteristics, and return an entity representing the newly created discussion.
Here is an example of a JSON with the minimum set of fields you must include:
{ "content": { "type": "text/html", "text": "<body><p>Some interesting text to discuss</p></body>" }, "subject": "New Discussion" }
Takes:
- Discussion fields describing the new discussion
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | Names of the fields to be returned |
Retrieves:
↑
Discussion[] Paginated list of matching discussions
get(options)
GET /contents
Retrieves
Content[]
Description
Return a paginated list of discussions that match the specified criteria.
Options:
Name | Type | Required | Description |
---|---|---|---|
author | String | false | URI of a person, limiting results to objects authored by this person |
count | Integer | false | Maximum number of objects to return (default is 25) |
fields | String | false | Names of the fields to be returned |
place | String | false | URI of a place, limiting results to objects contained in that place |
search | String | false | One or more search terms separated by commas, limiting results to objects that match the terms |
startIndex | Integer | false | Zero-relative index of the first content object to be returned |
tag | String | false | Comma delimited list of tag values, limiting results to objects with one of those tags |
Retrieves:
↑
Discussion Representation of the requested discussion
get(options)
GET /contents/{uri}
Retrieves
Content
Description
Return a single discussion by its URI.
Options:
Name | Type | Required | Description |
---|---|---|---|
uri | String | true | URI of the discussion to get |
fields | String | false | Names of the fields to be returned |