The details of an existing issue can be retrieved from Ketura simply by sending an HTTP GET request to Ketura.
Python 2 example of getting the details of an existing issue
The following example is a Python script that will send a request to a local Ketura to return the details of an issue with id I1001. The details are returned as an XML file formatted as a Ketura recordset; the same format as the XML returned when clicking the XML link of a Ketura table.
This example uses the free
httplib2 library, which is not included as standard in most Python distributions. The
httplib2 library can be download from the
httplib2 website, which also has installation instructions.
#!/usr/bin/python2.5 # getIssueDetailsExample.py # Araxis Ketura API Script Example. # Copyright (c) 2009 Araxis Ltd. All rights reserved. # # Redistribution and use of this example code, with or without modification, are hereby permitted. # import required classes from modules from httplib2 import Http # start HTTP client client = Http() # add user name and password credentials client.add_credentials('es', 'pw') # declare information to be used on request url = "http://localhost:9453/Ketura/API/Issues/1001" # send request (resp_headers, content) = client.request(url, "GET") print content
|Accepted HTTP methods||OPTIONS*, HEAD**, GET|
* Sending an OPTIONS request will generate a response containing a WADL document. This document describes the services available from this resource path.
** Sending a HEAD request will only return the metadata of the resource without downloading the body. For example, a client can use the HEAD method to check whether the resource exists.
|Request media type||n/a|
|Successful response code||200|
|Authentication method||Basic HTTP Authentication|
|Response Code(s)||Significant Response Headers||Response||Response MIME Type|
|200||None||XML formatted as a Ketura recordset. The format is the same as the that returned when clicking the XML link of a Ketura table.||application/xml|
|401, 500 and greater||None||Text containing java stack trace||text/plain|
|Others||None||HTML error page||text/html|
|Name||Description||Always Returned||Can Be Empty||Maximum Size|
|IssueId||The id number of the issue.||yes||no||2147483647|
|IssueTopicName||The name of an existing topic to which the issue belongs.||yes||no||128 characters|
|Summary||A short description of the issue.||yes||no||255 characters|
|ReportedInIssueTopicVersion||The name of an subtopic or topic version in which this issue has been reported.||yes||yes||32 characters|
|ReportedInIssueTopicBuild||The build number for which this issue has been reported.||yes||yes||32 characters|
|FixedInIssueTopicVersion||The name of an subtopic or topic version in which this issue has been fixed.||yes||yes||32 characters|
|FixedInIssueTopicBuild||The build number for which this issue has been fixed.||yes||yes||32 characters|
|IssueType||The name of an existing issue type. This value is one of the named issue types specified in your Ketura system.||yes||no||64 characters|
|IssueState||The name of an existing issue state. This value is one of the named states specified in your Ketura system.||yes||no||32 characters|
|IssueSeverity||The name of an existing issue severity. This value is one of the named severities specified in your Ketura system.||yes||no||64 characters|
|Description||The full description of the issue.||yes||yes||15728640 characters|