QueryObjectWithHistory client API - SmartPlant Foundation - IM Update 48 - 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 QueryObjectWithHistory client API is used to query object data including terminated items found in configurations and display the results in a dedicated form.

Argument

Description

Parameter 1

Class Definition of the object to be queried

Parameter 1 default

None

Parameter 1 description

Name of the column set to present results

Parameter 1 type

String

Parameter 2

None

Parameter 2 default

None

Parameter 2 description

None

Parameter 2 type

None

Parameter 3

Default Query Form

Parameter 3 default

none

Parameter 3 description

The default query form UID

Parameter 3 type

String

Parameter 4

Query results title

Parameter 4 default

None

Parameter 4 description

The title of the query results

Parameter 4 type

String

Parameter 5

Primary interface override

Parameter 5 default

String

Parameter 5 description

The override Interface Definition used in queries that replaces Primary Interface Definition

Parameter 5 type

String

Parameter 6

Enable Revive

Parameter 6 default

False

Parameter 6 description

Gives the option to revive terminated data and bring it back into the system

Parameter 6 type

Boolean

Parameter 7

Include ClassDef in query

Parameter 7 default

True

Parameter 7 description

If included, then only objects of this Class Definition and specified interface definition are returned, otherwise objects of any Class Definition with the interface are returned

Parameter 7 type

Boolean, String, or Integer

Parameter 8

Query filter - Property comparison

Parameter 8 default

None

Parameter 8 description

The query filter property comparison

Parameter 8 type

String

The client API has no methods