5.7.159. Bugzilla::Extension::DependentProducts::WebService¶
5.7.159.1. NAME¶
Bugzilla::Extension::DependentProducts::WebService - The API for managing a products dependent products and contacts
5.7.159.2. DESCRIPTION¶
This API allows you to change the qe, dev and product manager contacts, as well as add and remove products that depend on another product.
5.7.159.3. METHODS¶
- Name
DependentProducts.get
- Description
Returns a list of products that the given product depends on. Also returns the qe, pm and dev manager contacts for the given product.
- Params
idsAn array of product ids.
namesAn array of product names.
- Returns
An array of hashes is returned. Each hash represents one product that was requested.
The arguments to each hash are explained below.
nameThe name of the product you requested
idThe ID of the product you requested.
productsAn array of product names. These products are dependencies of the requested product.
dm_contactsen array of email addresses. Development Manager contact. You must be in the ‘editcomponents’ group to view this.
pm_contactsAn array of email addresses. Product Manager contacts. You must be in the ‘editcomponents’ group to view this.
qe_contactsAn array of email addresses. Quality Engineering Manager contacts. You must be in the ‘editcomponents’ group to view this.
- Name
DependentProducts.update
- Description
Allows the dependent product information to be updated
- Params
Update takes a hash with a single key named ‘products’. this key contains an array of hashes.
The contents of each hash is described below.
idThe ID of the product you are updating. One of id or name must be supplied
nameThe name of the product you are updating. One of id or name must be supplied
pm_contactsProduct Manager email addresses.
A hash containing one or more of the keys ‘add’ ‘remove’ ‘set’. The contents of each are described below.
dm_contactsDevelopment Manager email addresses.
A hash containing one or more of the keys ‘add’ ‘remove’ ‘set’. The contents of each are described below.
qe_contactsQuality Engineering Manager email addresses.
A hash containing one or more of the keys ‘add’ ‘remove’ ‘set’. The contents of each are described below.
addAn array of email addresses. These addresses will be appended to the existing list of contacts
removeAn array of email addresses. These addresses will be removed from the existing list of contacts
setAn array of email addresses. These addresses will replace the exsting list of contacts
depends_onThe products that depend on this product.
A hash containing one or more of the keys ‘add’ ‘remove’ ‘set’. The keys are described below
addA list of product ids or names that will be appended to the existing list of dependencies.
removeA list of product ids or names that will be removed from the existing list of dependencies.
setA list of product ids or names that will replace the existing list of dependencies.
- Returns
Returns an array of hashes describing the changes made to each product.
The contents of each hash is described below
idThe ID of the product that was updated.
nameThe name of the product that was updated.
dm_contactsA hash containing changes to the development manager contacts. The format is described below.
pm_contactsA hash containing changes to the product manager contacts. The format is described below.
qe_contactsA hash containing changes to the QE manager contacts. The format is described below.
addedA list of email addresses that were added to the existing list of contacts.
removedA list of email addresses that was removed from the existing list of contacts.
This documentation undoubtedly has bugs; if you find some, please file them here.