The FishEye/Crucible REST interface provides a simple way for external application to talk to FishEye and Crucible by making HTTP requests.
FishEye/Crucible's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. By default, the response format is XML. If you wish, you can request JSON instead of XML.
Because the REST API is based on open standards, you can use any web development language to access the API.
An example use case would be a gadget that provides information about build recent changes to a source repository, or lists your open reviews.
FishEye/Crucible's REST APIs provide the following capabilities:
If you would like to know more about REST in general, start with the Dare Obasanjo's blog post, Explaining REST to Damien Katz.
Read the tutorials for examples of using the FishEye/Crucible REST interface.
How to Authenticate your REST Requests.
API references are available at the following locations:
|Application||REST API reference||API WADL|
|FishEye/Crucible common||FishEye/Crucible common REST API reference||API WADL|
|FishEye||FishEye REST API reference||API WADL|
|Crucible||Crucible REST API reference||API WADL|
You may find the WADL (Web Application Description Language) files generated for our REST API useful when writing REST clients. These are not human readable, but can be used to generate REST client stubs. The WADL files include their respective XML Schema documents that describe the structure of all possible request and response documents.
URIs for a FishEye/Crucible REST API resource have the following structure:
Here is an explanation for each part of the URI:
Fisheye also provides a REST and XML-RPC API which is now deprecated. It is documented here to assist in the maintenance of existing applications, but it will not be developed further and should not be used for new applications.