FTR is a separate module installed only with SmartPlant Foundation that allows you to store, index, and search for text contained in objects. When FTR functionality is enabled, you must configure the FTR services to use the API services by setting the Available in Desktop Client property on the FTRPreview method.
The API Services metadata must be regenerated to incorporate any changes. For more
information, see Regenerate metadata.
Search across all exposed types
You can search across all exposed types configured for FTR by using the following example POST:
. . /api/v1/SearchAllTypes
using a request body of:
{"searchTerm": "Name"}
Search on a specific type
You can perform an FTR search on a specific type by using the following example GET:
. . /api/v1/Tags?$search=Name
The OData keywords $filter, $expand, and $orderby are not supported by SmartPlant
Foundation when used in conjunction with the $search keyword.