This page lists the objects used on the Bugzilla:REST_API, and the fields of each, 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, on submit, "0", 0 and "" are false; everything else is true. XXX_test_this
- Fields of type Timestamp are in an ISO 8601 format - either YYYY-MM-DD HH:MM:SS or YYYYMMDDTHH:MM:SS (T being a literal "T"). XXXtimezone?
Bug
| Name |
Type |
Description |
Other Names
|
| actual_time |
Decimal, Read Only |
Time it has taken to fix the bug so far |
|
| alias |
String |
Bug's alias (text alternative to ID) |
|
| assigned_to |
User |
User responsible for the bug |
|
| attachment XXX_attachments |
Array of Attachment |
Related files stored by Bugzilla |
|
| blocks |
Array of Integer |
IDs of bugs which can only be fixed after this one |
|
| cc |
Array of User |
Users signed up to be notified of changes |
|
| cc_accessible XXXname? |
Boolean |
Whether CC list can see bug, regardless of groups |
|
| classification |
String |
Name of classification (categorization above product) |
|
| comments |
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
|
| deadline |
Datestamp String |
Date by which bug must be fixed |
|
| depends_on |
Array of Integer |
Bugs that must be fixed first |
|
| estimated_time |
Decimal |
Current estimated time for fix, in hours |
|
| ever_confirmed XXXname? |
Boolean, Read Only |
Whether bug has ever passed from UNCONFIRMED to CONFIRMED status |
|
| flag XXXflags |
Array of Flag |
Flags set on this bug (XXXnote: not all possible flags) |
|
| history |
Array of ChangeSet |
Changes made to bug fields in the past |
|
| id |
Integer, Read Only |
Unique reference for bug |
bug_id
|
| keywords |
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 |
|
| remaining_time |
Decimal, Read Only |
Hours left before fix will be done |
|
| reporter |
User, Read Only |
User who submitted the bug |
|
| reporter_accessible XXXname? |
Boolean |
Whether reporter can see bug, regardless of groups |
|
| 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 |
|
| token |
String, Read Only |
Token you'll need to submit to change the bug |
|
| 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
|
| work_time |
Decimal (Submit Only) |
Hours to be added to actual_time |
|
XXX_TODO_TOTEST groups, work_time
Notes
- Field values are configurable, so examples may not apply to your Bugzilla.
- Set assigned_to or qa_contact to the special value null (in JSON) to reset them to the default for the current component.
| Name |
Type |
Description |
Other Names
|
| author |
User, Read Only |
User who wrote the comment |
|
| creation_time |
Timestamp String, Read Only |
Time comment was added |
|
| 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) |
|
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 |
|
| creation_time |
Timestamp String, Read Only |
When attachment was submitted |
|
| data |
AttachmentData, No Mod |
File data |
|
| description |
String |
Text describing the attachment |
|
| filename XXXfile_name |
String |
Path-less filename of attachment |
|
| flag |
Array of Flag |
Flags set on this attachment (XXXnote: not all possible flags) |
|
| 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 |
|
| token |
String |
Token to submit to change attachment metadata |
|
| type XXXcontent_type |
String |
MIME type of attachment |
|
AttachmentData
| Name |
Type |
Description |
Other Names
|
| encoding |
String, No Mod |
Encoding of 'content'; 'base64' is only supported value |
|
| content |
String, No Mod |
Attachment data encoded using named method |
|
ChangeSet
| Name |
Type |
Description |
Other Names
|
| changes |
Array of Change |
The changes made in one change submission |
|
| when |
Timestamp String XXX_XMLRPC_format |
When the changes were made |
|
| who |
User |
Who made the changes |
|
Change
| Name |
Type |
Description |
Other Names
|
| added |
String or Array XXX_promote? |
Values added, if any |
|
| field_name |
String |
Field changed |
|
| removed |
String or Array XXX_promote? |
Values removed, if any |
|
Flag
| Name |
Type |
Description |
Other Names
|
| id |
Integer |
XXX_all_wrong Unique ID of this individual flag (needs to be ID of flag type) |
|
| name |
String |
Flag name (non-unique) |
|
| setter |
User |
User who set the flag |
|
| status |
String |
Flag value |
|
| requestee |
String, Optional XXX_promote |
User action is requested from, if flag is requestable |
|