The QueryClassObject client API is used to query for classified objects using Advanced Search and displays a list of available query types dependent on the methods to which the user has access.
Argument |
Description |
---|---|
Parameter 1 |
Relationship Definition to navigate to the Class Definition |
Parameter 1 default |
None |
Parameter 1 description |
Relationship Definition to navigate to the Class Definition used to derive the Class Definition to query from the classification object |
Parameter 1 type |
String |
Parameter 2 |
Allow classification tree drilldown |
Parameter 2 default |
True |
Parameter 2 description |
Allow classification tree drilldown. This parameter is not currently supported for methods used in the Web Client. |
Parameter 2 type |
Boolean |
Parameter 3 |
Name of classification |
Parameter 3 default |
None |
Parameter 3 description |
Name of classification |
Parameter 3 type |
String |
Parameter 4 |
Query results title |
Parameter 4 default |
None |
Parameter 4 description |
Query results title |
Parameter 4 type |
String |
Parameter 5 |
Primary interface override |
Parameter 5 default |
None |
Parameter 5 description |
Override Interface Definition used in queries that replaces primary Interface Definition |
Parameter 5 type |
String |
Parameter 6 |
Column set to present results |
Parameter 6 default |
None |
Parameter 6 description |
Name of the column set to present results |
Parameter 6 type |
String |
Parameter 7 |
Include Class Definition in query |
Parameter 7 default |
True |
Parameter 7 description |
If included, then only objects of this Class Definition and the specified Interface Definition will be returned, else objects of any Class Definition with the Interface Definition will be returned |
Parameter 7 type |
Boolean |
Parameter 8 |
Query filter - Property comparison |
Parameter 8 default |
None |
Parameter 8 description |
Query filter - Property comparison |
Parameter 8 type |
String |
Parameter 9 |
Configuration Behavior |
Parameter 9 default |
None |
Parameter 9 description |
Values NullConfigQuery, IgnoreConfigFilter, Blank, NullConfigQuery queries once for null config objects. IgnoreConfigFilter always queries selected configurations AND their parent configurations. Blank queries with regular configuration filtering |
Parameter 9 type |
String |
Parameter 10 |
Classification tree filtering/light view indicator |
Parameter 10 default |
None |
Parameter 10 description |
A ~ separated list of interfaces to perform classification tree filtering (optional).When using paged queries if it contains LIGHTVIEW then display results in light list view. ~ is used to separate LIGHTVIEW and interfaces. This parameter is not currently supported for methods used in the Web Client. |
Parameter 10 type |
String |
Parameter 11 |
Paged query size |
Parameter 11 default |
None |
Parameter 11 description |
Enter a value to identify the page size, if not specified then normal query will be used. This parameter is not currently supported for methods used in the Web Client. |
Parameter 11 type |
Integer |
Parameter 12 |
Enable show all for paged |
Parameter 12 default |
None |
Parameter 12 description |
When using paged queries will enable the show all button which allows the user to get all the data. This parameter is not currently supported for methods used in the Web Client. |
Parameter 12 type |
Boolean |
Parameter 13 |
Honor query limit for paged |
Parameter 13 default |
None |
Parameter 13 description |
When using paged queries if true then the users maximum query limit will be applied to the query. This parameter is not currently supported for methods used in the Web Client. |
Parameter 13 type |
Boolean |
Parameter 14 |
Enable light list view for paged |
Parameter 14 default |
None |
Parameter 14 description |
When using paged queries will enable the light list view which allows the user to get the data quicker. This parameter is not currently supported for methods used in the Web Client. |
Parameter 14 type |
Boolean |
Parameter 15 |
Enable extract all to excel for paged |
Parameter 15 default |
None |
Parameter 15 description |
When using paged queries will enable the extract all to excel button which allows the user to extract all the data to excel without displaying in listview. This parameter is not currently supported for methods used in the Web Client. |
Parameter 15 type |
Boolean |
Parameter 16 |
Classification expansion edgedef property comparison |
Parameter 16 default |
None |
Parameter 16 description |
Property comparison to be added to the edge definition, which is used for expansion of the classifications. |
Parameter 16 type |
String |
Many methods use this client API, and the list can be viewed in the Web Client. To see the methods in your system that use this client API, find the client API, right-click it, and click Show Methods.