<<

# Bugzilla::Webservice::Bug

- NAME
- DESCRIPTION
- METHODS
- Utility Functions
  - fields
  - legal_values
- Bug Information
  - attachments
  - comments
  - get
  - history
  - possible_duplicates
  - search
- Bug Creation and Modification
  - create
  - add_attachment
  - add_comment
  - update
  - update_see_also
  - update_tags

# NAME

Bugzilla::Webservice::Bug - The API for creating, changing, and getting the details of bugs.

# DESCRIPTION

This part of the Bugzilla API allows you to file a new bug in Bugzilla, or get information about bugs that have already been filed.

# METHODS

See Bugzilla::WebService for a description of how parameters are passed, and what STABLE, UNSTABLE, and EXPERIMENTAL mean.

# Utility Functions

## fields

UNSTABLE

Description

  Get information about valid bug fields, including the lists of legal values for each field.

Params

  You can pass either field ids or field names.

  Note: If neither `ids` nor `names` is specified, then all non-obsolete fields will be returned.

  In addition to the parameters below, this method also accepts the standard include_fields and exclude_fields arguments.

  `ids` (array) - An array of integer field ids.
  `names` (array) - An array of strings representing field names.
Returns

  A hash containing a single element, `fields`. This is an array of hashes, containing the following keys:

  `id`

    `int` An integer id uniquely identifying this field in this installation only.

  `type`

    `int` The number of the fieldtype. The following values are defined:

    `0` Unknown
    `1` Free Text
    `2` Drop Down
    `3` Multiple-Selection Box
    `4` Large Text Box
    `5` Date/Time
    `6` Bug Id
    `7` Bug URLs ("See Also")
  `is_custom`

    `boolean` True when this is a custom field, false otherwise.

  `name`

    `string` The internal name of this field. This is a unique identifier for this field. If this is not a custom field, then this name will be the same across all Bugzilla installations.

  `display_name`

    `string` The name of the field, as it is shown in the user interface.

  `is_mandatory`

    `boolean` True if the field must have a value when filing new bugs. Also, mandatory fields cannot have their value cleared when updating bugs.

  `is_on_bug_entry`

    `boolean` For custom fields, this is true if the field is shown when you enter a new bug. For standard fields, this is currently always false, even if the field shows up when entering a bug. (To know whether or not a standard field is valid on bug entry, see "create".)

  `visibility_field`

    `string` The name of a field that controls the visibility of this field in the user interface. This field only appears in the user interface when the named field is equal to one of the values in `visibility_values`. Can be null.

  `visibility_values`

    `array` of `string`s This field is only shown when `visibility_field` matches one of these values. When `visibility_field` is null, then this is an empty array.

  `value_field`

    `string` The name of the field that controls whether or not particular values of the field are shown in the user interface. Can be null.

  `values`

    This is an array of hashes, representing the legal values for select-type (drop-down and multiple-selection) fields. This is also populated for the `component`, `version`, `target_milestone`, and `keywords` fields, but not for the `product` field (you must use Product.get_accessible_products for that.

    For fields that aren't select-type fields, this will simply be an empty array.

    Each hash has the following keys:

    `name`

      `string` The actual value--this is what you would specify for this field in "create", etc.

    `sort_key`

      `int` Values, when displayed in a list, are sorted first by this integer and then secondly by their name.

    `sortkey`

      DEPRECATED - Use `sort_key` instead.

    `visibility_values`

      If `value_field` is defined for this field, then this value is only shown if the `value_field` is set to one of the values listed in this array. Note that for per-product fields, `value_field` is set to `'product'` and `visibility_values` will reflect which product(s) this value appears in.

    `is_active`

      `boolean` This value is defined only for certain product specific fields such as version, target_milestone or component. When true, the value is active, otherwise the value is not active.

    `description`

      `string` The description of the value. This item is only included for the `keywords` field.

    `is_open`

      `boolean` For `bug_status` values, determines whether this status specifies that the bug is "open" (true) or "closed" (false). This item is only included for the `bug_status` field.

    `can_change_to`

      For `bug_status` values, this is an array of hashes that determines which statuses you can transition to from this status. (This item is only included for the `bug_status` field.)

      Each hash contains the following items:

      `name`

        the name of the new status

      `comment_required`

        this `boolean` True if a comment is required when you change a bug into this status using this transition.

Errors
  51 (Invalid Field Name or Id)

    You specified an invalid field name or id.

History
  Added in Bugzilla 3.6.
  The `is_mandatory` return value was added in Bugzilla 4.0.
  `sortkey` was renamed to `sort_key` in Bugzilla 4.2.
  `is_active` return key for `values` was added in Bugzilla 4.4.

## legal_values

DEPRECATED - Use "fields" instead.

Description

  Tells you what values are allowed for a particular field.

Params
  `field` - The name of the field you want information about. This should be the same as the name you would use in "create", below.
  `product_id` - If you're picking a product-specific field, you have to specify the id of the product you want the values for.
Returns

  `values` - An array of strings: the legal values for this field. The values will be sorted as they normally would be in Bugzilla.

Errors
  106 (Invalid Product)

    You were required to specify a product, and either you didn't, or you specified an invalid product (or a product that you can't access).

  108 (Invalid Field Name)

    You specified a field that doesn't exist or isn't a drop-down field.

# Bug Information

## attachments

EXPERIMENTAL

Description

  It allows you to get data about attachments, given a list of bugs and/or attachment ids.

  Note: Private attachments will only be returned if you are in the insidergroup or if you are the submitter of the attachment.

Params

  Note: At least one of `ids` or `attachment_ids` is required.

  `ids`

    See the description of the `ids` parameter in the "get" method.

  `attachment_ids`

    `array` An array of integer attachment ids.

  Also accepts the include_fields, and exclude_fields arguments.

