Account confirmers, Anti-spam team, Confirmed users, Bureaucrats and Sysops emeriti
4,925
edits
Bugzilla:BzAPI:Objects: Difference between revisions
no edit summary
(→Bug) |
No edit summary |
||
| Line 5: | Line 5: | ||
* 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. | ||
* 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 on returned objects. Other fields are guaranteed to be present but may be blank. XXX_make_it_so. | ||
* For fields of type Boolean, on submit, "0" and | * 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 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 +NNNN timezone marker, but currently most don't. | * 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 +NNNN timezone marker, but currently most don't. | ||
==Bug== | ==Bug== | ||
'''Bold | '''Bold''' means the field is or can be returned on the search interface. | ||
{| border="1" | {| border="1" | ||
| Line 90: | Line 90: | ||
|target_milestone||String||When the bug is going to be fixed|| | |target_milestone||String||When the bug is going to be fixed|| | ||
|- | |- | ||
|token||String, | |token||String, Optional||Token you'll need to submit to change the bug; supplied only when logged in|| | ||
|- | |- | ||
|url||String||URL relating to the bug||bug_file_loc | |url||String||URL relating to the bug||bug_file_loc | ||
| Line 100: | Line 100: | ||
|work_time||Decimal (Submit Only)||Hours to be added to actual_time|| | |work_time||Decimal (Submit Only)||Hours to be added to actual_time|| | ||
|} | |} | ||
====Notes==== | ====Notes==== | ||
| Line 158: | Line 157: | ||
!Name!!Type!!Description!!Other Names | !Name!!Type!!Description!!Other Names | ||
|- | |- | ||
|added||String||Values added, if any|| | |added||String||Values added, if any (comma-separated if multiple)|| | ||
|- | |- | ||
|field_name||String|| | |field_name||String||Name of field changed|| | ||
|- | |- | ||
|removed||String||Values removed, if any|| | |removed||String||Values removed, if any (comma-separated if multiple)|| | ||
|} | |} | ||
| Line 178: | Line 177: | ||
|creation_time||Timestamp String, Read Only||When attachment was submitted|| | |creation_time||Timestamp String, Read Only||When attachment was submitted|| | ||
|- | |- | ||
|data||String, No Mod||Attachment data encoded using encoding 'encoding'|| | |data||String, Optional, No Mod||Attachment data encoded using encoding 'encoding'; provided only when attachmentdata requested|| | ||
|- | |- | ||
|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 | |encoding||String, Optional, No Mod||Encoding of 'content'; 'base64' is the only supported value; provided only when attachmentdata requested|| | ||
|- | |- | ||
|file_name||String||Path-less filename of attachment|| | |file_name||String||Path-less filename of attachment|| | ||
| Line 200: | Line 199: | ||
|size||Integer||Size of attachment, in bytes|| | |size||Integer||Size of attachment, in bytes|| | ||
|- | |- | ||
|token||String||Token to submit to change attachment metadata|| | |token||String, Optional||Token to submit to change attachment metadata; supplied only when logged in|| | ||
|- | |- | ||
|content_type||String||MIME type of attachment|| | |content_type||String||MIME type of attachment|| | ||
| Line 210: | Line 209: | ||
!Name!!Type!!Description!!Other Names | !Name!!Type!!Description!!Other Names | ||
|- | |- | ||
|id||Integer, Optional ( | |id||Integer, Optional (for the moment)||Unique numeric identifier for user (currently only supplied on /user API)|| | ||
|- | |- | ||
|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) | |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) | ||
| Line 234: | Line 233: | ||
|message||String, Read Only||Short English string describing error|| | |message||String, Read Only||Short English string describing error|| | ||
|- | |- | ||
|xmlrpc_code||Integer, Read Only||If underlying implementation is XML-RPC|| | |xmlrpc_code||Integer, Read Only, Optional||If underlying implementation is XML-RPC|| | ||
|} | |} | ||