Bugzilla:BzAPI:Objects: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
Line 3: Line 3:
====Notes====
====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 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 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.
* 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
* 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?
* 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 +DDDD timezone marker, but currently most don't.


==Bug==
==Bug==
Line 13: Line 13:
{| border="1"
{| border="1"
!Name!!Type!!Description!!Other Names
!Name!!Type!!Description!!Other Names
|-
|- style="font-weight: bold"
|actual_time||Decimal, Read Only||Time it has taken to fix the bug so far||
|actual_time||Decimal, Read Only||Time it has taken to fix the bug so far||
|-
|- style="font-weight: bold"
|alias||String||Bug's alias (text alternative to ID)||
|alias||String||Bug's alias (text alternative to ID)||
|-
|- style="font-weight: bold"
|assigned_to||User||User responsible for the bug||
|assigned_to||User||User responsible for the bug||
|-
|-
|attachment XXX_attachments||Array of Attachment||Related files stored by Bugzilla||
|attachments||Array of Attachment||Related files stored by Bugzilla||
|-
|-
|blocks||Array of Integer||IDs of bugs which can only be fixed after this one||
|blocks||Array of Integer||IDs of bugs which can only be fixed after this one||
Line 26: Line 26:
|cc||Array of User||Users signed up to be notified of changes||
|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||
|is_cc_accessible||Boolean||Whether CC list can see bug, regardless of groups||
|-
|- style="font-weight: bold"
|classification||String||Name of classification (categorization above product)||
|classification||String||Name of classification (categorization above product)||
|-
|-
|comments||Array of Comment||Things people have said about the bug||long_desc
|comments||Array of Comment||Things people have said about the bug||long_desc
|-
|- style="font-weight: bold"
|component||String||Bug's component (sub-product)||
|component||String||Bug's component (sub-product)||
|-
|- style="font-weight: bold"
|creation_time||Timestamp String, Read Only||When bug was filed||creation_ts, opendate
|creation_time||Timestamp String, Read Only||When bug was filed||creation_ts, opendate
|-
|- style="font-weight: bold"
|deadline||Datestamp String||Date by which bug must be fixed||
|deadline||Datestamp String||Date by which bug must be fixed||
|-
|-
|depends_on||Array of Integer||Bugs that must be fixed first||
|depends_on||Array of Integer||Bugs that must be fixed first||
|-
|- style="font-weight: bold"
|estimated_time||Decimal||Current estimated time for fix, in hours||
|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||
|is_everconfirmed||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)||
|flags||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||
|history||Array of ChangeSet||Changes made to bug fields in the past||
|-
|- style="font-weight: bold"
|id||Integer, Read Only||Unique reference for bug||bug_id
|id||Integer, Read Only||Unique numeric identifier for bug||bug_id
|-
|- style="font-weight: bold"
|keywords||Array of String||Tags (from a limited set) describing the bug||
|keywords||Array of String||Tags (from a limited set) describing the bug||
|-
|- style="font-weight: bold"
|last_change_time||Timestamp String, Read Only||Last change||delta_ts, changeddate
|last_change_time||Timestamp String, Read Only||Last change||delta_ts, changeddate
|-
|- style="font-weight: bold"
|op_sys||String||Operating system bug was seen on, e.g. Windows Vista, Linux||
|op_sys||String||Operating system bug was seen on, e.g. Windows Vista, Linux||
|-
|- style="font-weight: bold"
|percentage_complete||Decimal, Read Only, Search Only XXX_calc_for_bugs?||How much of the work is done (calculated)||
|- style="font-weight: bold"
|platform||String||Computing platform bug was seen on, e.g. PC, Mac||rep_platform
|platform||String||Computing platform bug was seen on, e.g. PC, Mac||rep_platform
|-
|- style="font-weight: bold"
|priority||String||How important the bug is, e.g. P1, P5||
|priority||String||How important the bug is, e.g. P1, P5||
|-
|- style="font-weight: bold"
|product||String||Name of product||
|product||String||Name of product||
|-
|- style="font-weight: bold"
|qa_contact||User||User responsible for checking bug is fixed||
|qa_contact||User||User responsible for checking bug is fixed||
|-
|- style="font-weight: bold"
|ref||String, Read Only||URL of bug in API||
|ref||String, Read Only||URL of bug in API||
|-
|- style="font-weight: bold"
|remaining_time||Decimal, Read Only||Hours left before fix will be done||
|remaining_time||Decimal, Read Only||Hours left before fix will be done||
|-
|- style="font-weight: bold"
|reporter||User, Read Only||User who submitted the bug||
|reporter||User, Read Only||User who submitted the bug||
|-
|-
|reporter_accessible XXXname?||Boolean||Whether reporter can see bug, regardless of groups||
|is_reporter_accessible||Boolean||Whether reporter can see bug, regardless of groups||
|- style="font-weight: bold"
|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||
|see_also||Array of String||URLs of related bugs||
|-
|- style="font-weight: bold"
|severity||String||How severe the bug is, e.g. enhancement, critical||bug_severity
|severity||String||How severe the bug is, e.g. enhancement, critical||bug_severity
|-
|- style="font-weight: bold"
|status||String||Current status, e.g. NEW, RESOLVED||bug_status
|status||String||Current status, e.g. NEW, RESOLVED||bug_status
|-
|- style="font-weight: bold"
|summary||String||Short sentence describing the bug||short_desc
|summary||String||Short sentence describing the bug||short_desc
|-
|- style="font-weight: bold"
|target_milestone||String||When the bug is going to be fixed||
|target_milestone||String||When the bug is going to be fixed||
|-
|-
Line 85: Line 89:
|-
|-
|url||String||URL relating to the bug||bug_file_loc
|url||String||URL relating to the bug||bug_file_loc
|-
|- style="font-weight: bold"
|version||String||Version of software in which bug is seen||
|version||String||Version of software in which bug is seen||
|-
|- style="font-weight: bold"
|whiteboard||String||Notes on current status||status_whiteboard
|whiteboard||String||Notes on current status||status_whiteboard
|-
|-
Line 93: Line 97:
|}
|}


