This is the reference section of the FishEye REST API.
For information about FishEye Plugin Development, visit the Development Hub
This documentation was automatically generated from the WADL.
The REST resources decribed on this page produce and consume serialized objects whose structure is described in XML Schema: fisheye.xsd.
Provides an API to get a list of changesets from a repository.
List of changesets from a repository.
| parameter | value | description |
|---|---|---|
|
rep |
name of the repository |
|
|
path |
repository path |
|
|
committer |
ID of the commiter |
|
|
comment |
comment to match |
|
|
p4JobFixed |
Perforce option to select the changesets marked as fixing |
|
|
expand |
expand query parameter to specify the maximum number of results |
|
|
beforeCsid |
parent of the changesets |
available response representations:
Provides an API to execute FishEye queries against a repository.
| parameter | value | description |
|---|---|---|
|
repository |
name of the repository |
Execute a FishEye query against a specific repository.
| parameter | value | description |
|---|---|---|
|
query |
FishEye query to execute |
|
|
maxReturn |
maximum number of results |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<fileRevisionKeyList>
<fileRevisionKey rev="1.1" path="test/readme.txt"/>
<fileRevisionKey rev="1.2" path="test/readme.txt"/>
<fileRevisionKey rev="1.3" path="test/readme.txt"/>
</fileRevisionKeyList>
Sample result for a FishEye query such as select revisions from dir /test.
| parameter | value | description |
|---|---|---|
|
repository |
name of the repository |
Execute a FishEye query (that contains a "return" statement) against a specific repository.
| parameter | value | description |
|---|---|---|
|
query |
FishEye query to execute (which must contain a "return" statement) |
|
|
maxReturn |
maximum number of results |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<tabularQueryResult>
<row>
<item xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">test/readme.txt</item>
<item xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1.1</item>
<item xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">peter</item>
</row>
<row>
<item xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">test/readme.txt</item>
<item xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1.2</item>
<item xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">peter</item>
</row>
<headings>
<heading>path</heading>
<heading>revision</heading>
<heading>author</heading>
</headings>
</tabularQueryResult>
Sample result for a FishEye query such as select revisions from dir /test return path, revision, author.
Provides general information about the server's configuration.
Provides general information about the server's configuration.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<serverInfo>
<timeZone>
<ID>Australia/Sydney</ID>
<rawOffset>36000000</rawOffset>
</timeZone>
<appHomeDir>/home/fisheye</appHomeDir>
<appInstanceDir>/var/fisheye</appInstanceDir>
<version>
<releaseNumber>2.5.0</releaseNumber>
<buildDate>2011-02-08</buildDate>
</version>
<isFishEye>true</isFishEye>
<isCrucible>false</isCrucible>
</serverInfo>
Information about the server's configuration.
Provides an API to list information about the repositories.
List all the repositories.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryList>
<repository repositoryState="RUNNING" name="project" finishedFullSlurp="true" enabled="true"/>
<repository repositoryState="STOPPED" name="project-hg" finishedFullSlurp="true" enabled="false"/>
</repositoryList>
Sample list of repositories registered to a FishEye instance.
| parameter | value | description |
|---|---|---|
|
name |
name of the repository |
Get the information about a repository.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repository repositoryState="RUNNING" name="project" finishedFullSlurp="true" enabled="true">
<path>project</path>
<url>com.sample.project</url>
</repository>
Sample information about a repository.
Provides an API for getting information about changesets and filerevisions indexed by fisheye.
| parameter | value | description |
|---|---|---|
|
repository |
the repository to query. |
Get a list of changesets on a repository.
| parameter | value | description |
|---|---|---|
|
path |
restrict the changesets to those in this path, should be "/" to look at the whole repository. |
|
|
start |
only return changesets after this date. |
|
|
end |
only return changesets before this date. |
|
|
maxReturn |
the maximum number of changesets to return. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<changesetIdList resultsTruncated="false">
<csid>MAIN:peter:20100101000000</csid>
<csid>MAIN:douglas:20100101000042</csid>
<csid>MAIN:ray:20100101000451</csid>
</changesetIdList>
A list of changesets on a repository.
| parameter | value | description |
|---|---|---|
|
repository |
the repository to query. |
Get a list of information about files and directories in a path.
| parameter | value | description |
|---|---|---|
|
path |
the path to query, with respect to the fisheye repository root. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pathList>
<pathInfo name="branches" headDeleted="false" dir="true"/>
<pathInfo name="tags" headDeleted="false" dir="true"/>
<pathInfo name="trunk" headDeleted="false" dir="true"/>
</pathList>
A list of information about files and directories in the path.
| parameter | value | description |
|---|---|---|
|
repository |
the repository to query. |
| parameter | value | description |
|---|---|---|
|
path |
the path of the filerevision, with respect to the fisheye repository root. |
|
|
revision |
the id of the filerevision to retrieve. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<fileRevision totalLines="451" fileRevisionState="CHANGED" rev="3" path="trunk/readme.txt" linesRemoved="0" linesAdded="409" date="2011-02-08T17:04:16.359+11:00" csid="MAIN:ray:2010451" contentLink="" author="ray" ancestor="2">
<comment>second revision</comment>
</fileRevision>
Information about the specified filerevision.
| parameter | value | description |
|---|---|---|
|
repository |
the repository to query. |
| parameter | value | description |
|---|---|---|
|
path |
the path of the filerevision, with respect to the fisheye repository root. |
|
|
revision |
the id of the filerevision to retrieve. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<tagList>
<tag>TAG1</tag>
<tag>TAG2</tag>
<tag>TAG3</tag>
</tagList>
A list of tags associated with this revision.
| parameter | value | description |
|---|---|---|
|
repository |
the repository to query. |
Get a list of the file revisions for a specific path.
| parameter | value | description |
|---|---|---|
|
path |
the path to query. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<fileRevisionList>
<fileRevision totalLines="30" fileRevisionState="ADDED" rev="1" path="trunk/readme.txt" linesRemoved="0" linesAdded="30" date="2011-02-08T17:04:16.359+11:00" csid="MAIN:peter:2010000" contentLink="" author="peter">
<comment>added readme</comment>
</fileRevision>
<fileRevision totalLines="42" fileRevisionState="CHANGED" rev="2" path="trunk/readme.txt" linesRemoved="0" linesAdded="12" date="2011-02-08T17:04:16.359+11:00" csid="MAIN:douglas:2010042" contentLink="" author="douglas" ancestor="1">
<comment>first revision</comment>
</fileRevision>
<fileRevision totalLines="451" fileRevisionState="CHANGED" rev="3" path="trunk/readme.txt" linesRemoved="0" linesAdded="409" date="2011-02-08T17:04:16.359+11:00" csid="MAIN:ray:2010451" contentLink="" author="ray" ancestor="2">
<comment>second revision</comment>
</fileRevision>
</fileRevisionList>
A list of the filerevisions of a path.
| parameter | value | description |
|---|---|---|
|
repository |
the repository to query. |
|
|
csid |
the ChangesetID of the changeset to return. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<changeset date="2011-02-08T17:04:16.360+11:00" csid="changeset_id" branch="branch" author="author">
<comment>comment</comment>
<fileRevisionKey rev="revision_id" path="dir/path/path/"/>
<fileRevisionKey rev="revision_id_2" path="dir2/path2/path2/"/>
</changeset>
The changeset specified by csid.