This page last changed on Jul 10, 2009 by edawson.

The revision data service provides information about the revision data contained in a FishEye instance.

On this page:

List of files and directories in a parent directory

Description: Returns a list of files and directories in a parent directory.

Parameters:

Parameter name Description Value range
path The path to the files or directories A repository path - see example

Method: GET

Status Code: 200

URL:

/rest-service-fe/revisionData-v1/pathList/RepositoryName?path=path

URL Example:

http://localhost:6060/foo/rest-service-fe/revisionData-v1/pathList/MyRepository

URL Example 2:

pathList/MyRepository?path=/

Example XML:

<pathList>
<pathInfo name="CRU-715" headDeleted="false" dir="true"/>
<pathInfo name="CRU-882" headDeleted="false" dir="true"/>
<pathInfo name="CVSROOT" headDeleted="false" dir="true"/>
<pathInfo name="emptytests" headDeleted="false" dir="true"/>
<pathInfo name="test" headDeleted="false" dir="true"/>
</pathList>

Example JSON:

{"pathInfo":[{"@name":"CRU-715","@headDeleted":"false","@dir":"true"},
{"@name":"CRU-882","@headDeleted":"false","@dir":"true"},
{"@name":"CVSROOT","@headDeleted":"false","@dir":"true"},
{"@name":"emptytests","@headDeleted":"false","@dir":"true"},
{"@name":"test","@headDeleted":"false","@dir":"true"}
]}

Example URL with the path specified

http://localhost:6060/foo/rest-service-fe/revisionData-v1/pathList/MyRepository?path=CRU-715

XML example with the path specified

<pathList>
<pathInfo name="CardNumberFormatter.java" headDeleted="false" dir="false"/>
<pathInfo name="CreditCardDisplayFormat.java" headDeleted="false" dir="false"/>
<pathInfo name="changelog.txt" headDeleted="false" dir="false"/>
<pathInfo name="spec.txt" headDeleted="false" dir="false"/>
</pathList>

JSON example with the path specified

{"pathInfo":[
{"@name":"CardNumberFormatter.java","@headDeleted":"false","@dir":"false"},
{"@name":"CreditCardDisplayFormat.java","@headDeleted":"false","@dir":"false"},
{"@name":"changelog.txt","@headDeleted":"false","@dir":"false"},
{"@name":"spec.txt","@headDeleted":"false","@dir":"false"}
]}

Revision history for a given path

Description: Returns all file revisions for a given path.

Parameters:

Parameter name Description Value range
path The path to the file revision A repository path - see examples

Method: GET

Status Code: 200

URL:

rest-service-fe/revisionData-v1/pathHistory/RepositoryName?path=path

URL Example:

http://localhost:6060/foo/rest-service-fe/revisionData-v1/pathHistory/MyRepository?path=CRU-715/CardNumberFormatter.java

Example XML:

<fileRevisionList>
<fileRevision totalLines="166" fileRevisionState="ADDED" rev="1.3" path="CRU-715/CardNumberFormatter.java"
linesRemoved="0" linesAdded="166" date="2003-05-06T16:14:39+10:00" csid="MAIN:anthony:20030506061426"
contentLink="/browse/~raw,r=1.3/MyRepository/CRU-715/CardNumberFormatter.java" author="anthony" ancestor="1.2">
<comment>6168:Merged from br-6168 (CR209)\n</comment>
</fileRevision>
<fileRevision totalLines="0" fileRevisionState="REMOVED" rev="1.2" path="CRU-715/CardNumberFormatter.java"
linesRemoved="13" linesAdded="0" date="2003-05-02T11:41:45+10:00" csid="MAIN:daniel:20030502014145"
contentLink="" author="daniel" ancestor="1.1">
<comment>7511: remove as part of - revert from CR166 release to production release build-MAIN-612\n</comment>
</fileRevision>
<fileRevision totalLines="166" fileRevisionState="CHANGED" rev="1.1.2.4" path="CRU-715/CardNumberFormatter.java"
linesRemoved="15" linesAdded="19" date="2003-04-08T14:58:25+10:00"
csid="br-6168:anthony:20030408045825"
contentLink="/browse/~raw,r=1.1.2.4/MyRepository/CRU-715/CardNumberFormatter.java" author="anthony"
ancestor="1.1.2.3">
<comment>6168: tender modifications to support encryption\n</comment>
</fileRevision>
<fileRevision totalLines="162" fileRevisionState="CHANGED" rev="1.1.2.3" path="CRU-715/CardNumberFormatter.java"
linesRemoved="2" linesAdded="8" date="2003-04-07T17:12:21+10:00" csid="br-6168:anthony:20030407071221"
contentLink="/browse/~raw,r=1.1.2.3/MyRepository/CRU-715/CardNumberFormatter.java" author="anthony"
ancestor="1.1.2.2">
<comment>6168: javadoc\n</comment>
</fileRevision>
<fileRevision totalLines="156" fileRevisionState="CHANGED" rev="1.1.2.2" path="CRU-715/CardNumberFormatter.java"
linesRemoved="20" linesAdded="1" date="2003-04-07T17:07:13+10:00"
csid="br-6168:anthony:20030407070713"
contentLink="/browse/~raw,r=1.1.2.2/MyRepository/CRU-715/CardNumberFormatter.java" author="anthony"
ancestor="1.1.2.1">
<comment>6168: slight mod to remove space on end of formatted number\n</comment>
</fileRevision>
<fileRevision totalLines="175" fileRevisionState="CHANGED" rev="1.1.2.1" path="CRU-715/CardNumberFormatter.java"
linesRemoved="0" linesAdded="162" date="2003-04-04T16:36:00+10:00"
csid="br-6168:anthony:20030404063600"
contentLink="/browse/~raw,r=1.1.2.1/MyRepository/CRU-715/CardNumberFormatter.java" author="anthony"
ancestor="1.1">
<comment>6168:cr209\n</comment>
</fileRevision>
<fileRevision totalLines="13" fileRevisionState="ADDED" rev="1.1" path="CRU-715/CardNumberFormatter.java"
linesRemoved="0" linesAdded="13" date="2003-04-04T15:27:46+10:00" csid="MAIN:anthony:20030404052746"
contentLink="/browse/~raw,r=1.1/MyRepository/CRU-715/CardNumberFormatter.java" author="anthony">
<comment>6168:checkin for branching - not used yet\n</comment>
</fileRevision>
</fileRevisionList>

