Bugzilla:BzAPI:Objects
This page lists the field names for the Bugzilla:REST_API, along with their types, descriptions, and any names those fields may have in other contexts.
Notes
- Fields marked Read Only are set automatically by Bugzilla, based on other information or fields. They may be returned by GET calls, but will be ignored in POST or PUT.
- Fields marked No Mod can be set when the object is created, but are Read Only thereafter.
- Fields marked Optional may be missing entirely. Other fields are guaranteed to be present but may be blank. XXX_make_it_so.
- For fields of type Boolean, "0", 0 and "" are false; everything else is true.
- Fields of type Timestamp are in YYYY-MM-DD HH:MM:SS format.
- Field values are configurable, so examples may not apply to your Bugzilla.
- Set assigned_to or qa_contact to the special value undef to reset them to the default for the current component. XXX_unimplemented
Bug
| Name | Type | Description | Other Names |
|---|---|---|---|
| assigned_to | User | User responsible for the bug | |
| attachment | Array of Attachment | Related files | |
| blocks | Array of Integer | IDs of bugs which can only be fixed after this one XXX_refs? | |
| cc | Array of String XXX_User | Email addresses of CCed users | |
| cclist_accessible XXX_cc_accessible? | Boolean | Whether CC list can see bug, regardless of groups | |
| classification_id | Integer, Read Only | ID of classification (categorization above product) XXX_why_this_and_not_prod_or_comp? | |
| classification | String | Name of classification (categorization above product) | |
| comment | Array of Comment | Things people have said about the bug | long_desc |
| component | String | Bug's component (sub-product) | |
| creation_time | Timestamp String, Read Only | When bug was filed | creation_ts, opendate |
| dependson XXX_underscore? | Array of Integer | Bugs that must be fixed first XXX_refs? | |
| everconfirmed XXX_underscore? | Boolean, Read Only | Whether bug has ever passed from UNCONFIRMED to CONFIRMED status | |
| id | Integer, Read Only | Unique reference for bug | bug_id |
| keyword | Array of String | Tags (from a limited set) describing the bug | |
| last_change_time | Timestamp String, Read Only | Last change | delta_ts, changeddate |
| op_sys | String | Operating system bug was seen on, e.g. Windows Vista, Linux | |
| platform | String | Computing platform bug was seen on, e.g. PC, Mac | rep_platform |
| priority | String | How important the bug is, e.g. P1, P5 | |
| product | String | Name of product | |
| qa_contact | User | User responsible for checking bug is fixed | |
| ref | String, Read Only | URL of bug in API | |
| reporter_accessible | Boolean | Whether reporter can see bug, regardless of groups | |
| reporter | User, Read Only | User who submitted the bug | |
| see_also | Array of String | URLs of related bugs | |
| severity | String | How severe the bug is, e.g. enhancement, critical | bug_severity |
| status | String | Current status, e.g. NEW, RESOLVED | bug_status |
| summary | String | Short sentence describing the bug | short_desc |
| target_milestone | String | When the bug is going to be fixed | |
| url | String | URL relating to the bug | bug_file_loc |
| version | String | Version of software in which bug is seen | |
| whiteboard | String | Notes on current status | status_whiteboard |
XXX flags, groups
Comment
| Name | Type | Description | Other Names |
|---|---|---|---|
| author | User, Read Only | User who wrote the comment | |
| bug_id | Integer, Read Only | ID of bug to which this is an attachment | |
| bug_ref | String, Read Only | URL of associated bug in API | |
| id | Integer, Read Only | Unique identifier of comment in Bugzilla | |
| is_private | Boolean | Whether comment is private | |
| text | String, No Mod | Text of comment (plain text) | |
| time | Timestamp String, Read Only | Time comment was added |
User
| Name | Type | Description | Other Names |
|---|---|---|---|
| name | String | Email address of user XXX_not_always_true? | assignee, reporter, qa_contact (as flat fields) |
| real_name | String, Read Only, Optional | User's real name | name, assignee_realname etc. |
| ref | String, Read Only | URL of user in API |
Attachment
| Name | Type | Description | Other Names |
|---|---|---|---|
| attacher | User, Read Only | User who created attachment | |
| bug_id | Integer, Read Only | ID if bug to which this is an attachment XXX_unimplemented | |
| bug_ref | String, Read Only | URL of associated bug in API XXX_unimplemented | |
| data | AttachmentData | File data | |
| description | String | Text describing the attachment | |
| filename | String | Path-less filename of attachment | |
| id | Integer, Read Only | Unique reference for attachment | attach_id |
| is_obsolete | Boolean | Whether file is marked obsolete | isobsolete |
| is_patch | Boolean | Whether bug is a patch | ispatch |
| is_private | Boolean | Whether bug is private | isprivate |
| ref | String, Read Only | URL of attachment in API | |
| size | Integer | Size of attachment, in bytes | |
| type | String | MIME type of attachment | |
| when | Timestamp String, Read Only | When attachment was submitted |
AttachmentData
| Name | Type | Description | Other Names |
|---|---|---|---|
| encoding | String, Read Only | Encoding of 'content'; 'base64' is only supported value | |
| content | String, Read Only | Attachment data encoded using named method |