MozillaWiki

Bugzilla:BzAPI:Objects

Revision as of 06:39, 4 October 2009 by Gerv (talk | contribs) (→‎Bug)

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. (So you don't have to remove them before sending an object back.)
  • Fields marked No Mod can be set when the object is created, but are Read Only thereafter.
  • Fields marked Optional may be missing entirely on returned objects. Other fields are guaranteed to be present but may be blank. XXX_make_it_so.
  • For fields of type Boolean, on submit, please use "1" and "0" for true and false. This may get relaxed later.
  • 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"). Eventually, all will also have a +NNNN timezone marker, but currently most don't.

Bug

Bold means the field is or can be returned on the search interface.

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
attachments Array of Attachment Related files stored by Bugzilla attachment
blocks Array of Integer IDs of bugs which can only be fixed after this one blocked
cc Array of User Users signed up to be notified of changes
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 dependson
estimated_time Decimal Current estimated time for fix, in hours
flags Array of Flag Flags set on this bug (XXXnote: not all possible flags)
groups Hash of String/Boolean pairs XXXunimplemented All possible groups for this bug; True if bug is in group, False otherwise
history Array of ChangeSet Changes made to bug fields in the past (requires 3.4)
id Integer, Read Only Unique numeric identifier for bug bug_id
is_cc_accessible Boolean Whether CC list can see bug, regardless of groups cclist_accessible
is_everconfirmed Boolean, Read Only Whether bug has ever passed from UNCONFIRMED to CONFIRMED status everconfirmed
is_reporter_accessible Boolean Whether reporter can see bug, regardless of groups reporter_accessible
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
percentage_complete Decimal, Read Only, Search Only How much of the work is done (calculated)
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
resolution String The resolution, if the bug is in a closed state, e.g. FIXED, DUPLICATE
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, Optional Token you'll need to submit to change the bug; supplied only when logged in
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

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.

Comment

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, Optional (for the moment) Unique numeric identifier for comment; 3.4 or above, and only on comment requests, not bug requests
is_private Boolean Whether comment is private
text String, No Mod Text of comment (plain text)

Flag

Name Type Description Other Names
flagtype_id Integer XXXunimplemented Unique numeric identifier for flag type
id Integer Unique numeric identifier for this particular flag
name String Descriptive flag name (non-unique)
setter User User who set the flag
status String Flag value
requestee String, Optional User action is requested from, if flag is requestable

ChangeSet

Name Type Description Other Names
changer User Who made the changes
changes Array of Change The changes made in one change submission
change_time Timestamp String When the changes were made

Change

Name Type Description Other Names
added String Values added, if any (comma-separated if multiple)
field_name String Name of field changed
removed String Values removed, if any (comma-separated if multiple)

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
bug_ref String, Read Only URL of associated bug in API
creation_time Timestamp String, Read Only When attachment was submitted
data String, Optional, No Mod Attachment data encoded using encoding 'encoding'; provided only when attachmentdata requested
description String Text describing the attachment
encoding String, Optional, No Mod Encoding of 'content'; 'base64' is the only supported value; provided only when attachmentdata requested
file_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 numeric identifier 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, Optional Token to submit to change attachment metadata; supplied only when logged in
content_type String MIME type of attachment

User

Name Type Description Other Names
id Integer, Optional (for the moment) Unique numeric identifier for user (currently only supplied on /user API)
name String Email address of user (if you are logged in) or first part otherwise (which is therefore non-unique) 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

Error

Name Type Description Other Names
code Integer, Read Only Unambiguous definition of error (XXXunimplemented)
error Boolean (True), Read Only Indicates the object is an error object
html_page String, Read Only, Optional If underlying implementation is screen-scraping and if error is not recognised; only present so you can read it manually!
http_code Integer, Read Only, Optional If Bugzilla returned a useful HTTP code
message String, Read Only Short English string describing error
xmlrpc_code Integer, Read Only, Optional If underlying implementation is XML-RPC
Retrieved from "https://wiki.allizom.org/index.php?title=Bugzilla:BzAPI:Objects&oldid=173069"