Search

Description

Represents a list of assets that are specified by a query.

Parameters

Attribute Description Required
description The text that returned assets have in their descriptions No
guid The GUID that returned assets have No
lastModifiedBy The user who the returned assets were most recently modified by No
maxResults The maximum number of assets to return from the search No
name The text that returned assets have in their names No
owner The user who the returned assets have listed as one of their owners No
query A query to search for assets No
server The ID of the server that connects to Rational Asset Manager Yes, unless it is nested within an element that specified a server.
sortDirection The direction in which to sort the results. The following values are valid: asc, ascending, desc, and descending. No
sortVariable The variable to use when sorting the results. The following values are valid: attributeName, attributeValue, description, id, lastModifiedBy, name, owner, version, and score, which indicates relevance. No
version The text that returned assets have in their versions No

Parameters specified as nested elements

attribute

You can specify any number of attributes to the search. Only assets that have those attributes and that match those values are returned.

category

You can specify any number of categories to the search. Only assets that have those categories are returned.

Examples

Search for assets whose names contain "Test"

<search server="ramServer" query="name:(Test)"/>

Search for assets that have the Confidential attribute set to true

<search server="ramServer">
   <attribute name="Confidential" value="true" />
</search>