Returns

  A hash containing two elements: `bugs` and `attachments`. The return value looks like this:

       {
           bugs => {
               1345 => [
                   { (attachment) },
                   { (attachment) }
               ],
               9874 => [
                   { (attachment) },
                   { (attachment) }
               ],
           },

           attachments => {
               234 => { (attachment) },
               123 => { (attachment) },
           }
       }

  The attachments of any bugs that you specified in the `ids` argument in input are returned in `bugs` on output. `bugs` is a hash that has integer bug IDs for keys and the values are arrayrefs that contain hashes as attachments. (Fields for attachments are described below.)

  For any attachments that you specified directly in `attachment_ids`, they are returned in `attachments` on output. This is a hash where the attachment ids point directly to hashes describing the individual attachment.

  The fields for each attachment (where it says `(attachment)` in the diagram above) are:

  `data`

    `base64` The raw data of the attachment, encoded as Base64.

  `size`

    `int` The length (in bytes) of the attachment.

  `creation_time`

    `dateTime` The time the attachment was created.

  `last_change_time`

    `dateTime` The last time the attachment was modified.

  `id`

    `int` The numeric id of the attachment.

  `bug_id`

    `int` The numeric id of the bug that the attachment is attached to.

  `file_name`

    `string` The file name of the attachment.

  `summary`

    `string` A short string describing the attachment.

    Also returned as `description`, for backwards-compatibility with older Bugzillas. (However, this backwards-compatibility will go away in Bugzilla 5.0.)

  `content_type`

    `string` The MIME type of the attachment.

  `is_private`

    `boolean` True if the attachment is private (only visible to a certain group called the "insidergroup"), False otherwise.

  `is_obsolete`

    `boolean` True if the attachment is obsolete, False otherwise.

  `is_patch`

    `boolean` True if the attachment is a patch, False otherwise.

  `creator`

    `string` The login name of the user that created the attachment.

    Also returned as `attacher`, for backwards-compatibility with older Bugzillas. (However, this backwards-compatibility will go away in Bugzilla 5.0.)

  `flags`

    An array of hashes containing the information about flags currently set for each attachment. Each flag hash contains the following items:

    `id`

      `int` The id of the flag.

    `name`

      `string` The name of the flag.

    `type_id`

      `int` The type id of the flag.

    `creation_date`

      `dateTime` The timestamp when this flag was originally created.

    `modification_date`

      `dateTime` The timestamp when the flag was last modified.

    `status`

      `string` The current status of the flag.

    `setter`

      `string` The login name of the user who created or last modified the flag.

    `requestee`

      `string` The login name of the user this flag has been requested to be granted or denied. Note, this field is only returned if a requestee is set.

Errors

  This method can throw all the same errors as "get". In addition, it can also throw the following error:

  304 (Auth Failure, Attachment is Private)

    You specified the id of a private attachment in the `attachment_ids` argument, and you are not in the "insider group" that can see private attachments.

History
  Added in Bugzilla 3.6.
  In Bugzilla 4.0, the `attacher` return value was renamed to `creator`.
  In Bugzilla 4.0, the `description` return value was renamed to `summary`.
  The `data` return value was added in Bugzilla 4.0.
  In Bugzilla 4.2, the `is_url` return value was removed (this attribute no longer exists for attachments).
  The `size` return value was added in Bugzilla 4.4.
  The `flags` array was added in Bugzilla 4.4.

## comments

STABLE

Description

  This allows you to get data about comments, given a list of bugs and/or comment ids.

Params

  Note: At least one of `ids` or `comment_ids` is required.

  In addition to the parameters below, this method also accepts the standard include_fields and exclude_fields arguments.

  `ids`

    `array` An array that can contain both bug IDs and bug aliases. All of the comments (that are visible to you) will be returned for the specified bugs.

  `comment_ids`

    `array` An array of integer comment_ids. These comments will be returned individually, separate from any other comments in their respective bugs.

  `new_since`

    `dateTime` If specified, the method will only return comments newer than this time. This only affects comments returned from the `ids` argument. You will always be returned all comments you request in the `comment_ids` argument, even if they are older than this date.

