Usage

This function returns the ID numbers of ARDI assets based on text search.

NOTE - We suggest the much more powerful selector addon or the use of AQL when searching for assets, as these provide much more data and are significantly more flexible.

Details

DetailValue
GroupServer
From Server Version0.9.0
PermissionPublic
MethodsGET or POST
Parameters
ParameterNotesMeaning
qStringQuery
formatString (xml)Either 'xml' or 'json'

Return Value

The return value is a list of results that provide the asset name and ID numbers that match the q parameter.

The search works much the same way as normal ARDI searches - the system looks for exact name matches, partial name matches, ID matches and partial matches with asset descriptions.

Examples

Request
http://<servername>/s/<sitename>/api/search?q=Oven
Success (XML)
<results>
   <result id="20" name="Main Oven"/>
</results>
Success (JSON)
{
	"result": [{"id": "20", "name": "Main Oven"}]
}