static osapi.jive.corev3.groups

Static class for getting and creating Groups. A Group is a place that has members and can have restricted access. The groupType field can take on values OPEN, MEMBER_ONLY, PRIVATE, or SECRET.
  • Open - Membership is open and non-members can view content and participate.
  • Members Only - Membership is open and non-members can view content, but must join to participate.
  • Private - Membership is by approval/invitation only and only members can view content and participate.
  • Secret - Membership is by invitation only, only members may participate, and the group is not listed in the group directory.

Methods

↑
create(group,options)
POST /places

Retrieves

Group

Description

Create a new Jive social group.

Here is an example of a JSON with the minimum set of fields you must include: 

{
    "displayName": "ACDC",
    "name": "School of Rock",
    "groupType" : "OPEN"
}

Takes:
  • Group Description of the Jive social group to be created.
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned.
Retrieves:
  • Group Representation of the newly created Jive social group
    • ↑
    get(options)
    GET /places

    Retrieves

    Place[]

    Description

    Return a paginated list of Jive social groups that match the specified criteria.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseMaximum number of places to return (default is 25)
    fieldsStringfalseNames of the fields to be returned
    searchStringfalseOne or more search terms separated by commas, limiting results to places that match the terms
    startIndexIntegerfalseZero-relative index of the first place to be returned
    tagStringfalseComma delimited list of tag values, limiting results to places with one of those tags
    Retrieves:
  • Group[] Paginated list of matching Jive social groups
    • ↑
    get(options)
    GET /places/{uri}

    Retrieves

    Place

    Description

    Return a single Jive social group by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the Jive social group to get
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Group Representation of the requested Jive social group