![]() ![]() Fisheye indexes a new change set, or a user completes a review). You can write an Event Listener Module which will be called when something happens (e.g. Have Fisheye/Crucible push data to my application REST Service Plugin Module Tutorial for Fisheye.If you need to process the data before your application asks for (perhaps you just want to transfer a summary) you can write a REST module to provide a different interface to that provided by the standard Fisheye/Crucible REST interface. If you needed to use another protocol, you could write a Servlet Plugin Module and implement the protocol yourself. You should write a REST Client to do this. Pull data from Fisheye/Crucible into my application You can't access data in Fisheye/Crucible via SQL - if you want to use an SQL based tool you'll need to extract data via a REST Client and insert it into your reporting database. If you are using an external reporting tool you can write a REST Client to extract the data. If you want to display the report in Fisheye/Crucible, you can write a Servlet Plugin Module. Look through the list of use cases below and find those that best match yours. You can translate your requirements into a set of software components you will need to write. ![]() If you have an idea for making Fisheye/Crucible more useful to you, then this page helps you decide how to do it. You will also need to understand the plugin module types that Fisheye/Crucible supports and the REST and Java APIs which plugins use to access Fisheye/Crucible. To get started, you can follow a few tutorials. After you understand the process of developing with the Atlassian Plugin SDK, you need to understand the specifics of developing plugins for Fisheye and Crucible. 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.Fisheye and Crucible use the standard Atlassian Plugin Framework, so your first step should be to understand how to use the Atlassian Plugin SDK. For example, /foo returns a list of the foo items and /foo/ returns the full content of the foo identified by the given key.įisheye also provides a REST and XML-RPC API which is now deprecated. In other cases, this may include a generic resource name and key. In some cases, this may be a generic resource name such as /foo. resource-name-v1 identifies the versioned resource such as /reviews-v1.rest-service denotes the Crucible REST API ( rest-service-fe for Fisheye resources).webcontext is the webcontext under which Fisheye/Crucible is hosted (as configured in the element in the application's config.xml.host and port define the host and port where the Fisheye/Crucible application lives.Here is an explanation for each part of the URI: Fisheye/Crucible API ReferencesĪPI references are available at the following locations: Read the tutorials for examples of using the Fisheye/Crucible REST interface. If you would like to know more about REST in general, start with the Dare Obasanjo's blog post, Explaining REST to Damien Katz. Search reviews based on custom criteria.Retrieve user or committer information.Retrieve a list of Fisheye or Crucible projects.If you wish, you can request JSON instead of XML.īecause the REST API is based on open standards, you can use any web development language to access the API.Īn example use case would be a gadget that provides information about build recent changes to a source repository, or lists your open reviews.įisheye/Crucible's REST APIs provide the following capabilities: To use a REST API, your application will make an HTTP request and parse the response. Introduction to Fisheye/Crucible's REST APIsįisheye/Crucible's REST APIs provide access to resources (data entities) via URI paths. The Fisheye/Crucible REST interface provides a simple way for external application to talk to Fisheye and Crucible by making HTTP requests. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |