GroupSettings Object
Provides information about the settings for the specified group.
A specific tenant can choose to turn certain features on or off in the platform. For groups, these features are represented by the group settings shown below. For example, in theAkana API Platform, ratings and reviews are supported for groups, but another tenant might choose to allow ratings but not reviews.
In general, group settings are specified for the tenant, and those settings apply to all groups within the tenant. However, in some cases, depending on configuration, it might be possible for group settings to be turned on or off on a per-group basis.
This object is used by the following operations:
- GET /api/groups/{GroupID}/settings
- Operations that reference the Group object
The properties included in the GroupSettings object are listed below.
Property | Type | Description |
---|---|---|
GroupBoardSupport | string | Indicates whether a Board is supported for the group. For a list of possible values, see Group Settings: GroupBoardSupport. |
GroupRatingsSupport | string | Indicates whether ratings are supported for the group. For a list of possible values, see Group Settings: GroupRatingsSupport. |
GroupReviewsSupport | string | Indicates whether reviews are supported for the group. For a list of possible values, see Group Settings: GroupReviewsSupport. |