<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>
Bugzilla::Webservice::Group</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" title="style" type="text/css" href="../.././../../../style.css" media="all" >
</head>
<body id="pod">
<p class="backlinktop"><b><a name="___top" href="../../index.html" accesskey="1" title="All Documents"><<</a></b></p>
<h1>Bugzilla::Webservice::Group</h1>
<div class='indexgroup'>
<ul class='indexList indexList1'>
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
<li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
<li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a>
<li class='indexItem indexItem1'><a href='#Group_Creation_and_Modification'>Group Creation and Modification</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#create'>create</a>
<li class='indexItem indexItem2'><a href='#update'>update</a>
</ul>
</ul>
</div>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>Bugzilla::Webservice::Group - The API for creating,
changing,
and getting information about Groups.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>This part of the Bugzilla API allows you to create Groups and get information about them.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="METHODS"
>METHODS</a></h1>
<p>See <a href="../../Bugzilla/WebService.html" class="podlinkpod"
>Bugzilla::WebService</a> for a description of how parameters are passed,
and what <b>STABLE</b>,
<b>UNSTABLE</b>,
and <b>EXPERIMENTAL</b> mean.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="Group_Creation_and_Modification"
>Group Creation and Modification</a></h1>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="create"
>create</a></h2>
<p><b>UNSTABLE</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>This allows you to create a new group in Bugzilla.</p>
<dt><a name="Params"
><b>Params</b></a></dt>
<dd>
<p>Some params must be set,
or an error will be thrown.
These params are marked <b>Required</b>.</p>
<dl>
<dt><a name="name"
><code class="code">name</code></a></dt>
<dd>
<p><b>Required</b> <code class="code">string</code> A short name for this group.
Must be unique.
This is not usually displayed in the user interface,
except in a few places.</p>
<dt><a name="description"
><code class="code">description</code></a></dt>
<dd>
<p><b>Required</b> <code class="code">string</code> A human-readable name for this group.
Should be relatively short.
This is what will normally appear in the UI as the name of the group.</p>
<dt><a name="user_regexp"
><code class="code">user_regexp</code></a></dt>
<dd>
<p><code class="code">string</code> A regular expression.
Any user whose Bugzilla username matches this regular expression will automatically be granted membership in this group.</p>
<dt><a name="is_active"
><code class="code">is_active</code></a></dt>
<dd>
<p><code class="code">boolean</code> <code class="code">True</code> if new group can be used for bugs,
<code class="code">False</code> if this is a group that will only contain users and no bugs will be restricted to it.</p>
<dt><a name="icon_url"
><code class="code">icon_url</code></a></dt>
<dd>
<p><code class="code">string</code> A URL pointing to a small icon used to identify the group.
This icon will show up next to users' names in various parts of Bugzilla if they are in this group.</p>
</dd>
</dl>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A hash with one element,
<code class="code">id</code>.
This is the id of the newly-created group.</p>
<dt><a name="Errors"
><b>Errors</b></a></dt>
<dd>
<dl>
<dt><a name="800_(Empty_Group_Name)"
>800 (Empty Group Name)</a></dt>
<dd>
<p>You must specify a value for the <code class="code">name</code> field.</p>
<dt><a name="801_(Group_Exists)"
>801 (Group Exists)</a></dt>
<dd>
<p>There is already another group with the same <code class="code">name</code>.</p>
<dt><a name="802_(Group_Missing_Description)"
>802 (Group Missing Description)</a></dt>
<dd>
<p>You must specify a value for the <code class="code">description</code> field.</p>
<dt><a name="803_(Group_Regexp_Invalid)"
>803 (Group Regexp Invalid)</a></dt>
<dd>
<p>You specified an invalid regular expression in the <code class="code">user_regexp</code> field.</p>
</dd>
</dl>
</dd>
</dl>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="update"
>update</a></h2>
<p><b>UNSTABLE</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>This allows you to update a group in Bugzilla.</p>
<dt><a name="Params"
><b>Params</b></a></dt>
<dd>
<p>At least <code class="code">ids</code> or <code class="code">names</code> must be set,
or an error will be thrown.</p>
<dl>
<dt><a name="ids"
><code class="code">ids</code></a></dt>
<dd>
<p><b>Required</b> <code class="code">array</code> Contain ids of groups to update.</p>
<dt><a name="names"
><code class="code">names</code></a></dt>
<dd>
<p><b>Required</b> <code class="code">array</code> Contain names of groups to update.</p>
<dt><a name="name"
><code class="code">name</code></a></dt>
<dd>
<p><code class="code">string</code> A new name for group.</p>
<dt><a name="description"
><code class="code">description</code></a></dt>
<dd>
<p><code class="code">string</code> A new description for groups.
This is what will appear in the UI as the name of the groups.</p>
<dt><a name="user_regexp"
><code class="code">user_regexp</code></a></dt>
<dd>
<p><code class="code">string</code> A new regular expression for email.
Will automatically grant membership to these groups to anyone with an email address that matches this perl regular expression.</p>
<dt><a name="is_active"
><code class="code">is_active</code></a></dt>
<dd>
<p><code class="code">boolean</code> Set if groups are active and eligible to be used for bugs.
True if bugs can be restricted to this group,
false otherwise.</p>
<dt><a name="icon_url"
><code class="code">icon_url</code></a></dt>
<dd>
<p><code class="code">string</code> A URL pointing to an icon that will appear next to the name of users who are in this group.</p>
</dd>
</dl>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A <code class="code">hash</code> with a single field "groups".
This points to an array of hashes with the following fields:</p>
<dl>
<dt><a name="id"
><code class="code">id</code></a></dt>
<dd>
<p><code class="code">int</code> The id of the group that was updated.</p>
<dt><a name="changes"
><code class="code">changes</code></a></dt>
<dd>
<p><code class="code">hash</code> The changes that were actually done on this group.
The keys are the names of the fields that were changed,
and the values are a hash with two keys:</p>
<dl>
<dt><a name="added"
><code class="code">added</code></a></dt>
<dd>
<p><code class="code">string</code> The values that were added to this field,
possibly a comma-and-space-separated list if multiple values were added.</p>
<dt><a name="removed"
><code class="code">removed</code></a></dt>
<dd>
<p><code class="code">string</code> The values that were removed from this field,
possibly a comma-and-space-separated list if multiple values were removed.</p>
</dd>
</dl>
</dd>
</dl>
<dt><a name="Errors"
><b>Errors</b></a></dt>
<dd>
<p>The same as <a href="#create" class="podlinkpod"
>"create"</a>.</p>
</dd>
</dl>
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
