FishEye 2.1 : Data Types
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: RepositoryThis FishEye data type contains three basic details about a repository and its current operational state (on or off). Elements:
Sample XML: <repository enabled="true" name="cvs" repositoryState="RUNNING"/> {"enabled":"true", "name":"cvs", "repositoryState":"RUNNING"} Repository ListContains data as per the Repository data type, but for multiple repositories. Elements:
Sample XML: <repositoryList> <repository enabled="true" name="cvs" repositoryState="RUNNING"/> <repository enabled="true" name="cvs2" repositoryState="RUNNING"/> </repositoryList> {"repository":[ {"enabled":"true", "name":"cvs", "repositoryState":"RUNNING"}, {"enabled":"true", "name":"cvs2", "repositoryState":"RUNNING"} ]} File Revision KeyContains revision ID and the file's path inside a FishEye repository. Elements:
Sample XML: <fileRevisionKey rev="1.3" path="CRU-715/CardNumberFormatter.java"/> {"@rev":"1.3","@path":"CRU-715/CardNumberFormatter.java"} File Revision Key ListContains data as per the File Revision Key, but for multiple file revisions. Elements:
Sample XML: <fileRevisionKeyList> <fileRevisionKey rev="1.5" path="CRU-715/CreditCardDisplayFormat.java"/> <fileRevisionKey rev="1.47" path="test/ws/main.css"/> </fileRevisionKeyList> {"fileRevisionKey":[{"@rev":"1.5","@path":"CRU-715/CreditCardDisplayFormat.java"},{"@rev":"1.47","@path":"test/ws/main.css"}]} Path InfoContains information about a file or directory in FishEye. Elements:
Sample XML: <pathInfo name="CRU-715" headDeleted="false" dir="true"/> {"@name":"CRU-882","@headDeleted":"false","@dir":"true"} Path Info ListContains data as per Path Info but for multiple files or directories. Elements:
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> {"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 RevisionContains extensive information about a file revision. Elements:
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> {"@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 ListContains a list of multiple file revisions. The parameters are the same as for the File Revision data type. Elements:
Sample XML: <fileRevisionList> <fileRevision> ... </fileRevision> <fileRevision> ... </fileRevision> ... </fileRevisionList> {"fileRevision": [{...},{...},...]} ChangesetContains 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> {"@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 ListContains only the changeset ID from a changeset. Elements:
Sample XML: <changesetIdList resultsTruncated="false"> <csid>br-6168:anthony:20030408045825</csid> <csid>br-6168:anthony:20030407071221</csid> <csid>br-6168:anthony:20030407070713</csid> </changesetIdList> {"@resultsTruncated":"false", {"csid": ["br-6168:anthony:20030408045825", "br-6168:anthony:20030407071221", "br-6168:anthony:20030407070713"] } Tabular Query ResultContains the data returned form a eyeql query that specifies a return clause. Elements
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> {"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 ItemContains a list of zero or more strings. Elements
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> {"@type":"StringList","listItem":["build-MAIN-637","build-MAIN-638","build-MAIN-639","build-MAIN-640","build-MAIN-641"]}, MapList ItemContains the a list of sets of key-value pairs Elements
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> {"@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"} ]}] }
|
![]() |
Document generated by Confluence on Nov 11, 2009 21:21 |