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

This page contains information about the data types that are available in the FishEye REST API.

On this page:

Repository

This FishEye data type contains three basic details about a repository and its current operational state (on or off).

Elements:

Element name Description Value range
enabled Whether or not the repository is enabled true/false
name The repository name The name of the repository as it appears in FishEye
repositoryState The repository's operational state RUNNING / STOPPING / STOPPED / STARTING / UNKNOWN

Sample XML:

<repository enabled="true" name="cvs" repositoryState="RUNNING"/>
Sample JSON:

{"enabled":"true",
"name":"cvs",
"repositoryState":"RUNNING"}

Repository List

Contains data as per the Repository data type, but for multiple repositories.

Elements:

Element name Description Value range
enabled Whether or not the repository is enabled true/false
name The repository name The name of the repository as it appears in FishEye
repositoryState The repository's operational state RUNNING / STOPPING / STOPPED / STARTING / UNKNOWN

Sample XML:

<repositoryList>
<repository enabled="true" name="cvs" repositoryState="RUNNING"/>
<repository enabled="true" name="cvs2" repositoryState="RUNNING"/>
</repositoryList>
Sample JSON:

{"repository":[
{"enabled":"true",
"name":"cvs",
"repositoryState":"RUNNING"},
{"enabled":"true",
"name":"cvs2",
"repositoryState":"RUNNING"}
]}

File Revision Key

Contains revision ID and the file's path inside a FishEye repository.

Elements:

Element name Description Value range
rev Revision ID The revision ID as it appears in your SCM
path Path of the file Path of the file or directory within Fisheye, including the file or directory name (see examples)

Sample XML:

<fileRevisionKey rev="1.3" path="CRU-715/CardNumberFormatter.java"/>
Sample JSON:

{"@rev":"1.3","@path":"CRU-715/CardNumberFormatter.java"}

File Revision Key List

Contains data as per the File Revision Key, but for multiple file revisions.

Elements:

Element name Description Value range
rev Revision ID The revision ID as it appears in your SCM
path Path of the file Path of the file or directory within Fisheye, including the file or directory name (see examples)

Sample XML:

<fileRevisionKeyList>
<fileRevisionKey rev="1.5" path="CRU-715/CreditCardDisplayFormat.java"/>
<fileRevisionKey rev="1.47" path="test/ws/main.css"/>
</fileRevisionKeyList>

Sample JSON:

{"fileRevisionKey":[{"@rev":"1.5","@path":"CRU-715/CreditCardDisplayFormat.java"},{"@rev":"1.47","@path":"test/ws/main.css"}]}

Path Info

Contains information about a file or directory in FishEye.

Elements:

Element name Description Value range
name The name of the file or directory A file or directory name
headDeleted Whether or not the file or directory is deleted in the latest version of the trunk branch
true/false
dir Whether or not it is a directory true/false

Sample XML:

<pathInfo name="CRU-715" headDeleted="false" dir="true"/>

Sample JSON:

{"@name":"CRU-882","@headDeleted":"false","@dir":"true"}

Path Info List

Contains data as per Path Info but for multiple files or directories.

Elements:

Element name Description Value range
name The name of the file or directory A file or directory name
headDeleted Whether or not the file or directory is deleted in the latest version of the trunk branch true/false
dir Whether or not it is a directory true/false

Sample 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>
Sample 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"}
]}

File Revision

Contains extensive information about a file revision.

Elements:

Element name Description Value range
totalLines Total number of code lines in the file revision An integer
fileRevisionState The revision state of the file ADDED / REMOVED / CHANGED
rev The revision ID A revision ID as it appears in your SCM
path Path of the file Path of the file or directory within Fisheye, including the file or directory name (see examples)
linesRemoved Total number of code lines removed from the file revision An integer
linesAdded Total number of code lines added to the file revision An integer
date The date of the file revision YYYY-MM-DDThh:mm:ss
csid The ID of the changeset that contains the file revision A changeset ID as it appears in your SCM
contentLink Link to fisheye source A link to the raw source of the file revision in Fisheye
author The name of the committer who committed this file revision text
ancestor The revision ID of this file revision's ancestor The revision ID of the file revision that was modified to create this file revision
comment The commit comment The commit comment of this file revision

Sample 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/cvs/CRU-715/CardNumberFormatter.java" author="anthony" ancestor="1.2">
<comment>6168:Merged from br-6168 (CR209)\n</comment>
</fileRevision>
Sample 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/cvs/CRU-715/CardNumberFormatter.java",
"@author":"anthony",
"@ancestor":"1.2",
"comment":"6168:Merged from br-6168 (CR209)\n"}

File Revision List

Contains a list of multiple file revisions. The parameters are the same as for the File Revision data type.

Elements:

Element name Description Value range
as above    

Sample XML:

<fileRevisionList>
<fileRevision>
...
</fileRevision>
<fileRevision>
...
</fileRevision>
...
</fileRevisionList>

