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

/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.3.6</releaseNumber>
        <buildDate>2010-08-24</buildDate>
    </version>
    <isFishEye>true</isFishEye>
    <isCrucible>false</isCrucible>
</serverInfo>

    Information about the server's configuration.

    XML Schema

    Source: fisheye.xsd 

    <xs:element name="serverInfo" type="serverInfo"/>

/revisionData-v1

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

Methods

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

resource-wide template parameters
parameter value description

repository

string

the repository to query.
Methods

GET

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:

/revisionData-v1/pathList/{repository}?path

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 to query, with respect to the fisheye repository root.

available response representations:

  • 200 [ expand ]

    A list of information about files and directories in the path.

/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.

/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.

/revisionData-v1/pathHistory/{repository}?path

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 to query.

available response representations:

  • 200 [ expand ]

    A list of the filerevisions of this path.

/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.

/repositories-v1

Methods

GET

available response representations:

/repositories-v1/{name}

resource-wide template parameters
parameter value description

name

string

Methods

GET

available response representations:

/changeset-v1

Methods

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

Methods

GET

request query parameters
parameter value description

rep

string

path

string

committer

string

comment

string

p4JobFixed

string

expand

string

beforeCsid

string

available response representations:

/search-v1

Methods

/search-v1/query/{repository}?query &maxReturn

resource-wide template parameters
parameter value description

repository

string

Methods

GET

request query parameters
parameter value description

query

string

maxReturn

string

available response representations:

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

resource-wide template parameters
parameter value description

repository

string

Methods

GET

request query parameters
parameter value description

query

string

maxReturn

string

available response representations: