osapi.jive.corev3.places.Group

A Jive social group. Groups have a groupType field specifying if the group is OPEN, MEMBER_ONLY, PRIVATE, or SECRET. Groups have people as members. To add a Person to a Group, create a Member with the service. The following types are related to Groups:

Example:
Example JSON

JSON with the most important data for a Group. See the table below for a list of all fields.

 {
   "type" : "group",
   "name" : "Product Feature Requests",
   "displayName" : "product-feature-requests",
   "description" : "",
   "status" : "Active",
   "groupType" : "OPEN",
   "contentTypes" : [ "blog", "documents", "files", "discussions", "projects" ],
   "visibleToExternalContributors" : false,
   "extendedAuthorsEnabled" : false,
   "viewCount" : 23,
   "followerCount" : 1,
   "memberCount" : 1,
   "creator" : {
     "name" : {
       "givenName" : "Admin",
       "familyName" : "User",
       "formatted" : "Admin User"
     },
     "type" : "person",
     "displayName" : "Admin User",
     "id" : "1"
   },
   "published" : "2012-07-09T23:36:01.763+0000",
   "updated" : "2012-07-09T23:36:01.763+0000",
   "tags" : [ "products", "marketing" ]
 }

Properties

PropertyTypeMode Description
contentTypesString[]optional

Content types that may be included in this place. Valid values are the plural versions of all defined content types (documents, discussions, files, polls), plus projects (if projects are allowed in this place), tasks (for projects only), and blog (if a blog is allowed in this place). Additional content types may be available if this Jive instance has installed plugins defining them. During creation, if no content type is specified then all available content types will be selected. If the blog content type is included during creation, then a blog will automatically be created inside the place.

creatorPersonread-only

Person that created this social group.

descriptionStringoptional

Human readable description of this place.

displayNameStringrequired

Display name of this place. It must be unique among places of the same type in this Jive instance. This value is used to compose the URL for the HTML presentation of this place in the Jive user interface, so its syntax must conform to the following rules:

  • It must contain only alpha-numeric characters, '-' or '_'.
  • It must contain less than 255 characters.
  • It must not be blank.
  • It must not be unique among places of the same type.
extendedAuthorsEnabledBooleanoptional

Flag indicating that this place has extended authors enabled.

followerCountIntegerread-only

Number of people following this object.

Availability:

Will be present only for object types that support being followed.

groupTypeStringrequired

Membership and visibility type of this group (OPEN, MEMBER_ONLY, PRIVATE, SECRET).

groupTypeNewStringrequired

New membership and visibility type of this group (PUBLIC, PUBLIC_RESTRICTED, PRIVATE_LISTED, PRIVATE_UNLISTED).

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.

iconCssStringread-only

CSS Style to locate icon within sprite.

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.

isFollowedBooleanread-only

Whether the current user is following this object.

Availability:

Will be present only for object types that support being followed.

isPromotedResultBooleanread-only

A boolean determining whether this search result is a promoted result

Availability:

Will be present in search results only.

likeCountIntegerread-only

Number of people who have liked this object.

Availability:

Will be present only for object types that support being liked.

memberCountIntegerread-only

Number of people that are members of this group.

nameStringrequired

Formal name of this place. It must be unique among places of the same type in this Jive instance.

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.

placeIDStringread-only

Internal Jive ID associated with the place.

placeTopicsPlaceTopic[]optional

List of place topics applied to this place

publishedISO 8601 Dateread-only

Date and time when this place was originally created.

resourcesObjectread-only

Resource links (and related permissions for the requesting person) relevant to this object.

searchRankingsObjectread-only

A map of search result scores including social signals.

Availability:

Will be present in search results only.

statusStringread-only

Visibility status of this place ("Active", "Archived", "Deleted").

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 ("group").

typeCodeIntegerread-only
updatedISO 8601 Dateread-only

Date and time this place was most recently updated.

viewCountIntegerread-only

Number of times this place has been viewed.

Availability:

Will be present only for objects that support view counts

visibleToExternalContributorsBooleanoptional

Flag indicating that this place is potentially visible to external contributors.

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

Methods

createAnnouncement(announcement,options)
POST /places/1234/announcements

Retrieves

Announcement

Description

Create a new announcement associated with this place. An appropriate parent field will be calculated and injected automatically.

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</p></body>"
      },
  "subject": "Free beer for everyone"
 }

