Testopia:Documentation:XMLRPC: Difference between revisions

Jump to navigation Jump to search

Testopia:Documentation:XMLRPC (view source)

Revision as of 22:05, 1 December 2006

1,309 bytes added ,  1 December 2006
no edit summary
No edit summary
No edit summary
Line 4: Line 4:
==What's New!==
==What's New!==
{| border=1 cellpadding=4
{| border=1 cellpadding=4
| 2006-11-27 ||
* Added [[Bugzilla_XML-RPC_API_Apache |instructions]] for using Basic Authorization with an Apache server
* New [[Bugzilla_XML-RPC_API_Query_Examples |query examples]] that do not use binary charts
* New API [[Bugzilla_XML-RPC_API#Objects |objects]]: '''Build''', '''Product''', and '''User'''
* New methods for [[Bugzilla_XML-RPC_API_TestPlan |TestPlan]] object
* New parameters added for managing query result sizes.  <b>pagesize</b> is used to set the number of records returned.  The default is 24.  <b>page</b> is used to return a page of results based on pagesize.  The default value for page is zero.  For example, setting page equal to zero will return the first 24 records.  Setting page equal to 1 will return the second set of 24 records.
The new parameters are added to any "list" method:
$proxy->call('TestPlan.list', {pagesize=>10, page=>0});
|-
| 2006-10-18 ||
* Added [[Bugzilla_XML-RPC_API_PerlSSL |Instructions]] for using SSL and Perl (SOAP::Lite) on SLED10
|-
| 2006-10-05 ||
* <b>Production</b> environment is https://apibugzilla.novell.com/tr_xmlrpc.cgi
* <b>Staging</b> environment is https://apibugzillastage.provo.novell.com/tr_xmlrpc.cgi
* <b>Test</b> environment is https://bugzilla.innerwebtest.novell.com/tr_xmlrpc.cgi
|-
| 2006-10-04 ||
* Added an example of an error response
|-
| 2006-09-21 ||  
| 2006-09-21 ||  
* Added code for <b>SSL (https)</b> access to the Java client (not necessary for Perl client)
* Added code for <b>SSL (https)</b> access to the Java client (not necessary for Perl client)
Line 11: Line 33:
|-
|-
|}
|}
==Requirements==
Testopia's XMLRPC relies on Bugzilla's webservice which won't be generally available until Bugzilla 3.0. You will need to download and install the WebService.pm file into your Bugzilla directory and the files found in Bugzilla/WebService. You can get the files from http://lxr.mozilla.org/bugzilla/source/Bugzilla/


==Project Description==
==Project Description==
Line 34: Line 53:
     </methodCall>  
     </methodCall>  


An exmple of an XML response:
An example of an XML response:


  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
Line 101: Line 120:
       </params>
       </params>
     </methodResponse>
     </methodResponse>
An example of an error response:
An example of an error response:


  <?xml version="1.0"?>
  <?xml version="1.0" encoding="UTF-8"?>
     <methodResponse>
     <methodResponse>
       <fault>
       <fault>
Line 132: Line 152:


{| border=1 cellpadding=4
{| border=1 cellpadding=4
| '''Programming Language''' || '''Software'''  
| '''Programming Language''' || '''Software''' || '''Special Notes'''
|-
|-
| Perl || [http://www.soaplite.com SOAP::Lite]
| Perl || [http://www.soaplite.com SOAP::Lite] || [[Bugzilla_XML-RPC_API_PerlSSL |Instructions]] for using SSL and Perl on SLED10
|-
|-
| Java || [http://ws.apache.org/xmlrpc Apache XML-RPC]
| Java || [http://ws.apache.org/xmlrpc Apache XML-RPC] ||
|-
|-
|}
|}
Line 150: Line 170:
  use XMLRPC::Lite;          # From the SOAP::Lite Module
  use XMLRPC::Lite;          # From the SOAP::Lite Module
    
    
  my $proxy = XMLRPC::Lite->proxy("http://company.com/bugzilla/tr_xmlrpc.cgi");
  my $proxy = XMLRPC::Lite->proxy("YOUR_URL_TO_BUGZILLA_GOES_HERE");
   
   
  # Result is a hash map
  # Result is a hash map
Line 255: Line 275:
   
   
      XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl();
      XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl();
      config.setServerURL(new URL("http://company.com/bugzilla/tr_xmlrpc.cgi"));
      config.setServerURL(new URL("/* YOUR_URL_TO_BUGZILLA_GOES_HERE */"));
      config.setBasicUserName("userid");
      config.setBasicUserName("userid");
      config.setBasicPassword("password");
      config.setBasicPassword("password");
Line 278: Line 298:
==API Documentation==
==API Documentation==


All XML-RPC requests are sent to a single Bugzilla CGI called <i>tr_xmlprc.cgi</i>.  Its locations will be based on your specific Bugzilla installation.  Normally the CGI will be found at the root URL of Bugzilla, for example, http://company.com/bugzilla/tr_xmlrpc.cgi
All XML-RPC requests are sent to a single Bugzilla CGI called <i>tr_xmlprc.cgi</i>.  Its location will be based on your specific Bugzilla installation.  Normally the CGI will be found at the root URL of Bugzilla, for example, http://bugzilla.company.com/tr_xmlrpc.cgi


===Objects===
===Objects===


* [[Testopia:Documentation:XMLRPC:TestPlan |TestPlan]]
* [[Bugzilla_XML-RPC_API_Build |Build]]
* [[Testopia:Documentation:XMLRPC:TestCase |TestCase]]
* [[Bugzilla_XML-RPC_API_Product |Product]]
* [[Testopia:Documentation:XMLRPC:TestRun |TestRun]]
* [[Bugzilla_XML-RPC_API_User |User]]
* [[Testopia:Documentation:XMLRPC:TestCaseRun |TestCaseRun]]
* [[Bugzilla_XML-RPC_API_TestPlan |TestPlan]]
* [[Bugzilla_XML-RPC_API_TestCase |TestCase]]
* [[Bugzilla_XML-RPC_API_TestRun |TestRun]]
* [[Bugzilla_XML-RPC_API_TestCaseRun |TestCaseRun]]




Line 291: Line 314:


# Where can I find more coding examples?
# Where can I find more coding examples?
#* [[Testopia:Documentation:XMLRPC:Code_Examples |Here]].
#* [[Bugzilla_XML-RPC_API_Code_Examples |Here]].
# Where can I find the query examples again?
# Where can I find the query examples again?
#* [[Testopia:Documentation:XMLRPC:Query_Examples |Here]].
#* [[Bugzilla_XML-RPC_API_Query_Examples |Here]].
# Where can I find how to setup Apache for use with the API and Basic Authentication?
#* [[Bugzilla_XML-RPC_API_Apache |Here]].
 
 




<br>Back to the [[Testopia |Testopia Main Page]]
<br>Back to the [[Testopia |Testopia Main Page]]
Ghendricks
141

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/43621"

Navigation menu