Returns

  Two items are returned:

  `bugs`

    This is used for bugs specified in `ids`. This is a hash, where the keys are the numeric ids of the bugs, and the value is a hash with a single key, `comments`, which is an array of comments. (The format of comments is described below.)

    Note that any individual bug will only be returned once, so if you specify an id multiple times in `ids`, it will still only be returned once.

  `comments`

    Each individual comment requested in `comment_ids` is returned here, in a hash where the numeric comment id is the key, and the value is the comment. (The format of comments is described below.)

  A "comment" as described above is a hash that contains the following keys:

  id

    `int` The globally unique ID for the comment.

  bug_id

    `int` The ID of the bug that this comment is on.

  attachment_id

    `int` If the comment was made on an attachment, this will be the ID of that attachment. Otherwise it will be null.

  count

    `int` The number of the comment local to the bug. The Description is 0, comments start with 1.

  text

    `string` The actual text of the comment.

  creator

    `string` The login name of the comment's author.

    Also returned as `author`, for backwards-compatibility with older Bugzillas. (However, this backwards-compatibility will go away in Bugzilla 5.0.)

  time

    `dateTime` The time (in Bugzilla's timezone) that the comment was added.

  creation_time

    `dateTime` This is exactly same as the `time` key. Use this field instead of `time` for consistency with other methods including "get" and "attachments". For compatibility, `time` is still usable. However, please note that `time` may be deprecated and removed in a future release.

  is_private

    `boolean` True if this comment is private (only visible to a certain group called the "insidergroup"), False otherwise.

Errors

  This method can throw all the same errors as "get". In addition, it can also throw the following errors:

  110 (Comment Is Private)

    You specified the id of a private comment in the `comment_ids` argument, and you are not in the "insider group" that can see private comments.

  111 (Invalid Comment ID)

    You specified an id in the `comment_ids` argument that is invalid--either you specified something that wasn't a number, or there is no comment with that id.

History
  Added in Bugzilla 3.4.
  `attachment_id` was added to the return value in Bugzilla 3.6.
  In Bugzilla 4.0, the `author` return value was renamed to `creator`.
  `count` was added to the return value in Bugzilla 4.4.
  `creation_time` was added in Bugzilla 4.4.

## get

STABLE

Description

  Gets information about particular bugs in the database.

  Note: Can also be called as "get_bugs" for compatibilty with Bugzilla 3.0 API.

Params

  In addition to the parameters below, this method also accepts the standard include_fields and exclude_fields arguments.

  `ids`

    An array of numbers and strings.

    If an element in the array is entirely numeric, it represents a bug_id from the Bugzilla database to fetch. If it contains any non-numeric characters, it is considered to be a bug alias instead, and the bug with that alias will be loaded.

  `permissive` EXPERIMENTAL

    `boolean` Normally, if you request any inaccessible or invalid bug ids, Bug.get will throw an error. If this parameter is True, instead of throwing an error we return an array of hashes with a `id`, `faultString` and `faultCode` for each bug that fails, and return normal information for the other bugs that were accessible.

Returns

  Two items are returned:

  `bugs`

    An array of hashes that contains information about the bugs with the valid ids. Each hash contains the following items:

    `actual_time`

      `double` The total number of hours that this bug has taken (so far).

      If you are not in the time-tracking group, this field will not be included in the return value.

    `alias`

      `string` The unique alias of this bug.

    `assigned_to`

      `string` The login name of the user to whom the bug is assigned.

    `blocks`

      `array` of `int`s. The ids of bugs that are "blocked" by this bug.

    `cc`

      `array` of `string`s. The login names of users on the CC list of this bug.

    `classification`

      `string` The name of the current classification the bug is in.

    `component`

      `string` The name of the current component of this bug.

    `creation_time`

      `dateTime` When the bug was created.

    `creator`

      `string` The login name of the person who filed this bug (the reporter).

    `deadline`

      `string` The day that this bug is due to be completed, in the format `YYYY-MM-DD`.

      If you are not in the time-tracking group, this field will not be included in the return value.

    `depends_on`

      `array` of `int`s. The ids of bugs that this bug "depends on".

    `dupe_of`

      `int` The bug ID of the bug that this bug is a duplicate of. If this bug isn't a duplicate of any bug, this will be null.

    `estimated_time`

      `double` The number of hours that it was estimated that this bug would take.

      If you are not in the time-tracking group, this field will not be included in the return value.

    `flags`

      An array of hashes containing the information about flags currently set for the bug. Each flag hash contains the following items:

      `id`

        `int` The id of the flag.

      `name`

        `string` The name of the flag.

      `type_id`

        `int` The type id of the flag.

      `creation_date`

        `dateTime` The timestamp when this flag was originally created.

      `modification_date`

        `dateTime` The timestamp when the flag was last modified.

      `status`

        `string` The current status of the flag.

      `setter`

        `string` The login name of the user who created or last modified the flag.

      `requestee`

        `string` The login name of the user this flag has been requested to be granted or denied. Note, this field is only returned if a requestee is set.

    `groups`

      `array` of `string`s. The names of all the groups that this bug is in.

    `id`

      `int` The unique numeric id of this bug.

    `is_cc_accessible`

      `boolean` If true, this bug can be accessed by members of the CC list, even if they are not in the groups the bug is restricted to.

    `is_confirmed`

      `boolean` True if the bug has been confirmed. Usually this means that the bug has at some point been moved out of the `UNCONFIRMED` status and into another open status.

    `is_open`

      `boolean` True if this bug is open, false if it is closed.

    `is_creator_accessible`

      `boolean` If true, this bug can be accessed by the creator (reporter) of the bug, even if he or she is not a member of the groups the bug is restricted to.

    `keywords`

      `array` of `string`s. Each keyword that is on this bug.

    `last_change_time`

      `dateTime` When the bug was last changed.

    `op_sys`

      `string` The name of the operating system that the bug was filed against.

    `platform`

      `string` The name of the platform (hardware) that the bug was filed against.

    `priority`

      `string` The priority of the bug.

    `product`

      `string` The name of the product this bug is in.

    `qa_contact`

      `string` The login name of the current QA Contact on the bug.

    `remaining_time`

      `double` The number of hours of work remaining until work on this bug is complete.

      If you are not in the time-tracking group, this field will not be included in the return value.

    `resolution`

      `string` The current resolution of the bug, or an empty string if the bug is open.

    `see_also`

      UNSTABLE

      `array` of `string`s. The URLs in the See Also field on the bug.

    `severity`

      `string` The current severity of the bug.

    `status`

      `string` The current status of the bug.

    `summary`

      `string` The summary of this bug.

    `target_milestone`

      `string` The milestone that this bug is supposed to be fixed by, or for closed bugs, the milestone that it was fixed for.

    `update_token`

      `string` The token that you would have to pass to the process_bug.cgi page in order to update this bug. This changes every time the bug is updated.

      This field is not returned to logged-out users.

    `url`

      UNSTABLE

      `string` A URL that demonstrates the problem described in the bug, or is somehow related to the bug report.

    `version`

      `string` The version the bug was reported against.

    `whiteboard`

      `string` The value of the "status whiteboard" field on the bug.

    custom fields

      Every custom field in this installation will also be included in the return value. Most fields are returned as `string`s. However, some field types have different return values:

      Bug ID Fields - `int`
      Multiple-Selection Fields - `array` of `string`s.
      Date/Time Fields - `dateTime`
  `faults` EXPERIMENTAL

    An array of hashes that contains invalid bug ids with error messages returned for them. Each hash contains the following items:

    id

      `int` The numeric bug_id of this bug.

    faultString

      `string` This will only be returned for invalid bugs if the `permissive` argument was set when calling Bug.get, and it is an error indicating that the bug id was invalid.

    faultCode

      `int` This will only be returned for invalid bugs if the `permissive` argument was set when calling Bug.get, and it is the error code for the invalid bug error.

Errors
  100 (Invalid Bug Alias)

    If you specified an alias and there is no bug with that alias.

  101 (Invalid Bug ID)

    The bug_id you specified doesn't exist in the database.

  102 (Access Denied)

    You do not have access to the bug_id you specified.

History
  `permissive` argument added to this method's params in Bugzilla 3.4.
  The following properties were added to this method's return values in Bugzilla 3.4:
    For `bugs`
      assigned_to
      component
      dupe_of
      is_open
      priority
      product
      resolution
      severity
      status
    `faults`
  In Bugzilla 4.0, the following items were added to the `bugs` return value: `blocks`, `cc`, `classification`, `creator`, `deadline`, `depends_on`, `estimated_time`, `is_cc_accessible`, `is_confirmed`, `is_creator_accessible`, `groups`, `keywords`, `op_sys`, `platform`, `qa_contact`, `remaining_time`, `see_also`, `target_milestone`, `update_token`, `url`, `version`, `whiteboard`, and all custom fields.
  The `flags` array was added in Bugzilla 4.4.
  The `actual_time` item was added to the `bugs` return value in Bugzilla 4.4.

## history

EXPERIMENTAL

Description

  Gets the history of changes for particular bugs in the database.

Params
  `ids`

    An array of numbers and strings.

    If an element in the array is entirely numeric, it represents a bug_id from the Bugzilla database to fetch. If it contains any non-numeric characters, it is considered to be a bug alias instead, and the data bug with that alias will be loaded.

Returns

  A hash containing a single element, `bugs`. This is an array of hashes, containing the following keys:

  id

    `int` The numeric id of the bug.

  alias

    `string` The alias of this bug. If there is no alias, this will be undef.

  history

    `array` An array of hashes, each hash having the following keys:

    when

      `dateTime` The date the bug activity/change happened.

    who

      `string` The login name of the user who performed the bug change.

    changes

      `array` An array of hashes which contain all the changes that happened to the bug at this time (as specified by `when`). Each hash contains the following items:

      field_name

        `string` The name of the bug field that has changed.

      removed

        `string` The previous value of the bug field which has been deleted by the change.

      added

        `string` The new value of the bug field which has been added by the change.

      attachment_id

        `int` The id of the attachment that was changed. This only appears if the change was to an attachment, otherwise `attachment_id` will not be present in this hash.

Errors

  The same as "get".

History
  Added in Bugzilla 3.4.
  Field names returned by the `field_name` field changed to be consistent with other methods. Since Bugzilla 4.4, they now match names used by Bug.update for consistency.

## possible_duplicates

UNSTABLE

Description

  Allows a user to find possible duplicate bugs based on a set of keywords such as a user may use as a bug summary. Optionally the search can be narrowed down to specific products.

Params
  `summary` (string) Required - A string of keywords defining the type of bug you are trying to report.
  `product` (array) - One or more product names to narrow the duplicate search to. If omitted, all bugs are searched.
Returns

  The same as "get".

  Note that you will only be returned information about bugs that you can see. Bugs that you can't see will be entirely excluded from the results. So, if you want to see private bugs, you will have to first log in and then call this method.

Errors
  50 (Param Required)

    You must specify a value for `summary` containing a string of keywords to search for duplicates.

History
  Added in Bugzilla 4.0.

## search

UNSTABLE

Description

  Allows you to search for bugs based on particular criteria.

Params

  Unless otherwise specified in the description of a parameter, bugs are returned if they match exactly the criteria you specify in these parameters. That is, we don't match against substrings--if a bug is in the "Widgets" product and you ask for bugs in the "Widg" product, you won't get anything.

  Criteria are joined in a logical AND. That is, you will be returned bugs that match all of the criteria, not bugs that match any of the criteria.

  Each parameter can be either the type it says, or an array of the types it says. If you pass an array, it means "Give me bugs with any of these values." For example, if you wanted bugs that were in either the "Foo" or "Bar" products, you'd pass:

       product => ['Foo', 'Bar']

  Some Bugzillas may treat your arguments case-sensitively, depending on what database system they are using. Most commonly, though, Bugzilla is not case-sensitive with the arguments passed (because MySQL is the most-common database to use with Bugzilla, and MySQL is not case sensitive).

  `alias`

    `string` The unique alias for this bug.

  `assigned_to`

    `string` The login name of a user that a bug is assigned to.

  `component`

    `string` The name of the Component that the bug is in. Note that if there are multiple Components with the same name, and you search for that name, bugs in all those Components will be returned. If you don't want this, be sure to also specify the `product` argument.

  `creation_time`

    `dateTime` Searches for bugs that were created at this time or later. May not be an array.

  `creator`

    `string` The login name of the user who created the bug.

    You can also pass this argument with the name `reporter`, for backwards compatibility with older Bugzillas.

  `id`

    `int` The numeric id of the bug.

  `last_change_time`

    `dateTime` Searches for bugs that were modified at this time or later. May not be an array.

  `limit`

    `int` Limit the number of results returned to `int` records. If the limit is more than zero and higher than the maximum limit set by the administrator, then the maximum limit will be used instead. If you set the limit equal to zero, then all matching results will be returned instead.

  `offset`

    `int` Used in conjunction with the `limit` argument, `offset` defines the starting position for the search. For example, given a search that would return 100 bugs, setting `limit` to 10 and `offset` to 10 would return bugs 11 through 20 from the set of 100.

  `op_sys`

    `string` The "Operating System" field of a bug.

  `platform`

    `string` The Platform (sometimes called "Hardware") field of a bug.

  `priority`

    `string` The Priority field on a bug.

  `product`

    `string` The name of the Product that the bug is in.

  `resolution`

    `string` The current resolution--only set if a bug is closed. You can find open bugs by searching for bugs with an empty resolution.

  `severity`

    `string` The Severity field on a bug.

  `status`

    `string` The current status of a bug (not including its resolution, if it has one, which is a separate field above).

  `summary`

    `string` Searches for substrings in the single-line Summary field on bugs. If you specify an array, then bugs whose summaries match any of the passed substrings will be returned.

    Note that unlike searching in the Bugzilla UI, substrings are not split on spaces. So searching for `foo bar` will match "This is a foo bar" but not "This foo is a bar". `['foo', 'bar']`, would, however, match the second item.

  `target_milestone`

    `string` The Target Milestone field of a bug. Note that even if this Bugzilla does not have the Target Milestone field enabled, you can still search for bugs by Target Milestone. However, it is likely that in that case, most bugs will not have a Target Milestone set (it defaults to "---" when the field isn't enabled).

  `qa_contact`

    `string` The login name of the bug's QA Contact. Note that even if this Bugzilla does not have the QA Contact field enabled, you can still search for bugs by QA Contact (though it is likely that no bug will have a QA Contact set, if the field is disabled).

  `url`

    `string` The "URL" field of a bug.

  `version`

    `string` The Version field of a bug.

  `whiteboard`

    `string` Search the "Status Whiteboard" field on bugs for a substring. Works the same as the `summary` field described above, but searches the Status Whiteboard field.

Returns

  The same as "get".

  Note that you will only be returned information about bugs that you can see. Bugs that you can't see will be entirely excluded from the results. So, if you want to see private bugs, you will have to first log in and then call this method.

Errors

  If you specify an invalid value for a particular field, you just won't get any results for that value.

  1000 (Parameters Required)

    You may not search without any search terms.

History
  Added in Bugzilla 3.4.
  Searching by `votes` was removed in Bugzilla 4.0.
  The `reporter` input parameter was renamed to `creator` in Bugzilla 4.0.
  In 4.2.6 and newer, added the ability to return all results if `limit` is set equal to zero. Otherwise maximum results returned are limited by system configuration.

# Bug Creation and Modification

## create

STABLE

Description

  This allows you to create a new bug in Bugzilla. If you specify any invalid fields, an error will be thrown stating which field is invalid. If you specify any fields you are not allowed to set, they will just be set to their defaults or ignored.

  You cannot currently set all the items here that you can set on enter_bug.cgi.

  The WebService interface may allow you to set things other than those listed here, but realize that anything undocumented is UNSTABLE and will very likely change in the future.

Params

  Some params must be set, or an error will be thrown. These params are marked Required.

  Some parameters can have defaults set in Bugzilla, by the administrator. If these parameters have defaults set, you can omit them. These parameters are marked Defaulted.

  Clients that want to be able to interact uniformly with multiple Bugzillas should always set both the params marked Required and those marked Defaulted, because some Bugzillas may not have defaults set for Defaulted parameters, and then this method will throw an error if you don't specify them.

  The descriptions of the parameters below are what they mean when Bugzilla is being used to track software bugs. They may have other meanings in some installations.

  `product` (string) Required - The name of the product the bug is being filed against.
  `component` (string) Required - The name of a component in the product above.
  `summary` (string) Required - A brief description of the bug being filed.
  `version` (string) Required - A version of the product above; the version the bug was found in.
  `description` (string) Defaulted - The initial description for this bug. Some Bugzilla installations require this to not be blank.
  `op_sys` (string) Defaulted - The operating system the bug was discovered on.
  `platform` (string) Defaulted - What type of hardware the bug was experienced on.
  `priority` (string) Defaulted - What order the bug will be fixed in by the developer, compared to the developer's other bugs.
  `severity` (string) Defaulted - How severe the bug is.
  `alias` (string) - A brief alias for the bug that can be used instead of a bug number when accessing this bug. Must be unique in all of this Bugzilla.
  `assigned_to` (username) - A user to assign this bug to, if you don't want it to be assigned to the component owner.
  `cc` (array) - An array of usernames to CC on this bug.
  `comment_is_private` (boolean) - If set to true, the description is private, otherwise it is assumed to be public.
  `groups` (array) - An array of group names to put this bug into. You can see valid group names on the Permissions tab of the Preferences screen, or, if you are an administrator, in the Groups control panel. If you don't specify this argument, then the bug will be added into all the groups that are set as being "Default" for this product. (If you want to avoid that, you should specify `groups` as an empty array.)
  `qa_contact` (username) - If this installation has QA Contacts enabled, you can set the QA Contact here if you don't want to use the component's default QA Contact.
  `status` (string) - The status that this bug should start out as. Note that only certain statuses can be set on bug creation.
  `resolution` (string) - If you are filing a closed bug, then you will have to specify a resolution. You cannot currently specify a resolution of `DUPLICATE` for new bugs, though. That must be done with "update".
  `target_milestone` (string) - A valid target milestone for this product.

  In addition to the above parameters, if your installation has any custom fields, you can set them just by passing in the name of the field and its value as a string.

Returns

  A hash with one element, `id`. This is the id of the newly-filed bug.

Errors
  51 (Invalid Object)

    You specified a field value that is invalid. The error message will have more details.

  103 (Invalid Alias)

    The alias you specified is invalid for some reason. See the error message for more details.

  104 (Invalid Field)

    One of the drop-down fields has an invalid value, or a value entered in a text field is too long. The error message will have more detail.

  105 (Invalid Component)

    You didn't specify a component.

  106 (Invalid Product)

    Either you didn't specify a product, this product doesn't exist, or you don't have permission to enter bugs in this product.

  107 (Invalid Summary)

    You didn't specify a summary for the bug.

  116 (Dependency Loop)

    You specified values in the `blocks` or `depends_on` fields that would cause a circular dependency between bugs.

  120 (Group Restriction Denied)

    You tried to restrict the bug to a group which does not exist, or which you cannot use with this product.

  504 (Invalid User)

    Either the QA Contact, Assignee, or CC lists have some invalid user in them. The error message will have more details.

History
  Before 3.0.4, parameters marked as Defaulted were actually Required, due to a bug in Bugzilla.
  The `groups` argument was added in Bugzilla 4.0. Before Bugzilla 4.0, bugs were only added into Mandatory groups by this method. Since Bugzilla 4.0.2, passing an illegal group name will throw an error. In Bugzilla 4.0 and 4.0.1, illegal group names were silently ignored.
  The `comment_is_private` argument was added in Bugzilla 4.0. Before Bugzilla 4.0, you had to use the undocumented `commentprivacy` argument.
  Error 116 was added in Bugzilla 4.0. Before that, dependency loop errors had a generic code of `32000`.
  The ability to file new bugs with a `resolution` was added in Bugzilla 4.4.

## add_attachment

STABLE

Description

  This allows you to add an attachment to a bug in Bugzilla.

Params
  `ids`

    Required `array` An array of ints and/or strings--the ids or aliases of bugs that you want to add this attachment to. The same attachment and comment will be added to all these bugs.

  `data`

    Required `base64` or `string` The content of the attachment. If the content of the attachment is not ASCII text, you must encode it in base64 and declare it as the `base64` type.

  `file_name`

    Required `string` The "file name" that will be displayed in the UI for this attachment.

  `summary`

    Required `string` A short string describing the attachment.

  `content_type`

    Required `string` The MIME type of the attachment, like `text/plain` or `image/png`.

  `comment`

    `string` A comment to add along with this attachment.

  `is_patch`

    `boolean` True if Bugzilla should treat this attachment as a patch. If you specify this, you do not need to specify a `content_type`. The `content_type` of the attachment will be forced to `text/plain`.

    Defaults to False if not specified.

  `is_private`

    `boolean` True if the attachment should be private (restricted to the "insidergroup"), False if the attachment should be public.

    Defaults to False if not specified.

Returns

  A single item `ids`, which contains an array of the attachment id(s) created.

Errors

  This method can throw all the same errors as "get", plus:

  600 (Attachment Too Large)

    You tried to attach a file that was larger than Bugzilla will accept.

  601 (Invalid MIME Type)

    You specified a `content_type` argument that was blank, not a valid MIME type, or not a MIME type that Bugzilla accepts for attachments.

  603 (File Name Not Specified)

    You did not specify a valid for the `file_name` argument.

  604 (Summary Required)

    You did not specify a value for the `summary` argument.

  606 (Empty Data)

    You set the "data" field to an empty string.

History
  Added in Bugzilla 4.0.
  The `is_url` parameter was removed in Bugzilla 4.2.
  The return value has changed in Bugzilla 4.4.

## add_comment

STABLE

Description

  This allows you to add a comment to a bug in Bugzilla.

Params
  `id` (int or string) Required - The id or alias of the bug to append a comment to.
  `comment` (string) Required - The comment to append to the bug. If this is empty or all whitespace, an error will be thrown saying that you did not set the `comment` parameter.
  `is_private` (boolean) - If set to true, the comment is private, otherwise it is assumed to be public.
  `work_time` (double) - Adds this many hours to the "Hours Worked" on the bug. If you are not in the time tracking group, this value will be ignored.
Returns

  A hash with one element, `id` whose value is the id of the newly-created comment.

Errors
  54 (Hours Worked Too Large)

    You specified a `work_time` larger than the maximum allowed value of `99999.99`.

  100 (Invalid Bug Alias)

    If you specified an alias and there is no bug with that alias.

  101 (Invalid Bug ID)

    The id you specified doesn't exist in the database.

  109 (Bug Edit Denied)

    You did not have the necessary rights to edit the bug.

  113 (Can't Make Private Comments)

    You tried to add a private comment, but don't have the necessary rights.

  114 (Comment Too Long)

    You tried to add a comment longer than the maximum allowed length (65,535 characters).

History
  Added in Bugzilla 3.2.
  Modified to return the new comment's id in Bugzilla 3.4
  Modified to throw an error if you try to add a private comment but can't, in Bugzilla 3.4.
  Before Bugzilla 3.6, the `is_private` argument was called `private`, and you can still call it `private` for backwards-compatibility purposes if you wish.
  Before Bugzilla 3.6, error 54 and error 114 had a generic error code of 32000.

## update

UNSTABLE

Description

  Allows you to update the fields of a bug. Automatically sends emails out about the changes.

Params
  `ids`

    Array of `int`s or `string`s. The ids or aliases of the bugs that you want to modify.

  Note: All following fields specify the values you want to set on the bugs you are updating.

  `alias`

    (string) The alias of the bug. You can only set this if you are modifying a single bug. If there is more than one bug specified in `ids`, passing in a value for `alias` will cause an error to be thrown.

  `assigned_to`

    `string` The full login name of the user this bug is assigned to.

  `blocks`
  `depends_on`

    `hash` These specify the bugs that this bug blocks or depends on, respectively. To set these, you should pass a hash as the value. The hash may contain the following fields:

    `add` An array of `int`s. Bug ids to add to this field.
    `remove` An array of `int`s. Bug ids to remove from this field. If the bug ids are not already in the field, they will be ignored.
    `set` An array of `int`s. An exact set of bug ids to set this field to, overriding the current value. If you specify `set`, then `add` and `remove` will be ignored.
  `cc`

    `hash` The users on the cc list. To modify this field, pass a hash, which may have the following fields:

    `add` Array of `string`s. User names to add to the CC list. They must be full user names, and an error will be thrown if you pass in an invalid user name.
    `remove` Array of `string`s. User names to remove from the CC list. They must be full user names, and an error will be thrown if you pass in an invalid user name.
  `is_cc_accessible`

    `boolean` Whether or not users in the CC list are allowed to access the bug, even if they aren't in a group that can normally access the bug.

  `comment`

    `hash`. A comment on the change. The hash may contain the following fields:

    `body` `string` The actual text of the comment. Note: For compatibility with the parameters to "add_comment", you can also call this field `comment`, if you want.
    `is_private` `boolean` Whether the comment is private or not. If you try to make a comment private and you don't have the permission to, an error will be thrown.
  `comment_is_private`

    `hash` This is how you update the privacy of comments that are already on a bug. This is a hash, where the keys are the `int` id of comments (not their count on a bug, like #1, #2, #3, but their globally-unique id, as returned by "comments") and the value is a `boolean` which specifies whether that comment should become private (`true`) or public (`false`).

    The comment ids must be valid for the bug being updated. Thus, it is not practical to use this while updating multiple bugs at once, as a single comment id will never be valid on multiple bugs.

  `component`

    `string` The Component the bug is in.

  `deadline`

    `string` The Deadline field--a date specifying when the bug must be completed by, in the format `YYYY-MM-DD`.

  `dupe_of`

    `int` The bug that this bug is a duplicate of. If you want to mark a bug as a duplicate, the safest thing to do is to set this value and not set the `status` or `resolution` fields. They will automatically be set by Bugzilla to the appropriate values for duplicate bugs.

  `estimated_time`

    `double` The total estimate of time required to fix the bug, in hours. This is the total estimate, not the amount of time remaining to fix it.

  `groups`

    `hash` The groups a bug is in. To modify this field, pass a hash, which may have the following fields:

    `add` Array of `string`s. The names of groups to add. Passing in an invalid group name or a group that you cannot add to this bug will cause an error to be thrown.
    `remove` Array of `string`s. The names of groups to remove. Passing in an invalid group name or a group that you cannot remove from this bug will cause an error to be thrown.
  `keywords`

    `hash` Keywords on the bug. To modify this field, pass a hash, which may have the following fields:

    `add` An array of `strings`s. The names of keywords to add to the field on the bug. Passing something that isn't a valid keyword name will cause an error to be thrown.
    `remove` An array of `string`s. The names of keywords to remove from the field on the bug. Passing something that isn't a valid keyword name will cause an error to be thrown.
    `set` An array of `strings`s. An exact set of keywords to set the field to, on the bug. Passing something that isn't a valid keyword name will cause an error to be thrown. Specifying `set` overrides `add` and `remove`.
  `op_sys`

    `string` The Operating System ("OS") field on the bug.

  `platform`

    `string` The Platform or "Hardware" field on the bug.

  `priority`

    `string` The Priority field on the bug.

  `product`

    `string` The name of the product that the bug is in. If you change this, you will probably also want to change `target_milestone`, `version`, and `component`, since those have different legal values in every product.

    If you cannot change the `target_milestone` field, it will be reset to the default for the product, when you move a bug to a new product.

    You may also wish to add or remove groups, as which groups are valid on a bug depends on the product. Groups that are not valid in the new product will be automatically removed, and groups which are mandatory in the new product will be automaticaly added, but no other automatic group changes will be done.

    Note that users can only move a bug into a product if they would normally have permission to file new bugs in that product.

  `qa_contact`

    `string` The full login name of the bug's QA Contact.

  `is_creator_accessible`

    `boolean` Whether or not the bug's reporter is allowed to access the bug, even if he or she isn't in a group that can normally access the bug.

  `remaining_time`

    `double` How much work time is remaining to fix the bug, in hours. If you set `work_time` but don't explicitly set `remaining_time`, then the `work_time` will be deducted from the bug's `remaining_time`.

  `reset_assigned_to`

    `boolean` If true, the `assigned_to` field will be reset to the default for the component that the bug is in. (If you have set the component at the same time as using this, then the component used will be the new component, not the old one.)

  `reset_qa_contact`

    `boolean` If true, the `qa_contact` field will be reset to the default for the component that the bug is in. (If you have set the component at the same time as using this, then the component used will be the new component, not the old one.)

  `resolution`

    `string` The current resolution. May only be set if you are closing a bug or if you are modifying an already-closed bug. Attempting to set the resolution to any value (even an empty or null string) on an open bug will cause an error to be thrown.

    If you change the `status` field to an open status, the resolution field will automatically be cleared, so you don't have to clear it manually.

  `see_also`

    `hash` The See Also field on a bug, specifying URLs to bugs in other bug trackers. To modify this field, pass a hash, which may have the following fields:

    `add` An array of `strings`s. URLs to add to the field. Each URL must be a valid URL to a bug-tracker, or an error will be thrown.
    `remove` An array of `string`s. URLs to remove from the field. Invalid URLs will be ignored.
  `severity`

    `string` The Severity field of a bug.

  `status`

    `string` The status you want to change the bug to. Note that if a bug is changing from open to closed, you should also specify a `resolution`.

  `summary`

    `string` The Summary field of the bug.

  `target_milestone`

    `string` The bug's Target Milestone.

  `url`

    `string` The "URL" field of a bug.

  `version`

    `string` The bug's Version field.

  `whiteboard`

    `string` The Status Whiteboard field of a bug.

  `work_time`

    `double` The number of hours worked on this bug as part of this change. If you set `work_time` but don't explicitly set `remaining_time`, then the `work_time` will be deducted from the bug's `remaining_time`.

  You can also set the value of any custom field by passing its name as a parameter, and the value to set the field to. For multiple-selection fields, the value should be an array of strings.

Returns

  A `hash` with a single field, "bugs". This points to an array of hashes with the following fields:

  `id`

    `int` The id of the bug that was updated.

  `alias`

    `string` The alias of the bug that was updated, if this bug has an alias.

  `last_change_time`

    `dateTime` The exact time that this update was done at, for this bug. If no update was done (that is, no fields had their values changed and no comment was added) then this will instead be the last time the bug was updated.

  `changes`

    `hash` The changes that were actually done on this bug. The keys are the names of the fields that were changed, and the values are a hash with two keys:

    `added` (`string`) The values that were added to this field, possibly a comma-and-space-separated list if multiple values were added.
    `removed` (`string`) The values that were removed from this field, possibly a comma-and-space-separated list if multiple values were removed.

  Here's an example of what a return value might look like:

       {
         bugs => [
           {
             id    => 123,
             alias => 'foo',
             last_change_time => '2010-01-01T12:34:56',
             changes => {
               status => {
                 removed => 'NEW',
                 added   => 'ASSIGNED'
               },
               keywords => {
                 removed => 'bar',
                 added   => 'qux, quo, qui',
               }
             },
           }
         ]
       }

  Currently, some fields are not tracked in changes: `comment`, `comment_is_private`, and `work_time`. This means that they will not show up in the return value even if they were successfully updated. This may change in a future version of Bugzilla.

Errors

  This function can throw all of the errors that "get", "create", and "add_comment" can throw, plus:

  50 (Empty Field)

    You tried to set some field to be empty, but that field cannot be empty. The error message will have more details.

  52 (Input Not A Number)

    You tried to set a numeric field to a value that wasn't numeric.

  54 (Number Too Large)

    You tried to set a numeric field to a value larger than that field can accept.

  55 (Number Too Small)

    You tried to set a negative value in a numeric field that does not accept negative values.

  56 (Bad Date/Time)

    You specified an invalid date or time in a date/time field (such as the `deadline` field or a custom date/time field).

  112 (See Also Invalid)

    You attempted to add an invalid value to the `see_also` field.

  115 (Permission Denied)

    You don't have permission to change a particular field to a particular value. The error message will have more detail.

  116 (Dependency Loop)

    You specified a value in the `blocks` or `depends_on` fields that causes a dependency loop.

  117 (Invalid Comment ID)

    You specified a comment id in `comment_is_private` that isn't on this bug.

  118 (Duplicate Loop)

    You specified a value for `dupe_of` that causes an infinite loop of duplicates.

  119 (dupe_of Required)

    You changed the resolution to `DUPLICATE` but did not specify a value for the `dupe_of` field.

  120 (Group Add/Remove Denied)

    You tried to add or remove a group that you don't have permission to modify for this bug, or you tried to add a group that isn't valid in this product.

  121 (Resolution Required)

    You tried to set the `status` field to a closed status, but you didn't specify a resolution.

  122 (Resolution On Open Status)

    This bug has an open status, but you specified a value for the `resolution` field.

  123 (Invalid Status Transition)

    You tried to change from one status to another, but the status workflow rules don't allow that change.

History
  Added in Bugzilla 4.0.

## update_see_also

EXPERIMENTAL

Description

  Adds or removes URLs for the "See Also" field on bugs. These URLs must point to some valid bug in some Bugzilla installation or in Launchpad.

Params
  `ids`

    Array of `int`s or `string`s. The ids or aliases of bugs that you want to modify.

  `add`

    Array of `string`s. URLs to Bugzilla bugs. These URLs will be added to the See Also field. They must be valid URLs to `show_bug.cgi` in a Bugzilla installation or to a bug filed at launchpad.net.

    If the URLs don't start with `http://` or `https://`, it will be assumed that `http://` should be added to the beginning of the string.

    It is safe to specify URLs that are already in the "See Also" field on a bug--they will just be silently ignored.

  `remove`

    Array of `string`s. These URLs will be removed from the See Also field. You must specify the full URL that you want removed. However, matching is done case-insensitively, so you don't have to specify the URL in exact case, if you don't want to.

    If you specify a URL that is not in the See Also field of a particular bug, it will just be silently ignored. Invaild URLs are currently silently ignored, though this may change in some future version of Bugzilla.

  NOTE: If you specify the same URL in both `add` and `remove`, it will be added. (That is, `add` overrides `remove`.)

Returns

  `changes`, a hash where the keys are numeric bug ids and the contents are a hash with one key, `see_also`. `see_also` points to a hash, which contains two keys, `added` and `removed`. These are arrays of strings, representing the actual changes that were made to the bug.

  Here's a diagram of what the return value looks like for updating bug ids 1 and 2:

       {
         changes => {
             1 => {
                 see_also => {
                     added   => (an array of bug URLs),
                     removed => (an array of bug URLs),
                 }
             },
             2 => {
                 see_also => {
                     added   => (an array of bug URLs),
                     removed => (an array of bug URLs),
                 }
             }
         }
       }

  This return value allows you to tell what this method actually did. It is in this format to be compatible with the return value of a future `Bug.update` method.

Errors

  This method can throw all of the errors that "get" throws, plus:

  109 (Bug Edit Denied)

    You did not have the necessary rights to edit the bug.

  112 (Invalid Bug URL)

    One of the URLs you provided did not look like a valid bug URL.

  115 (See Also Edit Denied)

    You did not have the necessary rights to edit the See Also field for this bug.

History
  Added in Bugzilla 3.4.
  Before Bugzilla 3.6, error 115 had a generic error code of 32000.

## update_tags

UNSTABLE

Description

  Adds or removes tags on bugs.

Params
  `ids`

    Required `array` An array of ints and/or strings--the ids or aliases of bugs that you want to add or remove tags to. All the tags will be added or removed to all these bugs.

  `tags`

    Required `hash` A hash representing tags to be added and/or removed. The hash has the following fields:

    `add` An array of `string`s representing tag names to be added to the bugs.

      It is safe to specify tags that are already associated with the bugs--they will just be silently ignored.

    `remove` An array of `string`s representing tag names to be removed from the bugs.

      It is safe to specify tags that are not associated with any bugs--they will just be silently ignored.

Returns

  `changes`, a hash containing bug IDs as keys and one single value name "tags" which is also a hash, with `added` and `removed` as keys. See "update_see_also" for an example of how it looks like.

Errors

  This method can throw the same errors as "get".

History
  Added in Bugzilla 4.4.

<<