Takes:
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Announcement describing the new announcement
  • createAvatar(options)
    POST /places/1234/avatar

    Retrieves

    Object

    Description

    Register a new avatar image (or replace an existing one) for this place. The image will be downloaded and scaled as necessary.

    Options:
    NameTypeRequiredDescription
    uriStringfalseThe URI of a JPG, PNG, or GIF formatted image
    createCategory(category,options)
    POST /places/1234/categories

    Retrieves

    Category

    Description

    Create a new category for this place with the specified characteristics, and return an entity describing it. The minimum information required to create a new category is:

       {
         "name": "Animals"
       }
    
    Takes:
    Options:
    NameTypeRequiredDescription
    autoCategorizeStringfalseFlag indicating whether existing content in this place will be categorized in this category based on matched tags
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Category describing the new category
  • createExtProps(uriinfo,options)
    POST /places/1234/extprops

    Retrieves

    ExtProps[]

    Description

    Creates extended properties for a place.

     {
      "any prop name": "any val",
      "any prop2 name": "any val"
     }
    
    Availability:

    Place should be editable to caller.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • ExtProps[]
  • createInvites(object,options)
    POST /invites/places/1234

    Retrieves

    Object

    Description

    Invite one or more people to become a members of this group. An invitation can be issued to either an existing Jive person, or to an email address that invites the user to join this Jive instance and also to join the group. Minimum information to create an invitation is:

         {
             "invitees" : [
                 "https://example.jiveon.com/api/core/v3/people/####",
                 "fred@example.com"
             ],
             "body" : "Please come and join our wonderful group"
         }
    
    createMember(member,options)
    POST /members/places/1234

    Retrieves

    Member

    Description

    Create a new member, and return an entity describing it. The minimum information required to create a new member is:

         {
             "person" : "https://example.jiveon.com/api/core/v3/people/####",
             "state" : "member"
         }
    

    The only valid states that may be used when creating a member are:

    • owner - Person has group administration capabilities as well as membership
    • member - Person has regular membership capabilities only
    Takes:
    • MemberEntity Details of the new member to be created
    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Member representing the new member
  • createStatic(static,options)
    POST /places/1234/statics

    Retrieves

    Static

    Description

    Create a new static resource for this place with the specified characteristics, and return an entity describing it.

         {
             "filename" : "{filename of the static resource}"
         }
    

    A description field may optionally be included as well.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Static describing the new static resource
  • Since: 3.1
    deleteExtProps()
    DELETE /places/1234/extprops

    Retrieves

    --

    Description

    Deletes all extended properties for a place.

    Availability:

    Place should be editable to caller.

    destroy()
    DELETE /places/1234

    Retrieves

    --

    Description

    Delete this place and any related content.

    destroyAvatar()
    DELETE /places/1234/avatar

    Retrieves

    --

    Description

    Delete the existing avatar image for this place.

    get(options)
    GET /places/1234

    Retrieves

    Group

    Description

    Return an updated version of this place.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Place describing this place
  • getActivity(options)
    GET /places/1234/activities

    Retrieves

    Activity[]

    Description

    Return a paginated list of activities that have occurred within this place.

    Options:
    NameTypeRequiredDescription
    afterStringfalseDate and time representing the minimum timestamp for returned activities. Cannot specify both after and before
    beforeStringfalseDate and time representing the maximum timestamp for returned activities. Cannot specify both after and before
    countIntegerfalseMaximum number of activities to be returned
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Activity[]
  • getAnnouncements(options)
    GET /places/1234/announcements

    Retrieves

    Announcement[]

    Description

    Return a paginated list of announcements for this place.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseMaximum number of announcements to be returned
    fieldsStringfalseNames of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first announcement to be returned F
    Retrieves:
  • Announcement[]
  • getBlog(options)
    GET /places/1234

    Retrieves

    Group

    Description

    Return the blog associated with this place.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Blog
  • getCategories(options)
    GET /places/1234/categories

    Retrieves

    Category[]

    Description

    Return the categories associated with this place.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Category[]
  • getContents(options)
    GET /contents?filter=place(%2Fplaces%2F1234)

    Retrieves

    Group

    Description

    Return the first page of a paginated list of contents that are contained in this place.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    getExtProps(options)
    GET /places/1234/extprops

    Retrieves

    ExtProps

    Description

    Returns extended properties for a place.

    Availability:

    Place should be visible to caller.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • ExtProps[]
  • getFeaturedContent(options)
    GET /places/1234/contents/featured

    Retrieves

    Group

    Description

    Return a list of featured content objects in this place.

    Options:
    NameTypeRequiredDescription
    typeStringfalseComma delimited list of content object types, limiting results to objects of those types
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Content[]
  • getFollowers(options)
    GET /places/1234/followers

    Retrieves

    Person[]

    Description

    Return a paginated list of the people following this place.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseNumber of followers to be returned (default is 25)
    fieldsStringfalseNames of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first follower to be returned
    Retrieves:
  • Person[]
  • Since: 3.5
    getFollowingIn(options)
    GET /places/1234/followingIn

    Retrieves

    Stream[]

    Description

    Return the custom streams (if any) in which the requesting person is following this place.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Stream[]
  • getInvites(options)
    GET /invites/places/1234

    Retrieves

    Object

    Description

    Return a paginated list of outstanding invitations for the specified group. Unless you are a group admin of the specified group, you will only be able to see invitations sent either from you or to you.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseMaximum number of invites to be returned (default is 25)
    fieldsStringfalseNames of the fields to be returned
    inviteeStringfalseURI of the person whose inbound invitations should be returned (default is all)
    inviterStringfalseURI of the person whose outbound invitations should be returned (default is all)
    startIndexIntegerfalseZero-relative index of the first invite to be returned
    getMembers(options)
    GET /members/places/1234

    Retrieves

    Member[]

    Description

    Return a paginated list of group members.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseMaximum number of memberships to be returned (default is 25)
    personStringfalseURI of a person whose membership should be returned. Since 3.9
    fieldsStringfalseNames of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first membership to be returned
    stateString[]falseList of membership state values (default is all states)
    Retrieves:
  • Member[]
  • getPlaces(options)
    GET /places/1234/places

    Retrieves

    Place[]

    Description

    Return the list of child places in this place.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Place[]
  • getStatics(options)
    GET /places/1234/statics

    Retrieves

    Static[]

    Description

    Return the list of static resources associated with this place.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Static[]
  • toURI()

    Retrieves

    String

    Description

    Retrieves:
  • A URI representing this entity, or undefined if no such URI exists.
  • update(place,options)
    PUT /places/1234

    Retrieves

    Place

    Description

    Update the information about this place and return an updated entity.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Place describing this place
  • Resources

    ResourceMethodReturnsDescription
    avatarGETObject

    Return the binary content of the avatar image for this place.

    htmlGETObject

    URI of the HTML representation of this place.