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

Property	Type	Mode †	Description
`contentTypes`	`String[]`	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.
`creator`	`Person`	read-only	↑ Person that created this social group.
`description`	`String`	optional	↑ Human readable description of this place.
`displayName`	`String`	required	↑ 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.
`extendedAuthorsEnabled`	`Boolean`	optional	↑ Flag indicating that this place has extended authors enabled.
`followerCount`	`Integer`	read-only	↑ Number of people following this object. Availability: Will be present only for object types that support being followed.
`groupType`	`String`	required	↑ Membership and visibility type of this group (OPEN, MEMBER_ONLY, PRIVATE, SECRET).
`groupTypeNew`	`String`	required	↑ New membership and visibility type of this group (PUBLIC, PUBLIC_RESTRICTED, PRIVATE_LISTED, PRIVATE_UNLISTED).
`highlightBody`	`String`	read-only	↑ Highlight snippet of a search match in the body or description. Availability: Will be present in search results only.
`highlightSubject`	`String`	read-only	↑ Highlight snippet of a search match in the subject or name. Availability: Will be present in search results only.
`highlightTags`	`String`	read-only	↑ Highlight snippet of a search match in tags. Availability: Will be present in search results only.
`iconCss`	`String`	read-only	↑ CSS Style to locate icon within sprite.
`id`	`String`	read-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.
`isFollowed`	`Boolean`	read-only	↑ Whether the current user is following this object. Availability: Will be present only for object types that support being followed.
`isPromotedResult`	`Boolean`	read-only	↑ A boolean determining whether this search result is a promoted result Availability: Will be present in search results only.
`likeCount`	`Integer`	read-only	↑ Number of people who have liked this object. Availability: Will be present only for object types that support being liked.
`memberCount`	`Integer`	read-only	↑ Number of people that are members of this group.
`name`	`String`	required	↑ Formal name of this place. It must be unique among places of the same type in this Jive instance.
`parentContent`	`Summary`	read-only	↑ Summary information about the content object that is the parent of this object. Availability: Will be present in search results only.
`parentPlace`	`Summary`	read-only	↑ Summary information about the place that contains this object. Availability: Will be present in search results only.
`placeID`	`String`	read-only	↑ Internal Jive ID associated with the place.
`placeTopics`	`PlaceTopic[]`	optional	↑ List of place topics applied to this place
`published`	`ISO 8601 Date`	read-only	↑ Date and time when this place was originally created.
`resources`	`Object`	read-only	↑ Resource links (and related permissions for the requesting person) relevant to this object.
`searchRankings`	`Object`	read-only	↑ A map of search result scores including social signals. Availability: Will be present in search results only.
`status`	`String`	read-only	↑ Visibility status of this place ("Active", "Archived", "Deleted").
`tags`	`String[]`	optional	↑ Tags associated with this object. Availability: Will be present only for object types that support tags
`type`	`String`	required	↑ The object type of this object ("group").
`typeCode`	`Integer`	read-only	↑
`updated`	`ISO 8601 Date`	read-only	↑ Date and time this place was most recently updated.
`viewCount`	`Integer`	read-only	↑ Number of times this place has been viewed. Availability: Will be present only for objects that support view counts
`visibleToExternalContributors`	`Boolean`	optional	↑ Flag indicating that this place is potentially visible to external contributors.

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:

Announcement describing the new announcement

Options:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
uri	String	false	The 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:

Category describing the new category

Options:

Name	Type	Required	Description
autoCategorize	String	false	Flag indicating whether existing content in this place will be categorized in this category based on matched tags
fields	String	false	Names 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:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
after	String	false	Date and time representing the minimum timestamp for returned activities. Cannot specify both after and before
before	String	false	Date and time representing the maximum timestamp for returned activities. Cannot specify both after and before
count	Integer	false	Maximum number of activities to be returned
fields	String	false	Names 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:

Name	Type	Required	Description
count	Integer	false	Maximum number of announcements to be returned
fields	String	false	Names of the fields to be returned
startIndex	Integer	false	Zero-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:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
type	String	false	Comma delimited list of content object types, limiting results to objects of those types
fields	String	false	Names 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:

Name	Type	Required	Description
count	Integer	false	Number of followers to be returned (default is 25)
fields	String	false	Names of the fields to be returned
startIndex	Integer	false	Zero-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:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
count	Integer	false	Maximum number of invites to be returned (default is 25)
fields	String	false	Names of the fields to be returned
invitee	String	false	URI of the person whose inbound invitations should be returned (default is all)
inviter	String	false	URI of the person whose outbound invitations should be returned (default is all)
startIndex	Integer	false	Zero-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:

Name	Type	Required	Description
count	Integer	false	Maximum number of memberships to be returned (default is 25)
person	String	false	URI of a person whose membership should be returned. Since 3.9
fields	String	false	Names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first membership to be returned
state	String[]	false	List 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:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
fields	String	false	Names 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:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned

Retrieves:

Place describing this place

Resources

Resource	Method	Returns	Description
`avatar`	`GET`	`Object`	↑ Return the binary content of the avatar image for this place.
`html`	`GET`	`Object`	↑ URI of the HTML representation of this place.