In your API code, you may need to perform actions on records that meet specified criteria, particularly as part of a rule specification. For example, before integrating with a billing system, a rule may search the database for all task records added to a matter within a period of time.

Search in the API using ResourceService.search(), which provides similar functionality to search views in the TeamConnect user interface.

Because searching may drastically affect performance, verify that there is no other way to get the desired list of records. If you must conduct a search, especially against a large number of records, narrow your search criteria and consider providing a time-out.

Before using the search() methods, consider using available predefined methods to get related records. For example, the User interface has the getContact() method to obtain the contact of a user. The Project interface has methods for obtaining a list of child or involved records.

The following table provides examples of records that custom code is likely to includes as part of a search and whether or not an alternative exists.

To Search or Not to Search