This page gives details of the configuration object returned by the Bugzilla:REST_API, and its sub-objects.
Notes
- The idea is that this object is designed for easy lookup of values, so there are a lot of hashes, keyed by name or ID, instead of arrays over which one would have to iterate.
- This is also why many hashes are keyed by name rather than ID - it's because the name is more likely to be what the API user has. He is, of course, at liberty to transform the data structures to key off something else.
- The use of hashes also gives forwards-compatibility. For example, if some fields became product or component-specific, we could add a "fields" member to the hash.
- Classifications are not wrapped around their products in the same way that products are wrapped around their components because the use of classifications is optional, and this would make the top-level field name depend on whether they were switched on or not.
Configuration
| Name |
Type |
Notes
|
| version |
String |
Bugzilla version
|
| maintainer |
User |
|
| classifications |
Hash of Classification, keyed by name |
Only if useclassifications set
|
| products |
Hash of Product, keyed by name |
|
| groups |
Hash of Group, keyed by name |
|
| flag_types |
Hash of FlagType, keyed by ID |
|
| fields |
Hash of Field, keyed by name |
|
Classification
| Name |
Type |
Notes
|
| id |
Integer |
|
| product |
Array of String |
Product names
|
Product
| Name |
Type |
Notes
|
| id |
Integer |
|
| classification |
String |
Backreference because there is no nesting
|
| component |
Hash of Component, indexed by name |
|
| version |
Array of String |
Version names
|
| target_milestone |
Array of String |
TM names; only if usetargetmilestone set
|
| group |
Array of String |
Group names
|
Component
| Name |
Type |
Notes
|
| id |
Integer |
|
| flag_type |
Array of Integer |
Flag type IDs
|
Group
| Name |
Type |
Notes
|
| id |
Integer |
|
| description |
String |
|
| is_accepting_bugs |
Boolean |
|
| is_active |
Boolean |
|
FlagType
| Name |
Type |
Notes
|
| name |
String |
|
| description |
String |
|
| is_for_bugs |
Boolean |
False means "is for attachments"
|
| is_requestable |
Boolean |
|
| is_specifically_requestable |
Boolean |
|
| is_multiplicable |
Boolean |
|
| request_group |
String |
Group name
|
| grant_group |
String |
Group name
|
Field
| Name |
Type |
Notes
|
| description |
String |
|
| type |
FieldType |
|
| is_on_bug_entry |
Boolean |
|
| values |
Array of String |
Legal values for fields which have fixed set
|
| open |
Array of Status |
'status' field only - open statuses
|
| closed |
Array of Status |
'status' field only - closed statuses
|
FieldType
| Name |
Type |
Notes
|
| id |
Integer |
|
| description |
String |
|
Status
| Name |
Type |
Notes
|
| name |
String |
|
| next_values |
Array of String |
Valid statuses you can transition to next
|