<!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.5. Bugzilla Information — 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.6. Classifications" href="classification.html" />
<link rel="prev" title="6.1.4. Bug User Last Visited" href="bug-user-last-visit.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="classification.html" title="6.1.6. Classifications"
accesskey="N">next</a></li>
<li class="right" >
<a href="bug-user-last-visit.html" title="6.1.4. Bug User Last Visited"
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="bugzilla-information">
<h1>6.1.5. Bugzilla Information<a class="headerlink" href="#bugzilla-information" title="Permalink to this headline">¶</a></h1>
<p>These methods are used to get general configuration information about this
Bugzilla instance.</p>
<div class="section" id="version">
<h2>6.1.5.1. Version<a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h2>
<p>Returns the current version of Bugzilla. Normally in the format of <code class="docutils literal"><span class="pre">X.X</span></code> or
<code class="docutils literal"><span class="pre">X.X.X</span></code>. For example, <code class="docutils literal"><span class="pre">4.4</span></code> for the initial release of a new branch. Or
<code class="docutils literal"><span class="pre">4.4.6</span></code> for a minor release on the same branch.</p>
<p><strong>Request</strong></p>
<div class="highlight-text"><div class="highlight"><pre><span></span>GET /rest/version
</pre></div>
</div>
<p><strong>Response</strong></p>
<div class="highlight-js"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"version"</span><span class="o">:</span> <span class="s2">"4.5.5+"</span>
<span class="p">}</span>
</pre></div>
</div>
<table border="1" class="docutils">
<colgroup>
<col width="13%" />
<col width="11%" />
<col width="76%" />
</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>version</td>
<td>string</td>
<td>The current version of this Bugzilla</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="extensions">
<h2>6.1.5.2. Extensions<a class="headerlink" href="#extensions" title="Permalink to this headline">¶</a></h2>
<p>Gets information about the extensions that are currently installed and enabled
in this Bugzilla.</p>
<p><strong>Request</strong></p>
<div class="highlight-text"><div class="highlight"><pre><span></span>GET /rest/extensions
</pre></div>
</div>
<p><strong>Response</strong></p>
<div class="highlight-js"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"extensions"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"Voting"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"version"</span><span class="o">:</span> <span class="s2">"4.5.5+"</span>
<span class="p">},</span>
<span class="s2">"BmpConvert"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"version"</span><span class="o">:</span> <span class="s2">"1.0"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<table border="1" class="docutils">
<colgroup>
<col width="15%" />
<col width="9%" />
<col width="76%" />
</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>extensions</td>
<td>object</td>
<td><p class="first">An object containing the extensions enabled as keys.
Each extension object contains the following keys:</p>
<ul class="last simple">
<li><code class="docutils literal"><span class="pre">version</span></code> (string) The version of the extension.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="timezone">
<h2>6.1.5.3. Timezone<a class="headerlink" href="#timezone" title="Permalink to this headline">¶</a></h2>
<p>Returns the timezone in which Bugzilla expects to receive dates and times on the API.
Currently hard-coded to UTC ("+0000"). This is unlikely to change.</p>
<p><strong>Request</strong></p>
<div class="highlight-text"><div class="highlight"><pre><span></span>GET /rest/timezone
</pre></div>
</div>
<div class="highlight-js"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"timezone"</span><span class="o">:</span> <span class="s2">"+0000"</span>
<span class="p">}</span>
</pre></div>
</div>
<p><strong>Response</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="10%" />
<col width="8%" />
<col width="82%" />
</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>timezone</td>
<td>string</td>
<td>The timezone offset as a string in (+/-)XXXX (RFC 2822) format.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="time">
<h2>6.1.5.4. Time<a class="headerlink" href="#time" title="Permalink to this headline">¶</a></h2>
<p>Gets information about what time the Bugzilla server thinks it is, and
what timezone it's running in.</p>
<p><strong>Request</strong></p>
<div class="highlight-text"><div class="highlight"><pre><span></span>GET /rest/time
</pre></div>
</div>
<p><strong>Response</strong></p>
<div class="highlight-js"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"web_time_utc"</span><span class="o">:</span> <span class="s2">"2014-09-26T18:01:30Z"</span><span class="p">,</span>
<span class="s2">"db_time"</span><span class="o">:</span> <span class="s2">"2014-09-26T18:01:30Z"</span><span class="p">,</span>
<span class="s2">"web_time"</span><span class="o">:</span> <span class="s2">"2014-09-26T18:01:30Z"</span><span class="p">,</span>
<span class="s2">"tz_offset"</span><span class="o">:</span> <span class="s2">"+0000"</span><span class="p">,</span>
<span class="s2">"tz_short_name"</span><span class="o">:</span> <span class="s2">"UTC"</span><span class="p">,</span>
<span class="s2">"tz_name"</span><span class="o">:</span> <span class="s2">"UTC"</span>
<span class="p">}</span>
</pre></div>
</div>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="8%" />
<col width="75%" />
</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>db_time</td>
<td>string</td>
<td><p class="first">The current time in UTC, according to the Bugzilla
database server.</p>
<p class="last">Note that Bugzilla assumes that the database and the
webserver are running in the same time zone. However,
if the web server and the database server aren't
synchronized or some reason, <em>this</em> is the time that
you should rely on or doing searches and other input
to the WebService.</p>
</td>
</tr>
<tr class="row-odd"><td>web_time</td>
<td>string</td>
<td><p class="first">This is the current time in UTC, according to
Bugzilla's web server.</p>
<p class="last">This might be different by a second from <code class="docutils literal"><span class="pre">db_time</span></code>
since this comes from a different source. If it's any
more different than a second, then there is likely
some problem with this Bugzilla instance. In this
case you should rely on the <code class="docutils literal"><span class="pre">db_time</span></code>, not the
<code class="docutils literal"><span class="pre">web_time</span></code>.</p>
</td>
</tr>
<tr class="row-even"><td>web_time_utc</td>
<td>string</td>
<td>Identical to <code class="docutils literal"><span class="pre">web_time</span></code>. (Exists only for
backwards-compatibility with versions of Bugzilla
before 3.6.)</td>
</tr>
<tr class="row-odd"><td>tz_name</td>
<td>string</td>
<td>The literal string <code class="docutils literal"><span class="pre">UTC</span></code>. (Exists only for
backwards-compatibility with versions of Bugzilla
before 3.6.)</td>
</tr>
<tr class="row-even"><td>tz_short_name</td>
<td>string</td>
<td>The literal string <code class="docutils literal"><span class="pre">UTC</span></code>. (Exists only for
backwards-compatibility with versions of Bugzilla
before 3.6.)</td>
</tr>
<tr class="row-odd"><td>tz_offset</td>
<td>string</td>
<td>The literal string <code class="docutils literal"><span class="pre">+0000</span></code>. (Exists only for
backwards-compatibility with versions of Bugzilla
before 3.6.)</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="parameters">
<h2>6.1.5.5. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<p>Returns parameter values currently used in this Bugzilla.</p>
<p><strong>Request</strong></p>
<div class="highlight-text"><div class="highlight"><pre><span></span>GET /rest/parameters
</pre></div>
</div>
<p><strong>Response</strong></p>
<p>Example response for anonymous user:</p>
<div class="highlight-js"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"parameters"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"maintainer"</span> <span class="o">:</span> <span class="s2">"admin@example.com"</span><span class="p">,</span>
<span class="s2">"requirelogin"</span> <span class="o">:</span> <span class="s2">"0"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Example response for authenticated user:</p>
<div class="highlight-js"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"parameters"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"allowemailchange"</span> <span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
<span class="s2">"attachment_base"</span> <span class="o">:</span> <span class="s2">"http://bugzilla.example.com/"</span><span class="p">,</span>
<span class="s2">"commentonchange_resolution"</span> <span class="o">:</span> <span class="s2">"0"</span><span class="p">,</span>
<span class="s2">"commentonduplicate"</span> <span class="o">:</span> <span class="s2">"0"</span><span class="p">,</span>
<span class="s2">"cookiepath"</span> <span class="o">:</span> <span class="s2">"/"</span><span class="p">,</span>
<span class="s2">"createemailregexp"</span> <span class="o">:</span> <span class="s2">".*"</span><span class="p">,</span>
<span class="s2">"defaultopsys"</span> <span class="o">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"defaultplatform"</span> <span class="o">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"defaultpriority"</span> <span class="o">:</span> <span class="s2">"--"</span><span class="p">,</span>
<span class="s2">"defaultseverity"</span> <span class="o">:</span> <span class="s2">"normal"</span><span class="p">,</span>
<span class="s2">"duplicate_or_move_bug_status"</span> <span class="o">:</span> <span class="s2">"RESOLVED"</span><span class="p">,</span>
<span class="s2">"emailregexp"</span> <span class="o">:</span> <span class="s2">"^[\\w\\.\\+\\-=']+@[\\w\\.\\-]+\\.[\\w\\-]+$"</span><span class="p">,</span>
<span class="s2">"emailsuffix"</span> <span class="o">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"letsubmitterchoosemilestone"</span> <span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
<span class="s2">"letsubmitterchoosepriority"</span> <span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
<span class="s2">"mailfrom"</span> <span class="o">:</span> <span class="s2">"bugzilla-daemon@example.com"</span><span class="p">,</span>
<span class="s2">"maintainer"</span> <span class="o">:</span> <span class="s2">"admin@example.com"</span><span class="p">,</span>
<span class="s2">"maxattachmentsize"</span> <span class="o">:</span> <span class="s2">"1000"</span><span class="p">,</span>
<span class="s2">"maxlocalattachment"</span> <span class="o">:</span> <span class="s2">"0"</span><span class="p">,</span>
<span class="s2">"musthavemilestoneonaccept"</span> <span class="o">:</span> <span class="s2">"0"</span><span class="p">,</span>
<span class="s2">"noresolveonopenblockers"</span> <span class="o">:</span> <span class="s2">"0"</span><span class="p">,</span>
<span class="s2">"password_complexity"</span> <span class="o">:</span> <span class="s2">"no_constraints"</span><span class="p">,</span>
<span class="s2">"rememberlogin"</span> <span class="o">:</span> <span class="s2">"on"</span><span class="p">,</span>
<span class="s2">"requirelogin"</span> <span class="o">:</span> <span class="s2">"0"</span><span class="p">,</span>
<span class="s2">"urlbase"</span> <span class="o">:</span> <span class="s2">"http://bugzilla.example.com/"</span><span class="p">,</span>
<span class="s2">"use_see_also"</span> <span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
<span class="s2">"useclassification"</span> <span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
<span class="s2">"usemenuforusers"</span> <span class="o">:</span> <span class="s2">"0"</span><span class="p">,</span>
<span class="s2">"useqacontact"</span> <span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
<span class="s2">"usestatuswhiteboard"</span> <span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
<span class="s2">"usetargetmilestone"</span> <span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>A logged-out user can only access the <code class="docutils literal"><span class="pre">maintainer</span></code> and <code class="docutils literal"><span class="pre">requirelogin</span></code>
parameters.</p>
<p>A logged-in user can access the following parameters (listed alphabetically):</p>
<ul class="simple">
<li>allowemailchange</li>
<li>attachment_base</li>
<li>commentonchange_resolution</li>
<li>commentonduplicate</li>
<li>cookiepath</li>
<li>defaultopsys</li>
<li>defaultplatform</li>
<li>defaultpriority</li>
<li>defaultseverity</li>
<li>duplicate_or_move_bug_status</li>
<li>emailregexpdesc</li>
<li>emailsuffix</li>
<li>letsubmitterchoosemilestone</li>
<li>letsubmitterchoosepriority</li>
<li>mailfrom</li>
<li>maintainer</li>
<li>maxattachmentsize</li>
<li>maxlocalattachment</li>
<li>musthavemilestoneonaccept</li>
<li>noresolveonopenblockers</li>
<li>password_complexity</li>
<li>rememberlogin</li>
<li>requirelogin</li>
<li>search_allow_no_criteria</li>
<li>urlbase</li>
<li>use_see_also</li>
<li>useclassification</li>
<li>usemenuforusers</li>
<li>useqacontact</li>
<li>usestatuswhiteboard</li>
<li>usetargetmilestone</li>
</ul>
<p>A user in the tweakparams group can access all existing parameters.
New parameters can appear or obsolete parameters can disappear depending
on the version of Bugzilla and on extensions being installed.
The list of parameters returned by this method is not stable and will
never be stable.</p>
</div>
<div class="section" id="last-audit-time">
<h2>6.1.5.6. Last Audit Time<a class="headerlink" href="#last-audit-time" title="Permalink to this headline">¶</a></h2>
<p>Gets the most recent timestamp among all of the events recorded in the audit_log
table.</p>
<p><strong>Request</strong></p>
<p>To get most recent audit timestamp for all classes:</p>
<div class="highlight-text"><div class="highlight"><pre><span></span>GET /rest/last_audit_time
</pre></div>
</div>
<p>To get the the most recent audit timestamp for the <code class="docutils literal"><span class="pre">Bugzilla::Product</span></code> class:</p>
<div class="highlight-text"><div class="highlight"><pre><span></span>GET /rest/last_audit_time?class=Bugzilla::Product
</pre></div>
</div>
<table border="1" class="docutils">
<colgroup>
<col width="6%" />
<col width="6%" />
<col width="87%" />
</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>class</td>
<td>array</td>
<td>The class names are defined as <code class="docutils literal"><span class="pre">Bugzilla::<class_name>"</span></code> such as
Bugzilla:Product`` for products.</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">"last_audit_time"</span><span class="o">:</span> <span class="s2">"2014-09-23T18:03:38Z"</span>
<span class="p">}</span>
</pre></div>
</div>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="8%" />
<col width="71%" />
</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>last_audit_time</td>
<td>string</td>
<td>The maximum of the at_time from the audit_log.</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.5. Bugzilla Information</a><ul>
<li><a class="reference internal" href="#version">6.1.5.1. Version</a></li>
<li><a class="reference internal" href="#extensions">6.1.5.2. Extensions</a></li>
<li><a class="reference internal" href="#timezone">6.1.5.3. Timezone</a></li>
<li><a class="reference internal" href="#time">6.1.5.4. Time</a></li>
<li><a class="reference internal" href="#parameters">6.1.5.5. Parameters</a></li>
<li><a class="reference internal" href="#last-audit-time">6.1.5.6. Last Audit Time</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="bug-user-last-visit.html"
title="previous chapter">6.1.4. Bug User Last Visited</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="classification.html"
title="next chapter">6.1.6. Classifications</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="classification.html" title="6.1.6. Classifications"
>next</a></li>
<li class="right" >
<a href="bug-user-last-visit.html" title="6.1.4. Bug User Last Visited"
>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>
