Bugzilla::Webservice::Product - The Product API
This part of the Bugzilla API allows you to list the available Products and get information about them.
See Bugzilla::WebService for a description of how parameters are passed, and what STABLE, UNSTABLE, and EXPERIMENTAL mean.
EXPERIMENTAL
Returns a list of the ids of the products the user can search on.
A hash containing one item,
ids,
that contains an array of product ids.
EXPERIMENTAL
Returns a list of the ids of the products the user can enter bugs against.
A hash containing one item,
ids,
that contains an array of product ids.
UNSTABLE
Returns a list of the ids of the products the user can search or enter bugs against.
A hash containing one item,
ids,
that contains an array of product ids.
EXPERIMENTAL
Returns a list of information about the products passed to it.
Note: Can also be called as "get_products" for compatibilty with Bugzilla 3.0 API.
In addition to the parameters below, this method also accepts the standard include_fields and exclude_fields arguments.
idsAn array of product ids
namesAn array of product names
A hash containing one item,
products,
that is an array of hashes.
Each hash describes a product,
and has the following items:
idint An integer id uniquely identifying the product in this installation only.
namestring The name of the product.
This is a unique identifier for the product.
descriptionstring A description of the product,
which may contain HTML.
is_activeboolean A boolean indicating if the product is active.
default_milestonestring The name of the default milestone for the product.
has_unconfirmedboolean Indicates whether the UNCONFIRMED bug status is available for this product.
classificationstring The classification name for the product.
componentsarray An array of hashes,
where each hash describes a component,
and has the following items:
idint An integer id uniquely identifying the component in this installation only.
namestring The name of the component.
This is a unique identifier for this component.
descriptionstring A description of the component,
which may contain HTML.
default_assigned_tostring The login name of the user to whom new bugs will be assigned by default.
default_qa_contactstring The login name of the user who will be set as the QA Contact for new bugs by default.
sort_keyint Components,
when displayed in a list,
are sorted first by this integer and then secondly by their name.
is_activeboolean A boolean indicating if the component is active.
Inactive components are not enabled for new bugs.
versionsarray An array of hashes,
where each hash describes a version,
and has the following items: name,
sort_key and is_active.
milestonesarray An array of hashes,
where each hash describes a milestone,
and has the following items: name,
sort_key and is_active.
Note, that if the user tries to access a product that is not in the list of accessible products for the user, or a product that does not exist, that is silently ignored, and no information about that product is returned.
names was added as an input parameter.classification,
components,
versions,
milestones,
default_milestone and has_unconfirmed were added to the fields returned by get as a replacement for internals,
which has been removed.EXPERIMENTAL
This allows you to create a new product in Bugzilla.
Some params must be set, or an error will be thrown. These params are marked Required.
nameRequired string The name of this product.
Must be globally unique within Bugzilla.
descriptionRequired string A description for this product.
Allows some simple HTML.
versionRequired string The default version for this product.
has_unconfirmedboolean Allow the UNCONFIRMED status to be set on bugs in this product.
Default: true.
classificationstring The name of the Classification which contains this product.
default_milestonestring The default milestone for this product.
Default: '---'.
is_openboolean True if the product is currently allowing bugs to be entered into it.
Default: true.
create_seriesboolean True if you want series for New Charts to be created for this new product.
Default: true.
A hash with one element, id. This is the id of the newly-filed product.
You must specify an existing classification name.
You must specify a non-blank name for this product.
The name specified for this product was longer than the maximum allowed length.
You specified the name of a product that already exists. (Product names must be globally unique in Bugzilla.)
You must specify a description for this product.
You must specify a version for this product.