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 /members service. The following types are related to Groups:

Examples:

Example JSON

JSON including important fields and a Group's resources. See the tables below for a list of all fields and resources.

 {
   "type" : "group",
   "name" : "Product Feature Requests",
   "displayName" : "product-feature-requests",
   "description" : "",
   "status" : "Active",
   "groupType" : "OPEN",
   "contentTypes" : [ "blog", "documents", "files", "discussions", "projects" ],
   "visibleToExternalContributors" : 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" ],
   "id" : "1047",
   "resources" : {
     "contents" : {
       "ref" : "https://example.jiveon.com/api/core/v3/contents?filter=place(https://example.jiveon.com/api/core/v3/places/1453)",
       "allowed" : [ "GET" ]
     },
     "announcements" : {
       "ref" : "https://example.jiveon.com/api/core/v3/places/1453/announcements",
       "allowed" : [ "POST", "GET" ]
     },
     "self" : {
       "ref" : "https://example.jiveon.com/api/core/v3/places/1453",
       "allowed" : [ "DELETE", "PUT", "GET" ]
     },
     "html" : {
       "ref" : "https://example.jiveon.com/groups/group1341876961250",
       "allowed" : [ "GET" ]
     },
     "categories" : {
       "ref" : "https://example.jiveon.com/api/core/v3/places/1453/categories",
       "allowed" : [ "POST", "GET" ]
     },
     "places" : {
       "ref" : "https://example.jiveon.com/api/core/v3/places/1453/places",
       "allowed" : [ "GET" ]
     },
     "followingIn" : {
       "ref" : "https://example.jiveon.com/api/core/v3/places/1453/followingIn",
       "allowed" : [ "GET" ]
     },
     "avatar" : {
       "ref" : "https://example.jiveon.com/api/core/v3/places/1453/avatar",
       "allowed" : [ "DELETE", "POST", "GET" ]
     },
     "members" : {
       "ref" : "https://example.jiveon.com/api/core/v3/members/places/1453",
       "allowed" : [ "POST", "GET" ]
     },
     "activity" : {
       "ref" : "https://example.jiveon.com/api/core/v3/places/1453/activities",
       "allowed" : [ "GET" ]
     },
     "statics" : {
       "ref" : "https://example.jiveon.com/api/core/v3/places/1453/statics",
       "allowed" : [ "POST", "GET" ]
     }
   }
 }

Create a Group

POST to /places creates a new group if the "type" field is set to "group". Note that the "displayName" field is the name that will appear in the resources.html.ref URL (the URL seen when viewing in a browser). The minimum set of fields you must include are:

  {
    "type":"group",
    "displayName":"group123",
    "name":"My new group!",
    "groupType":"OPEN"
  }

Fields

Field	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`, and so on), plus `projects` (if projects are allowed in this place) 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.
`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: TODO
`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).
`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.
`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.
`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.
`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.
`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").
`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.

Resources

Resource	Method	Description
`activity`	`GET`	Return a paginated list of activities that have occurred within this place. Retrieves: Activity[]
`announcements`	`POST`	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": " Some interesting text " }, "subject": "Free beer for everyone" } Takes: Announcement describing the new announcement Retrieves: Announcement describing the new announcement
`announcements`	`GET`	Return a paginated list of announcements for this place. Retrieves: Announcement[]
`avatar`	`GET`	Return the binary content of the avatar image for this place.
`avatar`	`POST`	Register a new avatar image (or replace an existing one) for this place. The image will be downloaded and scaled as necessary.
`avatar`	`DELETE`	Delete the existing avatar image for this place.
`blog`	`GET`	Return the blog associated with this place. Retrieves: Blog
`categories`	`GET`	Return the categories associated with this place. Retrieves: Category[]
`categories`	`POST`	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 Retrieves: Category describing the new category
`contents`	`GET`	Return the first page of a paginated list of contents that are contained in this place.
`followers`	`GET`	Return a paginated list of the people following this place. Retrieves: Person[] Since: 3.5
`followingIn`	`GET`	Return the custom streams (if any) in which the requesting person is following this place. Retrieves: Stream[]
`html`	`GET`	URI of the HTML representation of this place.
`invites`	`GET`	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.
`invites`	`POST`	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" }
`members`	`POST`	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 Retrieves: Member representing the new member
`members`	`GET`	Return a paginated list of group members. Retrieves: Member[]
`places`	`GET`	Return the list of child places in this place. Retrieves: Place[]
`self`	`GET`	Return an updated version of this place. Retrieves: Place describing this place
`self`	`PUT`	Update the information about this place and return an updated entity. Retrieves: Place describing this place
`self`	`DELETE`	Delete this place and any related content.
`statics`	`POST`	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. Retrieves: Static describing the new static resource Since: 3.1
`statics`	`GET`	Return the list of static resources associated with this place. Retrieves: Static[]

Group

Examples:

Example JSON

Fields

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Resources

Retrieves:

Takes:

Retrieves:

Retrieves:

Retrieves:

Retrieves:

Takes:

Retrieves:

Retrieves:

Since: 3.5

Retrieves:

Takes:

Retrieves:

Retrieves:

Retrieves:

Retrieves:

Retrieves:

Retrieves:

Since: 3.1

Retrieves: