Review Group Resource¶

Provides information on review groups.

Review groups are groups of users that can be listed as an intended reviewer on a review request.

Version Changed:: 5.0.6: Added support for ?invite-only and ?show-invisible query arguments for the list resource.

Details¶

Name	`group`
URI	`/api/groups/{group_name}/`
Token Policy ID	`group`
HTTP Methods	DELETE - Deletes a review group. GET - Retrieve information on a review group. PUT - Updates an existing review group.
Parent Resource	Review Group List Resource
Child Resources	Review Group User List Resource

Fields¶

absolute_urlString	The absolute URL to the user’s page on the site. Added in 2.0
display_nameString	The human-readable name of the group, sometimes used as a short description.
extra_dataDictionary	Extra data as part of the review group. This can be set by the API or extensions. Added in 2.0
idInteger	The numeric ID of the review group.
invite_onlyBoolean	Whether or not the group is invite-only. An invite-only group is only accessible by members of the group. Added in 1.6
mailing_listString	The e-mail address that all posts on a review group are sent to.
nameString	The short name of the group, used in the reviewer list and the Dashboard.
urlString	Deprecated The URL to the user’s page on the site. This is deprecated and will be removed in a future version. Deprecated in 2.0
visibleBoolean	Whether or not the group is visible to users who are not members. This does not prevent users from accessing the group if they know it, though. Added in 1.6

Links¶

Name	Method	Resource
delete	DELETE	Review Group Resource
review_group_users	GET	Review Group User List Resource
self	GET	Review Group Resource
update	PUT	Review Group Resource

HTTP DELETE¶

Deletes a review group.

This will disassociate the group from all review requests previously targeting the group, and permanently delete the group.

It is best to only delete empty, unused groups, and to instead change a group to not be visible if it’s on longer needed.

Errors¶

100 - Does Not ExistHTTP 404 - Not Found	Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden	You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized	You are not logged in
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden	Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden	OAuth2 token access for this resource is prohibited.

HTTP GET¶

Retrieve information on a review group.

Some basic information on the review group is provided, including the name, description, and mailing list (if any) that e-mails to the group are sent to.

The group links to the list of users that are members of the group.

Errors¶

100 - Does Not ExistHTTP 404 - Not Found	Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden	You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized	You are not logged in
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden	Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden	OAuth2 token access for this resource is prohibited.

HTTP PUT¶

Updates an existing review group.

All the fields of a review group can be modified, including the name, so long as it doesn’t conflict with another review group.

Extra data can be stored later lookup. See Storing/Accessing Extra Data for more information.

Request Parameters¶

display_nameString	The human-readable name of the group. Added in 1.6.14
invite_onlyBoolean	Whether or not the group is invite-only. Added in 1.6.14
mailing_listString	The e-mail address that all posts on a review group are sent to. Added in 1.6.14
nameString	The new name for the group. Added in 1.6.14
visibleBoolean	Whether or not the group is visible to users who are not members. Added in 1.6.14

Errors¶

100 - Does Not ExistHTTP 404 - Not Found	Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden	You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized	You are not logged in
105 - Invalid Form DataHTTP 400 - Bad Request	One or more fields had errors
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden	Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden	OAuth2 token access for this resource is prohibited.
223 - Group Already ExistsHTTP 409 - Conflict	A group with this name already exists.

Examples¶

application/vnd.reviewboard.org.review-group+json¶

$ curl https://reviews.example.com/api/groups/devgroup/ -H "Accept: application/json"

HTTP 200 OK
Content-Length: 658
Content-Type: application/vnd.reviewboard.org.review-group+json
ETag: 8a2483ce21a280a6ffa0dd9870d7f2a399d666c1
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "group": {
    "absolute_url": "https://reviews.example.com/groups/devgroup/",
    "display_name": "Dev Group",
    "extra_data": {},
    "id": 1,
    "invite_only": false,
    "links": {
      "delete": {
        "href": "https://reviews.example.com/api/groups/devgroup/",
        "method": "DELETE"
      },
      "review_group_users": {
        "href": "https://reviews.example.com/api/groups/devgroup/users/",
        "method": "GET"
      },
      "self": {
        "href": "https://reviews.example.com/api/groups/devgroup/",
        "method": "GET"
      },
      "update": {
        "href": "https://reviews.example.com/api/groups/devgroup/",
        "method": "PUT"
      }
    },
    "mailing_list": "devgroup@example.com",
    "name": "devgroup",
    "url": "/groups/devgroup/",
    "visible": true
  },
  "stat": "ok"
}