Sample JSON:

{"fileRevision":
[{...},{...},...]}

Changeset

Contains extensive changeset information.

Sample 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>

Sample 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"}
]}

Changeset ID List

Contains only the changeset ID from a changeset.

Elements:

Element name Description Value range
csid A given changeset ID Determined by the SCM in use

Sample XML:

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

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

Tabular Query Result

Contains the data returned form a eyeql query that specifies a return clause.

Elements

Element name Description Value range
headings A list of the returned elements (as specified in the eyeql return clause). List return clauses
row A row of data, containing the items specified in the return type. See below
item A returned data item. Specifies its type (string, date, integer, StringList or MapList) and value. See below
item (author) Author of the file revision as type xs:string The name of the committer as it appears in your SCM
item (comment) Commit comment as type xs:string The commit comment of this file revision
item (csid) Changeset ID as type xs:string A changeset ID as it appears in your SCM
item (date) Commit date as type xs:dateTime ISO YYYY-MM-DDThh:mm:ss
item (linesAdded) Number of lines added in this file revision as type xs:int An integer
item (linesRemoved) Number of lines removed in this file revision as type xs:int An integer
item (path) Path of the file as type xs:string Path of the file or directory within Fisheye, including the file or directory name (see examples)
item (reviews) Details of reviews containing this file revision as type MapList Keys are id, title, description, isDraft, isOpen, isClosed
item (revision) Revision of the file as type xs:string Path of the file or directory within Fisheye, including the file or directory name (see examples)
item (tags) List of tags that apply to this file revision as type StringList A list of zero or more strings
item (totalLines) Number of lines in the file revision as type xs:int An integer greater than or equal to zero

Sample XML:

<tabularQueryResult>
<row>
<item xsi:type="xs:string">CRU-715/CreditCardDisplayFormat.java</item>
<item xsi:type="xs:string">1.5</item>
<item xsi:type="xs:string">anthony</item>
<item xsi:type="xs:dateTime">2003-05-08T17:12:56+10:00</item>
<item xsi:type="xs:string">MAIN:anthony:20030508071256</item>
<item xsi:type="xs:string">
7636: fixed bug where x'ed out numbers not formatted right
</item>
<item xsi:type="StringList">
<listItem>build-MAIN-637</listItem>
<listItem>build-MAIN-638</listItem>
<listItem>build-MAIN-639</listItem>
<listItem>build-MAIN-640</listItem>
<listItem>build-MAIN-641</listItem>
</item>
<item xsi:type="xs:int">71</item>
<item xsi:type="xs:int">4</item>
<item xsi:type="xs:int">2</item>
<item xsi:type="MapList">
<map>
<mapItem value="CR-1" key="id"/>
<mapItem value="Test review" key="title"/>
<mapItem value="MAIN:anthony:20030508071256: 7636: fixed bug where x'ed out numbers not formatted right" key="description"/>
<mapItem value="Closed" key="state"/>
<mapItem value="false" key="isDraft"/>
<mapItem value="false" key="isOpen"/>
<mapItem value="true" key="isClosed"/>
</map>
<map>
<mapItem value="CR-2" key="id"/>
<mapItem value="7636: fixed bug where x'ed out numbers not formatted right" key="title"/>
<mapItem value="MAIN:anthony:20030508071256: 7636: fixed bug where x'ed out numbers not formatted right" key="description"/>
<mapItem value="Review" key="state"/>
<mapItem value="false" key="isDraft"/>
<mapItem value="true" key="isOpen"/>
<mapItem value="false" key="isClosed"/>
</map>
</item>
</row>
<row>
<item xsi:type="xs:string">test/ws/main.css</item>
<item xsi:type="xs:string">1.47</item>
<item xsi:type="xs:string">pete</item>
<item xsi:type="xs:dateTime">2004-04-06T17:20:26+10:00</item>
<item xsi:type="xs:string">MAIN:pete:20040406072026</item>
<item xsi:type="xs:string">
CRU-151: Fixed comment wrapping, CRU-84: added jump to changelog link to changeset
</item>
<item xsi:type="StringList"/>
<item xsi:type="xs:int">207</item>
<item xsi:type="xs:int">3</item>
<item xsi:type="xs:int">3</item>
<item xsi:type="MapList"/>
</row>
<headings>
<heading>path</heading>
<heading>revision</heading>
<heading>author</heading>
<heading>date</heading>
<heading>csid</heading>
<heading>comment</heading>
<heading>tags</heading>
<heading>totalLines</heading>
<heading>linesAdded</heading>
<heading>linesRemoved</heading>
<heading>reviews</heading>
</headings>
</tabularQueryResult>
Sample JSON:

