This page last changed on Jun 29, 2009 by rosie@atlassian.com.

This page contains information about the FishEye URL structure for plugin developers. Knowing the structure, you will be able to construct hyperlinks for use in plugins or gadgets and find API specifications for your version of Fisheye.

On this page:

There is also a page about the Crucible structure.

FishEye-Specific URL Structure

Browse FishEye Repositories

This opens a window to browse the specified FishEye repositories.

In the example below, insert the desired constraints in place of "CONSTRAINT1" and "CONSTRAINT2" (you can have multiple constraints, separated by commas), the desired repository name in place of "REPNAME" and the repository path in place of 'PATH'.

Basic form

/browse/~CONSTRAINT1,CONSTRAINT2/REPNAME/PATH

Example with typical values

In the example below, the constraint "br" stands for the branch you want to constrain to, "CLOV" is the repository and "src" is the path inside the repository.

http://example.com/fisheye/browse/~br=clover2/CLOV/src

There are four constraint types that can be used: Branch ('br='); Author ('author='); Tag ('tag='); Date + Time ('date=YYYYMMDDTHH:MM:SS/repname').

Example using date and time constraint

In this example, from left to right; the date is expressed; a 'T' is inserted to denote the beginning of the time data; finally, the repository name is specified.

http://example.com/fisheye/browse/~date=20090119T23:15:01/CLOV


Search FishEye Repositories

This opens a window with search results from the specified query.

In the example below, insert your query parameters in place of 'QUERY', separated by commas; Enter the name of your repository in place of 'REPNAME'; insert the columns you want to display in place of 'CSV'.

Basic form

/search/REPNAME/?QUERY&CSV

Example with typical values

In the example below, the query is defining a filename ('test') then, three columns are defined in which to return data (in this case, path, author and changeset ID).

http://example.com/fisheye/search/CLOV/?filename=test&col=path&col=author&col=csid


RSS

This opens an RSS feed defined by the supplied constraints.

In the example below, insert your constraints in place of 'CONSTRAINT1' and 'CONSTRAINT2'; also insert the name of your repository in place of 'REPNAME'; the path inside the repository in place of 'PATH'; finally, insert the authentication token for this user in place of 'AUTHTOKEN'.

Basic form

/changelog/~rss,CONSTRAINT1,CONSTRAINT2/REPNAME/PATH?FEAUTH=AUTHTOKEN

Example with typical values

In the example below, 'br' is the branch inside the repository; 'feedspan' is the amount of time to span; 'feedmax' is the number of items to display.

http://example.com/fisheye/changelog/~rss,br=1.6,feedspan=2mo,feedmax=10/FE/rss.xml?FEAUTH=username:1324:e79b3f9d153795893b014ef5a4d59226

Note: You can retrieve an authToken for the current user via the API (go to /api in FishEye for more details).



API Help and Resources

The Original API

This opens a window showing the API documentation that ships with the product.

Basic form

/api

Example with typical values

http://example.com/fisheye/api


The REST API (introduced in version 1.6)

This opens a window with an XML-based description of all REST commands and their parameters. This page is in WADL format (Web Application Description Language).
Basic form

/rest-service/application.wadl

Example with typical values

http://example.com/fisheye/rest-service/application.wadl


Static content URL

For all external assets such as image files or gadgets, use this in the URL to avoid the random string mechanism that normally causes auto-refreshing of these assets.

Basic form

/currentstatic/...

Example with typical values

http://example.com/fisheye/currentstatic/logo.ico

Note that this redirects to the actual address (with a HTTP code of 302), which is randomly generated for each instance, for example /static/kbn4ib/images/... for browser caching purposes.

RDIFF Help

This opens a window with the embedded documentation on FishEye's RDIFF feature.

In the example below, insert the name of your repository in place of 'repname'.

Basic form

/rdiff/repname

Example with typical values

http://example.com/fisheye/rdiff/CLOV



Looking for a page on the Crucible URL structure? Click here.

Document generated by Confluence on Nov 11, 2009 21:21