5.7.247. Bugzilla::Extension::Workflows::WebService::GroupReview

5.7.247.1. NAME

Bugzilla::Extension::Workflows::WebService::GroupReview

5.7.247.2. DESCRIPTION

This part of the Bugzilla API allows you to manages group membership reviews.

5.7.247.3. METHODS

get_group

Lists direct members in a group.

You will need to have Bless privileges on the group named to be able to perform this action.

Users in the admin group will not be listed.

Users who are in the insiders group will only be listed for users who are also in the insiders group.

Params

group:
string The name of the group to fetch.
min_days:
int optional The minimum numbers of days since the user last logged in. Users who have logged in more recently than this will not be listed.

Returns

Returns an array named members containing hashes, one per member, with the following fields:

days_since_login:
The number of days since the user last logged in.
id:
The users unique ID.
login:
The users login mail address.
review_days:
The number of days the users review bug has been open.
review_id:
The bug id of a review for this user in this group.

Examples

JSONRPC call
{
    "jsonrpc": "2.0",
    "method": "GroupReview.get_group",
    "id": 1,
    "params": [
      {
        "name": "thegroup",
        "min_days": 21
      }
    ]
}
JSONRPC reply
{
    "id": 1,
    "error": null,
    "result": {
        "members": [
          {
            "days_since_login": 138,
            "id": 11,
            "login": "user1@example.com"
            "review_days": "",
            "review_id": "",
          }, {
            "days_since_login": 63
            "id": 22,
            "login": "user42@example.com",
            "review_days": "31",
            "review_id": "123456",
          }
        ]
    }
}

start_reviews

Start the group reviews for users.

You will need to have Bless privileges on the group named to be able to perform this action.

Users in the admin group will not be processed by this API and will be silently discarded from the user list.

Users who are in the insiders group can only be processed by users who are also in the insiders group. Insiders supplied by outsiders will be silently discarded from the user list.

Params

group:
string The name of the group to process.
ids:
array of int The IDs of the users to review. User IDs that are not current members of the group will be ignored.

Returns

Returns an array named members containing hashes, one for each member updated, with the following fields:

days_since_login:
The number of days since the user last logged in.
id:
The users unique ID.
login:
The users login mail address.
review_days:
The number of days the users review bug has been open.
review_id:
The bug id of a review for this user in this group.

Examples

JSONRPC call
{
    "jsonrpc": "2.0",
    "method": "GroupReview.start_reviews",
    "id": 1,
    "params": [
      {
        "name": "thegroup",
        "ids": [ 11, 22, 42 ]
      }
    ]
}
JSONRPC reply
{
    "id": 1,
    "error": null,
    "result": {
        "members": [
          {
            "days_since_login": 138,
            "id": 11,
            "login": "user11@example.com"
            "review_days": "0",
            "review_id": "123457",
          }, {
            "days_since_login": 63
            "id": 22,
            "login": "user22@example.com",
            "review_days": "31",
            "review_id": "123456",
          }, {
            "days_since_login": 11
            "id": 42,
            "login": "user42@example.com",
            "review_days": "0",
            "review_id": "123458",
          }
        ]
    }
}

This documentation undoubtedly has bugs; if you find some, please file them here.