Bugzilla::Webservice::Product

NAME
DESCRIPTION
METHODS
List Products
Product Creation
- create

NAME

Bugzilla::Webservice::Product - The Product API

DESCRIPTION

This part of the Bugzilla API allows you to list the available Products and get information about them.

METHODS

See Bugzilla::WebService for a description of how parameters are passed, and what STABLE, UNSTABLE, and EXPERIMENTAL mean.

List Products

get_selectable_products

EXPERIMENTAL

Description: Returns a list of the ids of the products the user can search on.
Params (none)
Returns: A hash containing one item, ids, that contains an array of product ids.
Errors (none)

get_enterable_products

EXPERIMENTAL

Description: Returns a list of the ids of the products the user can enter bugs against.
Params (none)
Returns: A hash containing one item, ids, that contains an array of product ids.
Errors (none)

get_accessible_products

UNSTABLE

Description: Returns a list of the ids of the products the user can search or enter bugs against.
Params (none)
Returns: A hash containing one item, ids, that contains an array of product ids.
Errors (none)

get

EXPERIMENTAL

Description

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.

Params

A hash containing one item, ids, that is an array of product ids.

Returns

A hash containing one item, products, that is an array of hashes. Each hash describes a product, and has the following items: id, name, description, and internals. The id item is the id of the product. The name item is the name of the product. The description is the description of the product. Finally, the internals is an internal representation of the product.

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.

Errors (none)

Product Creation

create

EXPERIMENTAL

Description

This allows you to create a new product in Bugzilla.

Params

Some params must be set, or an error will be thrown. These params are marked Required.

name: Required string The name of this product. Must be globally unique within Bugzilla.
description: Required string A description for this product. Allows some simple HTML.
version: Required string The default version for this product.
has_unconfirmed: boolean Allow the UNCONFIRMED status to be set on bugs in this product.
classification: boolean The name of the Classification wich contains this product.
default_milestone: boolean The default milestone for this product.
is_open: boolean True if the product is currently allowing bugs to be entered into it.
create_series: boolean True if you want series for New Charts to be created for this new product.

Returns

A hash with one element, id. This is the id of the newly-filed product.

Errors

700 (Product blank name): You must specify a non-blank name for this product.
701 (Product name too long): The name specified for this product was longer than the maximum allowed length.
702 (Product name already exists): You specified the name of a product that already exists. (Product names must be globally unique in Bugzilla.)
703 (Product must have description): You must specify a description for this product.
704 (Product must have version): You must specify a version for this product.
705 (Product must define a defaut milestone): You must define a default milestone.