Example JSON:

{"fileRevision":[
{"@totalLines":"166",
"@fileRevisionState":"ADDED",
"@rev":"1.3",
"@path":"CRU-715/CardNumberFormatter.java",
"@linesRemoved":"0",
"@linesAdded":"166",
"@date":"2003-05-06T16:14:39+10:00",
"@csid":"MAIN:anthony:20030506061426",
"@contentLink":"/browse/~raw,r=1.3/MyRepository/CRU-715/CardNumberFormatter.java",
"@author":"anthony",
"@ancestor":"1.2",
"comment":"6168:Merged from br-6168 (CR209)\n"},
{"@totalLines":"0",
"@fileRevisionState":"REMOVED",
"@rev":"1.2",
"@path":"CRU-715/CardNumberFormatter.java",
"@linesRemoved":"13",
"@linesAdded":"0",
"@date":"2003-05-02T11:41:45+10:00",
"@csid":"MAIN:daniel:20030502014145",
"@contentLink":"",
"@author":"daniel",
"@ancestor":"1.1",
"comment":"7511: remove as part of - revert from CR166 release to production release build-MAIN-612\n"},
{"@totalLines":"166",
"@fileRevisionState":"CHANGED",
"@rev":"1.1.2.4",
"@path":"CRU-715/CardNumberFormatter.java",
"@linesRemoved":"15","@linesAdded":"19",
"@date":"2003-04-08T14:58:25+10:00",
"@csid":"br-6168:anthony:20030408045825",
"@contentLink":"/browse/~raw,r=1.1.2.4/MyRepository/CRU-715/CardNumberFormatter.java",
"@author":"anthony",
"@ancestor":"1.1.2.3",
"comment":"6168: tender modifications to support encryption\n"},
{"@totalLines":"162",
"@fileRevisionState":"CHANGED",
"@rev":"1.1.2.3",
"@path":"CRU-715/CardNumberFormatter.java",
"@linesRemoved":"2",
"@linesAdded":"8",
"@date":"2003-04-07T17:12:21+10:00",
"@csid":"br-6168:anthony:20030407071221",
"@contentLink":"/browse/~raw,r=1.1.2.3/MyRepository/CRU-715/CardNumberFormatter.java",
"@author":"anthony",
"@ancestor":"1.1.2.2",
"comment":"6168: javadoc\n"},
{"@totalLines":"156",
"@fileRevisionState":"CHANGED",
"@rev":"1.1.2.2",
"@path":"CRU-715/CardNumberFormatter.java",
"@linesRemoved":"20","@linesAdded":"1",
"@date":"2003-04-07T17:07:13+10:00",
"@csid":"br-6168:anthony:20030407070713",
"@contentLink":"/browse/~raw,r=1.1.2.2/MyRepository/CRU-715/CardNumberFormatter.java",
"@author":"anthony",
"@ancestor":"1.1.2.1",
"comment":"6168: slight mod to remove space on end of formatted number\n"},
{"@totalLines":"175","@fileRevisionState":"CHANGED",
"@rev":"1.1.2.1",
"@path":"CRU-715/CardNumberFormatter.java",
"@linesRemoved":"0",
"@linesAdded":"162",
"@date":"2003-04-04T16:36:00+10:00",
"@csid":"br-6168:anthony:20030404063600",
"@contentLink":"/browse/~raw,r=1.1.2.1/MyRepository/CRU-715/CardNumberFormatter.java",
"@author":"anthony",
"@ancestor":"1.1",
"comment":"6168:cr209\n"},
{"@totalLines":"13",
"@fileRevisionState":"ADDED",
"@rev":"1.1",
"@path":"CRU-715/CardNumberFormatter.java",
"@linesRemoved":"0",
"@linesAdded":"13",
"@date":"2003-04-04T15:27:46+10:00",
"@csid":"MAIN:anthony:20030404052746",
"@contentLink":"/browse/~raw,r=1.1/MyRepository/CRU-715/CardNumberFormatter.java",
"@author":"anthony",
"comment":"6168:checkin for branching - not used yet\n"}]}

