5.7.175. Bugzilla::Extension::ListOfBugs::WebService¶
5.7.175.1. NAME¶
Bugzilla::Extension::WebService::ListOfBugs - The API for creating, changing and getting lists of bugs.
5.7.175.2. DESCRIPTION¶
A List of bugs is a saved, static list of bug numbers. This allows you to save a snapshot of bug numbers and present it to other users as a fixed list of bugs that can only be changed manually.
5.7.175.3. METHODS¶
See Bugzilla::WebService for a description of how parameters are passed, and what STABLE, UNSTABLE and EXPERIMENTAL mean.
create¶
- Description
Create a bug list.
- Params
name
string
The name of this list. Must be unique
description
string
A description of this list.
bugs
array
array of bug ids that will be used when running the list search
view_groups
array
An array of group names to restrict visiblity of this search to members of the named groupsIf no view groups are supplied, the list will be public.
edit_groups
array
An array of group names to restrict editing of this search to members of the named groupsIf no edit groups are supplied, only the creator of the list may edit the list.
- Returns
id
- intThe ID of the newly created bug list
name
- stringThe name of the newly created bug list
get¶
- Description
Get the list of bugs associated with this bug list, along with other information.
- Params
You can pass either a list of ids, or names
ids
(array) - an array of integer list ids.names
(array) - an array of string list names.
- Returns
id
The ID of this list.name
The name of this list.description
A description of this list.owner
The user that owns this list.updated
The time that this list was created or last modified.lastused
The time that this list was last used as a search.bugs
An array of bug ids
update¶
- Description
Add or remove bugs in the buglist, or change the ownership or visibility of the list.
- Params
ids
array
An array of bug list ids to be updated.
names
array
An array of bug list names to be updated.
owner
string
Change the owner of the list to the supplied email address.
description
string
Change the description to the supplied string.
bugs
Update the list of bugs. A hash containing one or more of the following keys - add, remove, set.
add
array
The listed bug ids will be added to the bug list.
remove
array
The listed bug ids will be removed from the bug list.
set
array
The current list will be removed and replaced with the new bug list.
view_groups
These groups control the visibility of the bug list. A list with no view groups is a public list.
A hash containing one or more of the following keys - add, remove, set.
add
array
The listed group names will be added to the view group list.
remove
array
The listed group names will be removed from the view group list.
set
array
The current view groups will be removed and replaced with the new view groups.
edit_groups
These groups control the editability of the group list. A list with no edit groups may only be edited by the owner of the list.
A hash containing one or more of the following keys - add, remove, set.
add
array
The listed group names will be added to the edit group list.
remove
array
The listed group names will be removed from the edit group list.
set
array
The current view groups will be removed and replaced with the new edit groups.
list¶
- Description
Returns a list of all bug lists that you have permission to view.
- Returns
Returns an array of hashes. Each hash contains the following keys:
id
int
An integer id identifying this bug list
name
string
A the name of this list
owner
string
The owner of this search
description
string
A description of this search
This documentation undoubtedly has bugs; if you find some, please file them here.