Bugzilla:BzAPI:Objects: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 13: Line 13:
{| border="1"
{| border="1"
!Name!!Type!!Description!!Other Names
!Name!!Type!!Description!!Other Names
|-
|actual_time||Decimal||Time it has taken to fix the bug so far||
|-
|-
|alias||String||Bug's alias (text alternative to number)||
|alias||String||Bug's alias (text alternative to number)||
Line 18: Line 20:
|assigned_to||User||User responsible for the bug||
|assigned_to||User||User responsible for the bug||
|-
|-
|attachment||Array of Attachment||Related files||
|attachment||Array of Attachment||Related files stored by Bugzilla||
|-
|-
|blocked XXXX_blocks?||Array of Integer||IDs of bugs which can only be fixed after this one XXX_refs?||
|blocks||Array of Integer||IDs of bugs which can only be fixed after this one||
|-
|-
|cc||Array of String XXX_User||Email addresses of CCed users||
|cc||Array of User||Users signed up to be notified of changes||
|-
|-
|cclist_accessible XXX_cc_accessible?||Boolean||Whether CC list can see bug, regardless of groups||
|cc_accessible||Boolean||Whether CC list can see bug, regardless of groups||
|-
|-
|classification||String||Name of classification (categorization above product)||
|classification||String||Name of classification (categorization above product)||
|-
|classification_id||Integer, Read Only||ID of classification (categorization above product) XXX_why_this_and_not_prod_or_comp?||
|-
|-
|comment||Array of Comment||Things people have said about the bug||long_desc
|comment||Array of Comment||Things people have said about the bug||long_desc
Line 36: Line 36:
|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
|-
|-
|dependson XXX_underscore?||Array of Integer||Bugs that must be fixed first XXX_refs?||
|deadline||Datestamp String||Date by which bug must be fixed||
|-
|-
|everconfirmed XXX_underscore?||Boolean, Read Only||Whether bug has ever passed from UNCONFIRMED to CONFIRMED status||
|depends_on||Array of Integer||Bugs that must be fixed first||
|-
|-
|flag||Hash of Flag; Key Integer (flag ID)||Flags set on this bug (note: not all possible flags)||
|estimated_time||Decimal||Total estimated time for fix, in hours||
|-
|ever_confirmed||Boolean, Read Only||Whether bug has ever passed from UNCONFIRMED to CONFIRMED status||
|-
|flag||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||
Line 61: Line 65:
|-
|-
|ref||String, Read Only||URL of bug in API||
|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||User, Read Only||User who submitted the bug||
Line 75: Line 81:
|-
|-
|target_milestone||String||When the bug is going to be fixed||
|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
|url||String||URL relating to the bug||bug_file_loc
Line 88: Line 96:


* Field values are configurable, so examples may not apply to your Bugzilla.
* Field values are configurable, so examples may not apply to your Bugzilla.
* Set assigned_to or qa_contact to the special value <tt>undef</tt> to reset them to the default for the current component. XXX_unimplemented
* Set assigned_to or qa_contact to the special value <tt>null</tt> (in JSON) to reset them to the default for the current component.


==Comment==
==Comment==
Line 132: Line 140:
|-
|-
|bug_ref||String, Read Only||URL of associated bug in API 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||
|data||AttachmentData, No Mod||File data||
Line 138: Line 148:
|-
|-
|filename||String||Path-less filename of attachment||
|filename||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
|id||Integer, Read Only||Unique reference for attachment||attach_id
Line 150: Line 162:
|-
|-
|size||Integer||Size of attachment, in bytes||
|size||Integer||Size of attachment, in bytes||
|-
|token||String||Token to submit to change attachment metadata||
|-
|-
|type||String||MIME type of attachment||
|type||String||MIME type of attachment||
|-
|when||Timestamp String, Read Only||When attachment was submitted||
|}
|}


Line 161: Line 173:
!Name!!Type!!Description!!Other Names
!Name!!Type!!Description!!Other Names
|-
|-
|encoding||String, Read Only||Encoding of 'content'; 'base64' is only supported value||
|encoding||String, No Mod||Encoding of 'content'; 'base64' is only supported value||
|-
|-
|content||String, Read Only||Attachment data encoded using named method||
|content||String, No Mod||Attachment data encoded using named method||
|}
|}


Revision as of 09:40, 30 September 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.
  • 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. XXX_is_this_the_best?

Bug

Name Type Description Other Names
actual_time Decimal Time it has taken to fix the bug so far
alias String Bug's alias (text alternative to number)
assigned_to User User responsible for the bug
attachment 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 Boolean Whether CC list can see bug, regardless of groups
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
deadline Datestamp String Date by which bug must be fixed
depends_on Array of Integer Bugs that must be fixed first
estimated_time Decimal Total estimated time for fix, in hours
ever_confirmed Boolean, Read Only Whether bug has ever passed from UNCONFIRMED to CONFIRMED status
flag 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 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

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
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 XXX_inconsistent? Timestamp String, Read Only XXX_bad_format? 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
creation_time Timestamp String, Read Only When attachment was submitted
data AttachmentData, No Mod File data
description String Text describing the attachment
filename 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 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
Retrieved from "https://wiki.mozilla.org/index.php?title=Bugzilla:BzAPI:Objects&oldid=172250"