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

This page contains details and examples for the search service.

Run Search Query without Return Clause

Description: Returns FishEye repository data from a custom EyeQL search.
The EyeQL query must not contain a return clause.

Parameters:

Parameter name Description Value range
query The desired EyeQL query to run An EyeQL query with spaces. Note that %20 is used in lieu of a space character in URLs

Method: GET

Status Code: 200

URL:

rest-service-fe/search-v1/query/RepositoryName?query=EyeqlQuery
URL Example:
http://localhost:6060/foo/rest-service-fe/search-v1/query/MyRepository?query=select%20revisions%20where%20comment%20matches%20fixed%20group%20by%20changeset
Example XML:
<fileRevisionKeyList>
<fileRevisionKey rev="1.5" path="CRU-715/CreditCardDisplayFormat.java"/>
<fileRevisionKey rev="1.47" path="test/ws/main.css"/>
</fileRevisionKeyList>
Example JSON:

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

Run Search Query with Return Clause

Description: Returns FishEye repository data from a custom EyeQL search.
The EyeQL query must contain a return clause. The query result is returned in the Tabular Query Result Data Type.

Parameters:

Parameter name Description Value range
query The desired EyeQL query to run An EyeQL query with spaces. Note that %20 is used in lieu of a space character in URLs

Method: GET

Status Code: 200

URL:

rest-service-fe/search-v1/queryAsRows/RepositoryName?query=EyeqlQuery
URL Example:
http://localhost:6060/foo/rest-service-fe/search-v1/queryAsRows/MyRepository
?query=select%20revisions%20where%20comment%20matches%20fixed%20group%20by%20changeset%20
return%20path,%20revision,%20author,%20date,%20csid,%20comment,%20tags,%20totalLines,%20linesAdded,%20linesRemoved,%20reviews
Example 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>
Example 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"]}
}



Related Links:

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