QueryForDocsByQueue 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 QueryForDocsByQueue client API is used to query for a list of the documents current in the queue awaiting processing.

Argument

Description

Parameter 1

Primary interface

Parameter 1 default

None

Parameter 1 description

The interface definition used in the query.

Parameter 1 type

String

Parameter 2

Query results title

Parameter 2 default

None

Parameter 2 description

The title that will appear at the top of the query form.

Parameter 2 type

String

Parameter 3

Column set to present the results

Parameter 3 default

None

Parameter 3 description

The name of the column set that will be used to display the results of the query.

Parameter 3 type

String

The TEFDocInQueue method uses the QueryForDocsByQueue client API to return a list of the published documents in the queue.