FTRPreview client API - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The FTRPreview client API is used to find an object using FTR Preview.

Argument

Description

Parameter 1

Paged query size

Parameter 1 default

50

Parameter 1 description

Enter a value to identify the page size, the normal query size will be used if not specified.

Parameter 1 type

Integer

Parameter 2

Enable show all for paged

Parameter 2 default

False

Parameter 2 description

The Show All button will be enabled when using paged queries, which allows the user to get all of the results

Parameter 2 type

Boolean

Parameter 3

Honor query limit for paged

Parameter 3 default

False

Parameter 3 description

If set to True, the user’s maximum query limit will be applied to paged queries.

Parameter 3 type

Boolean

Parameter 4

Enable light list view for paged

Parameter 4 default

False

Parameter 4 description

If set to True, the light list view will be enabled when using paged queries, which allows the user to get the results quicker.

Parameter 4 type

Boolean

Parameter 5

Select InterfaceDef to filter

Parameter 5 default

None

Parameter 5 description

Defines the interface definition to filter by when searching for complex objects.

Parameter 5 type

String

The FTRPreview method uses the FTRPreview client API to find objects using FTR Preview.