5.7.221. Bugzilla::Extension::RuleEngine::WebService::RuleGroup

5.7.221.1. NAME

Bugzilla::Extension::RuleEngine::WebService::RuleGroup - The RuleEngine RuleGroup API

5.7.221.2. DESCRIPTION

This API allows you to list, get, create and update rule groups.

5.7.221.3. METHODS

list

  • Description
Returns information about all the rule groups a user can view.
  • Params
none
  • Returns
Returns rule_groups an array of hashes containing rule groups.

get

  • Description
Returns information about the selected rule groups.
  • Params
  • names
An array of names to get information on.
  • ids
An array of IDs to get information on.
  • Returns
Returns rule_groups an array of hashes containing the selected rule groups.

create

  • Description
Create a new rule group.
  • Params
  • name
string The name of the rule group.
  • description
string The description of the rule group.
  • isactive
boolean True if the rule group is active. False if inactive.
  • user
string The user name to run rules in this rule group as. Must be a valid Bugzilla account.
  • maintainers
array-of-string An array of Bugzilla user names to notify of rule changes and kill switches.
  • view_groups
array-of-string An array of Bugzilla group names who can view rules in this rule group.
  • edit_groups
array-of-string An array of Bugzilla group names who can edit rules in this rule group.
  • Returns
Returns rule_group a hash containing the new rule group.

update

  • Description
Update an existing rule group.
  • Params
  • rule_groups

array-of-hashes An array of hashes, each item containing a separate rule group to edit. Each hash may contain:

  • id optional
int The ID of the rule group. If this is supplied then the name of the rule group can be changed.
  • name optional

string The name of the rule group. If ID is supplied the name will be updated.

Note Either name or id must be supplied.

  • description optional
string The description of the rule group.
  • isactive optional
boolean True if the rule group is active. False if inactive.
  • user optional
string The user name to run rules in this rule group as. Must be a valid Bugzilla account.
  • maintainers optional
array-of-string An array os Bugzilla user names to notify of rule changes and kill switches.
  • view_groups optional
array-of-string An array os Bugzilla group names who can view rules in this rule group.
  • edit_groups optional
array-of-string An array os Bugzilla group names who can edit rules in this rule group.
  • Returns

Returns changes an array of hashes. Each hash describes the changes to one rule group. Only fields that were changed will be returned.

Each field will be returned as an array. Element 0 will be the old value that was replaced. Element 1 will be the new value for that field.

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