FishEye REST API

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.

Resources

/rest-service-fe/search-v1

Provides an API to execute FishEye queries against a repository.

Methods

/rest-service-fe/search-v1/query/{repository}?query &maxReturn

resource-wide template parameters
parameter value description

repository

string

name of the repository
Methods

GET

Execute a FishEye query against a specific repository.

request query parameters
parameter value description

query

string

FishEye query to execute

maxReturn

string

maximum number of results

available response representations:

  • 200 [ expand ]

    Example
    <?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.

/rest-service-fe/search-v1/queryAsRows/{repository}?query &maxReturn

resource-wide template parameters
parameter value description

repository

string

name of the repository
Methods

GET

Execute a FishEye query (that contains a "return" statement) against a specific repository.

request query parameters
parameter value description

query

string

FishEye query to execute (which must contain a "return" statement)

maxReturn

string

maximum number of results

available response representations:

  • 200 [ expand ]

    Example
    <?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.

/rest-service-fe/repositories-v1

Provides an API to list information about the repositories.

Methods

GET

List all the repositories.

available response representations:

  • 200 [ expand ]

    Example
    <?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.

/rest-service-fe/repositories-v1/{name}

resource-wide template parameters
parameter value description

name

string

name of the repository
Methods

GET

Get the information about a repository.

available response representations:

  • 200 [ expand ]

    Example
    <?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.

/rest-service-fe/changeset-v1

Provides an API to get a list of changesets from a repository.

Methods

/rest-service-fe/changeset-v1/listChangesets?rep &path &committer &comment &p4JobFixed &expand &beforeCsid

Methods

GET

List of changesets from a repository.

request query parameters
parameter value description

rep

string

name of the repository

path

string

repository path

committer

string

ID of the commiter

comment

string

comment to match

p4JobFixed

string

Perforce option to select the changesets marked as fixing

expand

string

expand query parameter to specify the maximum number of results

beforeCsid

string

parent of the changesets

available response representations:

/rest-service-fe/revisionData-v1

Provides an API for getting information about changesets and filerevisions indexed by fisheye.

Methods

/rest-service-fe/revisionData-v1/changesetList/{repository}?path &start &end &maxReturn

resource-wide template parameters
parameter value description

repository

string

the repository to query.
Methods

GET

Get a list of changesets on a repository.

request query parameters
parameter value description

path

string

restrict the changesets to those in this path, should be "/" to look at the whole repository.

start

string

only return changesets after this date.

end

string

only return changesets before this date.

maxReturn

string

the maximum number of changesets to return.

available response representations:

  • 200 [ expand ]

    Example
    <?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.

/rest-service-fe/revisionData-v1/pathList/{repository}?path

resource-wide template parameters
parameter value description

repository

string

the repository to query.
Methods

GET

Get a list of information about files and directories in a path.

request query parameters
parameter value description

path

string

the path to query, with respect to the fisheye repository root.

available response representations:

  • 200 [ expand ]

    Example
    <?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.

/rest-service-fe/revisionData-v1/revisionInfo/{repository}?path &revision

resource-wide template parameters
parameter value description

repository

string

the repository to query.
Methods

GET

request query parameters
parameter value description

path

string

the path of the filerevision, with respect to the fisheye repository root.

revision

string

the id of the filerevision to retrieve.

available response representations:

  • 200 [ expand ]

    Information about the specified filerevision.

/rest-service-fe/revisionData-v1/revisionTags/{repository}?path &revision

resource-wide template parameters
parameter value description

repository

string

the repository to query.
Methods

GET

request query parameters
parameter value description

path

string

the path of the filerevision, with respect to the fisheye repository root.

revision

string

the id of the filerevision to retrieve.

available response representations:

  • 200 [ expand ]

    A list of tags associated with this revision.

/rest-service-fe/revisionData-v1/pathHistory/{repository}?path

resource-wide template parameters
parameter value description

repository

string

the repository to query.
Methods

GET

Get a list of the file revisions for a specific path.

request query parameters
parameter value description

path

string

the path to query.

available response representations:

  • 200 [ expand ]

    Example
    <?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="2010-11-12T10:42:47.419+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="2010-11-12T10:42:47.419+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="2010-11-12T10:42:47.419+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.

/rest-service-fe/revisionData-v1/changeset/{repository}/{csid}

resource-wide template parameters
parameter value description

repository

string

the repository to query.

csid

string

the ChangesetID of the changeset to return.
Methods

GET

available response representations:

  • 200 [ expand ]

    The changeset specified by csid.

/rest-service-fe/server-v1

Provides general information about the server's configuration.

Methods

GET

Provides general information about the server's configuration.

available response representations:

  • 200 (serverInfo) [ expand ]

    Example
    <?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.4.2</releaseNumber>
        <buildDate>2010-11-12</buildDate>
    </version>
    <isFishEye>true</isFishEye>
    <isCrucible>false</isCrucible>
</serverInfo>

    Information about the server's configuration.

    XML Schema

    Source: 

    

    

    •