Bugzilla:BzAPI:HowTo

This page is a repository for tips, tricks, ideas, code samples etc. for the Bugzilla REST API.

Ibuildings.nl BV have kindly contributed a PHP class for communicating with the BzAPI.

Example

Here is a simple example in JavaScript using XHR. It will return any bugs that you have ever commented on, that were also changed in the last day.

function handleResponse(response)
{
  var output = "";
  var json = JSON.parse(response);
  var bugs = json.bugs;

  for (var i = 0; i < bugs.length; i++) {
    output += bugs[i].id + ": " + bugs[i].summary + "\n";
  }

  alert(output);
}

function progressListener() {
  if (this.readyState == 4 && this.status == 200) {
    handleResponse(this.responseText);
  }
}

function getMyActiveBugs(bugzillaLogin)
{
  var apiURL = "https://api-dev.bugzilla.mozilla.org/0.3/bug" + 
               "?email1=" + bugzillaLogin +
               "&email1_type=equals_any&email1_comment_author=1" +
               "&changed_after=1d&changed_before=Now";
  
  var client = new XMLHttpRequest();
  client.onreadystatechange = progressListener;
  client.open("GET", apiURL);
  client.setRequestHeader('Accept',       'application/json');
  client.setRequestHeader('Content-Type', 'application/json');
  client.send();
}

getMyActiveBugs("gerv@mozilla.org");

Requests

There is no API equivalent of request.cgi, but you can get the same information via the standard search. Use the Boolean Charts, and the fields flag.requestee, flag.setter, product, component and flag to replicate the searches that request.cgi give you, and of course you can add in any other parameters you want to search on.

Flags are not returned in search results, so when you get the results back, make an individual request for each bug, in parallel if you like, to give you a full bug object including the flags. (There is currently no way of getting multiple full bug objects in a single request; if there is demand, we may add this to the API as a special case for searching on bug IDs only.) You can then take this list and filter or present it in whatever way you choose. And because you have the bug objects, you can change the flag fields and submit them back in order to update things.