<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>6.1.8. Components — Bugzilla 5.0.4 documentation</title>
<link rel="stylesheet" href="../../../_static/bugzilla.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '5.0.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="6.1.9. Bug Fields" href="field.html" />
<link rel="prev" title="6.1.7. Comments" href="comment.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="field.html" title="6.1.9. Bug Fields"
accesskey="N">next</a></li>
<li class="right" >
<a href="comment.html" title="6.1.7. Comments"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">Bugzilla 5.0.4 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >6. WebService API Reference</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">6.1. Core API v1</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="components">
<h1>6.1.8. Components<a class="headerlink" href="#components" title="Permalink to this headline">¶</a></h1>
<p>This part of the Bugzilla API allows you to deal with the available product
components. You will be able to get information about them as well as manipulate
them.</p>
<div class="section" id="create-component">
<h2>6.1.8.1. Create Component<a class="headerlink" href="#create-component" title="Permalink to this headline">¶</a></h2>
<p>This allows you to create a new component in Bugzilla. You must be authenticated
and be in the <em>editcomponents</em> group to perform this action.</p>
<p><strong>Request</strong></p>
<p>To create a new component:</p>
<div class="highlight-text"><div class="highlight"><pre><span></span>POST /rest/component
</pre></div>
</div>
<div class="highlight-js"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"product"</span> <span class="o">:</span> <span class="s2">"TestProduct"</span><span class="p">,</span>
<span class="s2">"name"</span> <span class="o">:</span> <span class="s2">"New Component"</span><span class="p">,</span>
<span class="s2">"description"</span> <span class="o">:</span> <span class="s2">"This is a new component"</span><span class="p">,</span>
<span class="s2">"default_assignee"</span> <span class="o">:</span> <span class="s2">"dkl@mozilla.com"</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Some params must be set, or an error will be thrown. These params are
shown in <strong>bold</strong>.</p>
<table border="1" class="docutils">
<colgroup>
<col width="26%" />
<col width="9%" />
<col width="65%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">name</th>
<th class="head">type</th>
<th class="head">description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><strong>name</strong></td>
<td>string</td>
<td>The name of the new component.</td>
</tr>
<tr class="row-odd"><td><strong>product</strong></td>
<td>string</td>
<td>The name of the product that the component must
be added to. This product must already exist, and
the user have the necessary permissions to edit
components for it.</td>
</tr>
<tr class="row-even"><td><strong>description</strong></td>
<td>string</td>
<td>The description of the new component.</td>
</tr>
<tr class="row-odd"><td><strong>default_assignee</strong></td>
<td>string</td>
<td>The login name of the default assignee of the
component.</td>
</tr>
<tr class="row-even"><td>default_cc</td>
<td>array</td>
<td>Each string representing one login name of the
default CC list.</td>
</tr>
<tr class="row-odd"><td>default_qa_contact</td>
<td>string</td>
<td>The login name of the default QA contact for the
component.</td>
</tr>
<tr class="row-even"><td>is_open</td>
<td>boolean</td>
<td>1 if you want to enable the component for bug
creations. 0 otherwise. Default is 1.</td>
</tr>
</tbody>
</table>
<p><strong>Response</strong></p>
<div class="highlight-js"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">27</span>
<span class="p">}</span>
</pre></div>
</div>
<table border="1" class="docutils">
<colgroup>
<col width="8%" />
<col width="8%" />
<col width="83%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">name</th>
<th class="head">type</th>
<th class="head">description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>id</td>
<td>int</td>
<td>The ID of the newly-added component.</td>
</tr>
</tbody>
</table>
<hr class="docutils" />
<p>This documentation undoubtedly has bugs; if you find some, please file
them <a class="reference external" href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation">here</a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../index.html">
<img class="logo" src="../../../_static/bugzilla.png" alt="Logo"/>
</a></p>
<h3><a href="../../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">6.1.8. Components</a><ul>
<li><a class="reference internal" href="#create-component">6.1.8.1. Create Component</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="comment.html"
title="previous chapter">6.1.7. Comments</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="field.html"
title="next chapter">6.1.9. Bug Fields</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="field.html" title="6.1.9. Bug Fields"
>next</a></li>
<li class="right" >
<a href="comment.html" title="6.1.7. Comments"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">Bugzilla 5.0.4 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >6. WebService API Reference</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" >6.1. Core API v1</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
</div>
</body>
</html>
