Account confirmers, Anti-spam team, Confirmed users, Bureaucrats and Sysops emeriti
4,925
edits
Bugzilla:BzAPI:Objects: Difference between revisions
Add internal links
No edit summary |
(Add internal links) |
||
| Line 6: | Line 6: | ||
* 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 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. | ||
* For the objects other than Bug, some fields are marked Optional to show that they are not always present. For a Bug, all fields should be considered Optional apart from "id" and "ref". | * For the objects other than [[#Bug|Bug]], some fields are marked Optional to show that they are not always present. For a [[#Bug|Bug]], all fields should be considered Optional apart from "id" and "ref". | ||
* For fields of type Boolean, on submit, please use "1" and "0" for true and false. This may get relaxed later. | * 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 should be sent and received in the UTC timezone in ISO 8601 format - YYYY-MM-DDTHH:MM:SSZ (T and Z being a literal "T" and "Z"). | * Fields of type Timestamp should be sent and received in the UTC timezone in ISO 8601 format - YYYY-MM-DDTHH:MM:SSZ (T and Z being a literal "T" and "Z"). | ||
| Line 21: | Line 21: | ||
|alias||String||Bug's alias (text alternative to ID)|| | |alias||String||Bug's alias (text alternative to ID)|| | ||
|- style="font-weight: bold" | |- style="font-weight: bold" | ||
|assigned_to||User||User responsible for the bug|| | |assigned_to||[[#User|User]]||User responsible for the bug|| | ||
|- | |- | ||
|attachments||Array of [[#Attachment|Attachment]]||Related files stored by Bugzilla||attachment | |attachments||Array of [[#Attachment|Attachment]]||Related files stored by Bugzilla||attachment | ||
| Line 27: | Line 27: | ||
|blocks||Array of Integer||IDs of bugs which can only be fixed after this one||blocked | |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|| | |cc||Array of [[#User|User]]||Users signed up to be notified of changes|| | ||
|- style="font-weight: bold" | |- 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|Comment]]||Things people have said about the bug||long_desc | ||
|- style="font-weight: bold" | |- style="font-weight: bold" | ||
|component||String||Bug's component (sub-product)|| | |component||String||Bug's component (sub-product)|| | ||
| Line 37: | Line 37: | ||
|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" | |- style="font-weight: bold" | ||
|creator||User, Read Only||User who submitted the bug||reporter | |creator||[[#User|User]], Read Only||User who submitted the bug||reporter | ||
|- style="font-weight: bold" | |- style="font-weight: bold" | ||
|deadline||Datestamp String||Date by which bug must be fixed|| | |deadline||Datestamp String||Date by which bug must be fixed|| | ||
| Line 47: | Line 47: | ||
|estimated_time||Decimal||Current estimated time for fix, in hours|| | |estimated_time||Decimal||Current estimated time for fix, in hours|| | ||
|- | |- | ||
|flags||Array of Flag||Flags set on this bug|| | |flags||Array of [[#Flag|Flag]]||Flags set on this bug|| | ||
|- | |- | ||
|groups||Array of Group||Groups to which this bug belongs|| | |groups||Array of [[#Group|Group]]||Groups to which this bug belongs|| | ||
|- | |- | ||
|history||Array of ChangeSet, Read Only||Changes made to bug fields in the past (requires 3.4)|| | |history||Array of [[#ChangeSet|ChangeSet]], Read Only||Changes made to bug fields in the past (requires 3.4)|| | ||
|- style="font-weight: bold" | |- style="font-weight: bold" | ||
|id||Integer, Read Only||Unique numeric identifier for bug||bug_id | |id||Integer, Read Only||Unique numeric identifier for bug||bug_id | ||
| Line 73: | Line 73: | ||
|product||String||Name of product|| | |product||String||Name of product|| | ||
|- style="font-weight: bold" | |- style="font-weight: bold" | ||
|qa_contact||User||User responsible for checking bug is fixed|| | |qa_contact||[[#User|User]]||User responsible for checking bug is fixed|| | ||
|- style="font-weight: bold" | |- style="font-weight: bold" | ||
|ref||String, Read Only||URL of bug in API|| | |ref||String, Read Only||URL of bug in API|| | ||
| Line 113: | Line 113: | ||
|attachment_ref||String, Read Only||Ref of attachment added at the same time as this comment, if any; 3.6 or above and /comment call only|| | |attachment_ref||String, Read Only||Ref of attachment added at the same time as this comment, if any; 3.6 or above and /comment call only|| | ||
|- | |- | ||
|creator||User, Read Only||User who wrote the comment|| | |creator||[[#User|User]], Read Only||User who wrote the comment|| | ||
|- | |- | ||
|creation_time||Timestamp String, Read Only||Time comment was added|| | |creation_time||Timestamp String, Read Only||Time comment was added|| | ||
| Line 147: | Line 147: | ||
|requestee||String, Optional||User action is requested from, if flag is requestable; can only be set if setting status to '?'|| | |requestee||String, Optional||User action is requested from, if flag is requestable; can only be set if setting status to '?'|| | ||
|- | |- | ||
|setter||User, Read Only||User who set the flag|| | |setter||[[#User|User]], Read Only||User who set the flag|| | ||
|- | |- | ||
|status||String||Flag value - '?', '+', '-' or 'X'|| | |status||String||Flag value - '?', '+', '-' or 'X'|| | ||
| Line 161: | Line 161: | ||
!Name!!Type!!Description!!Other Names | !Name!!Type!!Description!!Other Names | ||
|- | |- | ||
|changer||User||Who made the changes|| | |changer||[[#User|User]]||Who made the changes|| | ||
|- | |- | ||
|changes||Array of Change||The changes made in one change submission|| | |changes||Array of [[#Change|Change]]||The changes made in one change submission|| | ||
|- | |- | ||
|change_time||Timestamp String||When the changes were made|| | |change_time||Timestamp String||When the changes were made|| | ||
| Line 187: | Line 187: | ||
!Name!!Type!!Description!!Other Names | !Name!!Type!!Description!!Other Names | ||
|- | |- | ||
|attacher||User, Read Only||User who created attachment|| | |attacher||[[#User|User]], Read Only||User who created attachment|| | ||
|- | |- | ||
|bug_id||Integer, Read Only||ID if bug to which this is an attachment|| | |bug_id||Integer, Read Only||ID if bug to which this is an attachment|| | ||
| Line 193: | Line 193: | ||
|bug_ref||String, Read Only||URL of associated bug in API|| | |bug_ref||String, Read Only||URL of associated bug in API|| | ||
|- | |- | ||
|comments||Array of Comment, Optional, Submit Only||Bug comment associated with creation or change (only first element in array is looked at)|| | |comments||Array of [[#Comment|Comment]], Optional, Submit Only||Bug comment associated with creation or change (only first element in array is looked at)|| | ||
|- | |- | ||
|creation_time||Timestamp String, Read Only||When attachment was submitted|| | |creation_time||Timestamp String, Read Only||When attachment was submitted|| | ||
| Line 205: | Line 205: | ||
|file_name||String||Path-less filename of attachment|| | |file_name||String||Path-less filename of attachment|| | ||
|- | |- | ||
|flags||Array of Flag||Flags set on this attachment|| | |flags||Array of [[#Flag|Flag]]||Flags set on this attachment|| | ||
|- | |- | ||
|id||Integer, Read Only||Unique numeric identifier for attachment||attach_id | |id||Integer, Read Only||Unique numeric identifier for attachment||attach_id | ||
| Line 261: | Line 261: | ||
|} | |} | ||
* Error objects are distinguished from other objects because they have an "error" member set to a true value. You should test every API return to see if it is an Error. | * Error objects are distinguished from other objects because they have an "error" member set to a true value. You should test every API return to see if it is an [[#Error|Error]]. | ||