Details for a given changeset

Description: Returns details for a given changeset. This is in the format of the Changeset Data Type.

Parameters:

Parameter name Description Value range
changeset The desired changeset ID A changeset ID as determined by your SCM

Method: GET

Status Code: 200

URL:

rest-service-fe/revisionData-v1/changeset/RepositoryName/ChangesetId

URL Example:

http://localhost:6060/foo/rest-service-fe/revisionData-v1/changeset/MyRepository/MAIN:anthony:20030506061426

Example XML:

<changeset date="2003-05-06T16:14:39+10:00" csid="MAIN:anthony:20030506061426" branch="MAIN" author="anthony">
<comment>6168:Merged from br-6168 (CR209)\n</comment>
<fileRevisionKey rev="1.3" path="CRU-715/CardNumberFormatter.java"/>
<fileRevisionKey rev="1.4" path="CRU-715/CreditCardDisplayFormat.java"/>
</changeset>

Example JSON:

{"@date":"2003-05-06T16:14:39+10:00",
"@csid":"MAIN:anthony:20030506061426",
"@branch":"MAIN",
"@author":"anthony",
"comment":"6168:Merged from br-6168 (CR209)\n",
"fileRevisionKey":[
{"@rev":"1.3","@path":"CRU-715/CardNumberFormatter.java"},
{"@rev":"1.4","@path":"CRU-715/CreditCardDisplayFormat.java"}
]}

Details for a particular file revision

Description: Returns extensive information for a particular file revision. This is in the format of the File Revision Data Type.

Parameters:

Parameter name Description Value range
path The path to the file revision A repository path - see examples
revision The desired revision ID A revision ID as determined by your SCM

Method: GET

Status Code: 200

URL:

rest-service-fe/revisionData-v1/revisionInfo/RepositoryName?path=path&revision=revisionId

URL Example:

revisionInfo/MyRepository?path=CRU-715/CardNumberFormatter.java&revision=1.3

Example XML:

<fileRevision totalLines="166" fileRevisionState="ADDED" rev="1.3" path="CRU-715/CardNumberFormatter.java" linesRemoved="0" linesAdded="166" date="2003-05-06T16:14:39+10:00"
csid="MAIN:anthony:20030506061426" contentLink="/browse/~raw,r=1.3/MyRepository/CRU-715/CardNumberFormatter.java" author="anthony" ancestor="1.2">
<comment>6168:Merged from br-6168 (CR209)\n</comment>
</fileRevision>

Example JSON:

{"@totalLines":"166",
"@fileRevisionState":"ADDED",
"@rev":"1.3",
"@path":"CRU-715/CardNumberFormatter.java",
"@linesRemoved":"0",
"@linesAdded":"166",
"@date":"2003-05-06T16:14:39+10:00",
"@csid":"MAIN:anthony:20030506061426",
"@contentLink":"/browse/~raw,r=1.3/MyRepository/CRU-715/CardNumberFormatter.java",
"@author":"anthony",
"@ancestor":"1.2",
"comment":"6168:Merged from br-6168 (CR209)\n"}

List changesets in a directory

Description: Returns a list of all changesets in a directory. This is in the format of the Changeset ID Data Type.

Parameters:

Parameter name Description Value range
path The path to the file revision A repository path - see examples
start Used for defining a start date for results Date & time in ISO8601 format:
YYYY-MM-DDThh:mm:ss[+-]TIMEZONE

end Used for defining an end date for results Date & time in ISO8601 format:
YYYY-MM-DDThh:mm:ss[+-]TIMEZONE

maxReturn A limiter for the number of results displayed An integer

Start, end date (both ISO8601 format) and maxReturn are optional parameters.

Method: GET

Status Code: 200

URL:

rest-service-fe/revisionData-v1/changesetList/RepositoryName?path=path&start=startDate&end=endDate&maxReturn=maxReturn

URL Example:

http://localhost:6060/foo/rest-service-fe/revisionData-v1/changesetList/MyRepository?path=CRU-715&start=2009-12-23:12:13:14+10:00&end=2009-12-24:12:13:14+10:00

Example XML:

<changesetIdList resultsTruncated="false">
<csid>br-6168:anthony:20030408045825</csid>
<csid>br-6168:anthony:20030407071221</csid>
<csid>br-6168:anthony:20030407070713</csid>
</changesetIdList>

Example JSON:

{"@resultsTruncated":"false",
"csid":
["br-6168:anthony:20030408045825",
"br-6168:anthony:20030407071221",
"br-6168:anthony:20030407070713"]
}




Related Links:

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