<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>
Bugzilla::Webservice::Classification</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::Classification</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='#Classification_Retrieval'>Classification Retrieval</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#get'>get</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::Classification - The Classification API</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 deal with the available Classifications.
You will be able to get information about them as well as manipulate 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>
<p>Although the data input and output is the same for JSONRPC,
XMLRPC and REST,
the directions for how to access the data via REST is noted in each method where applicable.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="Classification_Retrieval"
>Classification Retrieval</a></h1>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="get"
>get</a></h2>
<p><b>EXPERIMENTAL</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Returns a hash containing information about a set of classifications.</p>
<dt><a name="REST"
><b>REST</b></a></dt>
<dd>
<p>To return information on a single classification:</p>
<p>GET /rest/classification/<classification_id_or_name></p>
<p>The returned data format will be the same as below.</p>
<dt><a name="Params"
><b>Params</b></a></dt>
<dd>
<p>In addition to the parameters below,
this method also accepts the standard <a href="../../Bugzilla/WebService.html#include_fields" class="podlinkpod"
>include_fields</a> and <a href="../../Bugzilla/WebService.html#exclude_fields" class="podlinkpod"
>exclude_fields</a> arguments.</p>
<p>You could get classifications info by supplying their names and/or ids.
So,
this method accepts the following parameters:</p>
<dl>
<dt><a name="ids"
><code class="code">ids</code></a></dt>
<dd>
<p>An array of classification ids.</p>
<dt><a name="names"
><code class="code">names</code></a></dt>
<dd>
<p>An array of classification names.</p>
</dd>
</dl>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A hash with the key <code class="code">classifications</code> and an array of hashes as the corresponding value.
Each element of the array represents a classification that the user is authorized to see and has the following keys:</p>
<dl>
<dt><a name="id"
><code class="code">id</code></a></dt>
<dd>
<p><code class="code">int</code> The id of the classification.</p>
<dt><a name="name"
><code class="code">name</code></a></dt>
<dd>
<p><code class="code">string</code> The name of the classification.</p>
<dt><a name="description"
><code class="code">description</code></a></dt>
<dd>
<p><code class="code">string</code> The description of the classificaion.</p>
<dt><a name="sort_key"
><code class="code">sort_key</code></a></dt>
<dd>
<p><code class="code">int</code> The value which determines the order the classification is sorted.</p>
<dt><a name="products"
><code class="code">products</code></a></dt>
<dd>
<p>An array of hashes.
The array contains the products the user is authorized to access within the classification.
Each hash has the following keys:</p>
<dl>
<dt><a name="name"
><code class="code">name</code></a></dt>
<dd>
<p><code class="code">string</code> The name of the product.</p>
<dt><a name="id"
><code class="code">id</code></a></dt>
<dd>
<p><code class="code">int</code> The id of the product.</p>
<dt><a name="description"
><code class="code">description</code></a></dt>
<dd>
<p><code class="code">string</code> The description of the product.</p>
</dd>
</dl>
</dd>
</dl>
<dt><a name="Errors"
><b>Errors</b></a></dt>
<dd>
<dl>
<dt><a name="900_(Classification_not_enabled)"
>900 (Classification not enabled)</a></dt>
<dd>
<p>Classification is not enabled on this installation.</p>
</dd>
</dl>
<dt><a name="History"
><b>History</b></a></dt>
<dd>
<dl>
<dt><a name="Added_in_Bugzilla_4.4."
>Added in Bugzilla <b>4.4</b>.</a></dt>
<dd>
<dt><a name="REST_API_call_added_in_Bugzilla_5.0."
>REST API call added in Bugzilla <b>5.0</b>.</a></dt>
</dl>
</dd>
</dl>
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
