Bugzilla:BzAPI:Objects: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(Created page with '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. For Booleans, "0", 0 …')
 
No edit summary
Line 1: Line 1:
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.
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.


For Booleans, "0", 0 and "" are false; everything else is true. Timestamps are in YYYY-MM-DD HH:MM:SS format.
====Notes====
 
* Fields marked Read Only may be returned by GET calls, but will be ignored in POST or PUT.
* 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 <tt>undef</tt> to reset them to the default for the current component. XXX_unimplemented


==Bug==
==Bug==
Line 14: Line 21:
|blocks||Array of Integer||Bugs which can only be fixed after||
|blocks||Array of Integer||Bugs which can only be fixed after||
|-
|-
|cc||Array of String||XXX Email addresses of CCed users||
|cc||Array of String XXX_User||Email addresses of CCed users||
|-
|-
|cclist_accessible||Boolean||Whether CC list can see bug regardless of groups||
|cclist_accessible||Boolean||Whether CC list can see bug, regardless of groups||
|-
|-
|classification_id||Integer||ID of classification (categorization above product)||
|classification_id||Integer, Read Only||ID of classification (categorization above product)||
|-
|-
|classification||String||Name of classification (categorization above product)||
|classification||String||Name of classification (categorization above product)||
Line 24: Line 31:
|component||String||Bug's component (sub-product)||
|component||String||Bug's component (sub-product)||
|-
|-
|creation_time||Timestamp String||When bug was filed||creation_ts
|creation_time||Timestamp String, Read Only||When bug was filed||creation_ts, opendate
|-
|-
|dependson||Array of Integer||Bugs that must be fixed first||
|dependson XXX_underscore?||Array of Integer||Bugs that must be fixed first||
|-
|-
|everconfirmed||Boolean||Whether bug has ever passed from UNCONFIRMED to CONFIRMED status||
|everconfirmed XXX_underscore?||Boolean, Read Only||Whether bug has ever passed from UNCONFIRMED to CONFIRMED status||
|-
|-
|id||Integer||Bug number||bug_id
|id||Integer, Read Only||Unique reference for bug||bug_id
|-
|-
|last_change_time||Timestamp String||Last change||delta_ts
|last_change_time||Timestamp String, Read Only||Last change||delta_ts, changeddate
|-
|-
|op_sys||String||Operating system bug was found on||
|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
|platform||String||Computing platform bug was seen on, e.g. PC, Mac||rep_platform
Line 44: Line 51:
|qa_contact||User||User responsible for checking bug is fixed||
|qa_contact||User||User responsible for checking bug is fixed||
|-
|-
|reporter_accessible||Boolean||Whether reporter can see bug regardless of groups||
|ref||String, Read Only||URL of bug in API||
|-
|-
|reporter||User||User who submitted the bug||
|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||
|see_also||Array of String||URLs of related bugs||
Line 52: Line 61:
|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
|-
|-
|status||String||Current status, e.g. NEW, RESOLVED||
|status||String||Current status, e.g. NEW, RESOLVED||bug_status
|-
|-
|summary||String||Short sentence describing the bug||short_desc
|summary||String||Short sentence describing the bug||short_desc
Line 62: Line 71:
|version||String||Version of software in which bug is seen||
|version||String||Version of software in which bug is seen||
|-
|-
|whiteboard||String||Notes on current status||
|whiteboard||String||Notes on current status||status_whiteboard
|}
|}
XXX flags, groups


==User==
==User==


{| border="1"
!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==
==Attachment==
{| border="1"
!Name!!Type!!Description!!Other Names
|-
|attacher||User, Read Only||User who created attachment||
|-
|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
|-
|is_patch||Boolean||Whether bug is a patch||ispatch
|-
|is_private||Boolean||Whether bug is private||isprivate
obsolete||isobsolete
|-
|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||
|}

Revision as of 09:28, 29 September 2009

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 may be returned by GET calls, but will be ignored in POST or PUT.
  • 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 Bugs which can only be fixed after
cc Array of String XXX_User Email addresses of CCed users
cclist_accessible Boolean Whether CC list can see bug, regardless of groups
classification_id Integer, Read Only ID of classification (categorization above product)
classification String Name of classification (categorization above product)
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
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
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

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
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
is_patch Boolean Whether bug is a patch ispatch
is_private Boolean Whether bug is private isprivate

obsolete||isobsolete

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
Retrieved from "https://wiki.mozilla.org/index.php?title=Bugzilla:BzAPI:Objects&oldid=171806"