XXX_TODO_TOTEST groups, work_time
XXX_TODO_TOTEST groups


====Notes====
====Notes====
Line 109: Line 113:
|creation_time||Timestamp String, Read Only||Time comment was added||
|creation_time||Timestamp String, Read Only||Time comment was added||
|-
|-
|id||Integer, Read Only||Unique identifier of comment in Bugzilla||
|id||Integer, Read Only||Unique numeric identifier for comment||
|-
|-
|is_private||Boolean||Whether comment is private||
|is_private||Boolean||Whether comment is private||
Line 116: Line 120:
|}
|}


==User==
==Flag==
 
{| border="1"
!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 XXX_promote||User action is requested from, if flag is requestable||
|}
 
==ChangeSet==
 
{| border="1"
!Name!!Type!!Description!!Other Names
|-
|changes||Array of Change||The changes made in one change submission||
|-
|when||Timestamp String||When the changes were made||
|-
|who||User||Who made the changes||
|}
 
==Change==


{| border="1"
{| border="1"
!Name!!Type!!Description!!Other Names
!Name!!Type!!Description!!Other Names
|-
|-
|name||String||Email address of user XXX_not_always_true?||assignee, reporter, qa_contact (as flat fields)
|added||String or Array XXX_promote?||Values added, if any||
|-
|-
|real_name||String, Read Only, Optional||User's real name||name, assignee_realname etc.
|field_name||String||Field changed||
|-
|-
|ref||String, Read Only||URL of user in API||
|removed||String or Array XXX_promote?||Values removed, if any||
|}
|}


Line 141: Line 175:
|creation_time||Timestamp String, Read Only||When attachment was submitted||
|creation_time||Timestamp String, Read Only||When attachment was submitted||
|-
|-
|data||AttachmentData, No Mod||File data||
|data||String, No Mod||Attachment data encoded using encoding 'encoding'||
|-
|-
|description||String||Text describing the attachment||
|description||String||Text describing the attachment||
|-
|encoding||String, No Mod||Encoding of 'content'; 'base64' is only supported value; provided only with data field||
|-
|-
|filename XXXfile_name||String||Path-less filename of attachment||
|filename XXXfile_name||String||Path-less filename of attachment||
Line 149: Line 185:
|flag||Array of Flag||Flags set on this attachment (XXXnote: not all possible flags)||
|flag||Array of Flag||Flags set on this attachment (XXXnote: not all possible flags)||
|-
|-
|id||Integer, Read Only||Unique reference for attachment||attach_id
|id||Integer, Read Only||Unique numeric identifier for attachment||attach_id
|-
|-
|is_obsolete||Boolean||Whether file is marked obsolete||isobsolete
|is_obsolete||Boolean||Whether file is marked obsolete||isobsolete
Line 166: Line 202:
|}
|}


==AttachmentData==
==User==


{| border="1"
{| border="1"
!Name!!Type!!Description!!Other Names
!Name!!Type!!Description!!Other Names
|-
|-
|encoding||String, No Mod||Encoding of 'content'; 'base64' is only supported value||
|id||Integer||XXXunimplemented? Unique numeric identifier for user||
|-
|content||String, No Mod||Attachment data encoded using named method||
|}
 
==ChangeSet==
 
{| border="1"
!Name!!Type!!Description!!Other Names
|-
|-
|changes||Array of Change||The changes made in one change submission||
|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)
|-
|-
|when||Timestamp String XXX_XMLRPC_format||When the changes were made||
|real_name||String, Read Only, Optional||User's real name||name, assignee_realname etc.
|-
|-
|who||User||Who made the changes||
|ref||String, Read Only||URL of user in API||
|}
 
==Change==
 
{| border="1"
!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==
 
{| border="1"
!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||
|}
|}

Revision as of 21:06, 1 October 2009

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. 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"). Eventually, all will also have a +DDDD timezone marker, but currently most don't.

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
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
is_cc_accessible 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
is_everconfirmed Boolean, Read Only Whether bug has ever passed from UNCONFIRMED to CONFIRMED status
flags 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 numeric identifier 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
percentage_complete Decimal, Read Only, Search Only XXX_calc_for_bugs? 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
is_reporter_accessible Boolean Whether reporter can see bug, regardless of groups
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, 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

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 Unique numeric identifier for comment
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 XXX_promote User action is requested from, if flag is requestable

ChangeSet

Name Type Description Other Names
changes Array of Change The changes made in one change submission
when Timestamp String 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

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 String, No Mod Attachment data encoded using encoding 'encoding'
description String Text describing the attachment
encoding String, No Mod Encoding of 'content'; 'base64' is only supported value; provided only with data field
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 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 Token to submit to change attachment metadata
type XXXcontent_type String MIME type of attachment

User

Name Type Description Other Names
id Integer XXXunimplemented? Unique numeric identifier for user
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
Retrieved from "https://wiki.mozilla.org/index.php?title=Bugzilla:BzAPI:Objects&oldid=172664"