Bugzilla:BzAPI:Objects: Difference between revisions

no edit summary
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 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====
====Notes====
Line 7: Line 7:
* 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, "0", 0 and "" are false; everything else is true.  
* 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.
* Fields of type Timestamp are in YYYY-MM-DD HH:MM:SS format. XXX_is_this_the_best?
* 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>undef</tt> to reset them to the default for the current component. XXX_unimplemented
Line 39: Line 39:
|-
|-
|everconfirmed XXX_underscore?||Boolean, Read Only||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||
|-
|history||Array of ChangeSet||Changes made to bug fields in the past||
|-
|-
|id||Integer, Read Only||Unique reference for bug||bug_id
|id||Integer, Read Only||Unique reference for bug||bug_id
Line 79: Line 81:
|}
|}


XXX flags, groups
XXX flags, groups, alias


==Comment==
==Comment==
Line 98: Line 100:
|text||String, No Mod||Text of comment (plain text)||
|text||String, No Mod||Text of comment (plain text)||
|-
|-
|time||Timestamp String, Read Only||Time comment was added||
|time||Timestamp String, Read Only XXX_bad_format?||Time comment was added||
|}
|}


Line 124: Line 126:
|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||
|-
|-
|data||AttachmentData||File data||
|data||AttachmentData, No Mod||File data||
|-
|-
|description||String||Text describing the attachment||
|description||String||Text describing the attachment||
Line 155: Line 157:
|-
|-
|content||String, Read Only||Attachment data encoded using named method||
|content||String, Read Only||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||
|-
|when||Timestamp String XXX_XMLRPC_format||When the changes were made||
|-
|who||User||Who made the changes||
|}
==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||
|}
|}
Account confirmers, Anti-spam team, Confirmed users, Bureaucrats and Sysops emeriti
4,925

edits