{"row":[
{"item":[
{"@type":"xs:string","$":"CRU-715/CreditCardDisplayFormat.java"},
{"@type":"xs:string","$":"1.5"},
{"@type":"xs:string","$":"anthony"},
{"@type":"xs:dateTime","$":"2003-05-08T17:12:56+10:00"},
{"@type":"xs:string","$":"MAIN:anthony:20030508071256"},
{"@type":"xs:string","$":"7636: fixed bug where x'ed out numbers not formatted right\n"},
{"@type":"StringList","listItem":["build-MAIN-637","build-MAIN-638","build-MAIN-639","build-MAIN-640","build-MAIN-641"]},
{"@type":"xs:int","$":"71"},
{"@type":"xs:int","$":"4"},
{"@type":"xs:int","$":"2"},
{"@type":"MapList","map":[
{"mapItem":[
{"@value":"CR-1","@key":"id"},
{"@value":"Test review","@key":"title"},
{"@value":"objectives","@key":"description"},
{"@value":"Closed","@key":"state"},
{"@value":"false","@key":"isDraft"},
{"@value":"false","@key":"isOpen"},
{"@value":"true","@key":"isClosed"}
]},
{"mapItem":[
{"@value":"CR-2","@key":"id"},
{"@value":"7636: fixed bug where x'ed out numbers not formatted right","@key":"title"},
{"@value":"MAIN:anthony:20030508071256: 7636: fixed bug where x'ed out numbers not formatted right","@key":"description"},
{"@value":"Review","@key":"state"},
{"@value":"false","@key":"isDraft"},
{"@value":"true","@key":"isOpen"},
{"@value":"false","@key":"isClosed"}
]}]
}
]},
{"item":[
{"@type":"xs:string","$":"test/ws/main.css"},
{"@type":"xs:string","$":"1.47"},
{"@type":"xs:string","$":"pete"},
{"@type":"xs:dateTime","$":"2004-04-06T17:20:26+10:00"},
{"@type":"xs:string","$":"MAIN:pete:20040406072026"},
{"@type":"xs:string","$":"CRU-151: Fixed comment wrapping, CRU-84: added jump to changelog link to changeset\n"},
{"@type":"StringList"},
{"@type":"xs:int","$":"207"},
{"@type":"xs:int","$":"3"},
{"@type":"xs:int","$":"3"},
{"@type":"MapList"}
]}
],
"headings":
{"heading":["path","revision","author","date","csid","comment","tags","totalLines","linesAdded","linesRemoved","reviews"]}
}

StringList Item

Contains a list of zero or more strings.

Elements

Element name Description Value range
listItem A string A string

Sample XML:

<item xsi:type="StringList">
<listItem>build-MAIN-637</listItem>
<listItem>build-MAIN-638</listItem>
<listItem>build-MAIN-639</listItem>
<listItem>build-MAIN-640</listItem>
<listItem>build-MAIN-641</listItem>
</item>
Sample JSON:

{"@type":"StringList","listItem":["build-MAIN-637","build-MAIN-638","build-MAIN-639","build-MAIN-640","build-MAIN-641"]},

MapList Item

Contains the a list of sets of key-value pairs

Elements

Element name Description Value range
map A set of mapList items  
mapItem Contains a key string and a value string  

Sample XML:

<item xsi:type="MapList">
<map>
<mapItem value="CR-1" key="id"/>
<mapItem value="Test review" key="title"/>
<mapItem value="MAIN:anthony:20030508071256: 7636: fixed bug where x'ed out numbers not formatted right" key="description"/>
<mapItem value="Closed" key="state"/>
<mapItem value="false" key="isDraft"/>
<mapItem value="false" key="isOpen"/>
<mapItem value="true" key="isClosed"/>
</map>
<map>
<mapItem value="CR-2" key="id"/>
<mapItem value="7636: fixed bug where x'ed out numbers not formatted right" key="title"/>
<mapItem value="MAIN:anthony:20030508071256: 7636: fixed bug where x'ed out numbers not formatted right" key="description"/>
<mapItem value="Review" key="state"/>
<mapItem value="false" key="isDraft"/>
<mapItem value="true" key="isOpen"/>
<mapItem value="false" key="isClosed"/>
</map>
</item>
Sample JSON:

{"@type":"MapList","map":[
{"mapItem":[
{"@value":"CR-1","@key":"id"},
{"@value":"Test review","@key":"title"},
{"@value":"objectives","@key":"description"},
{"@value":"Closed","@key":"state"},
{"@value":"false","@key":"isDraft"},
{"@value":"false","@key":"isOpen"},
{"@value":"true","@key":"isClosed"}
]},
{"mapItem":[
{"@value":"CR-2","@key":"id"},
{"@value":"7636: fixed bug where x'ed out numbers not formatted right","@key":"title"},
{"@value":"MAIN:anthony:20030508071256: 7636: fixed bug where x'ed out numbers not formatted right","@key":"description"},
{"@value":"Review","@key":"state"},
{"@value":"false","@key":"isDraft"},
{"@value":"true","@key":"isOpen"},
{"@value":"false","@key":"isClosed"}
]}]
}




Related Links:

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