Parameters
|
Required
|
Interdependent
|
Optional
|
|
|
|
|
|
ROOT_LEVEL
|
CONTAINER_REF
|
ADD_ALL_TYPE
|
|
|
|
|
|
GROUP_OUT
|
|
|
SEARCH_TYPE
|
|
|
|
|
|
|
|
OBJECT_REF
|
|
|
|
|
|
|
|
|
|
If a parameter is listed in the table but is not defined below, then it has a common parameter definition. For descriptions of those parameters, see Common Webject Parameters. |
ADD_ALL_TYPE
If more than one type is specified in the ROOT_LEVEL parameter and this parameter is set to TRUE, a dummy type (of type wt.fc.Persistable) is returned with a display value of “All.”
CONTAINER_REF
The Unique Federation Identifier (UFID) of the organization context that should be used to retrieve the subtypes, provided the parameter SEARCH_TYPE is set to SOFT_TYPES or BOTH.
GROUP_OUT
The name of the output group containing the results. If this parameter is omitted, then the name of the output group is constructed by appending the string “-Output” to the webject name. This parameter is optional.
OBJECT_REF
The Unique Federation Identifier (UFID) of an existing object type that serves as the base object, and returns all descendants associated with types specified in the SEARCH_TYPE parameter.
ROOT_LEVEL
The object types that are the top-level nodes in the resulting group. The ROOT_LEVEL parameter is a required parameter that must contain one or more objects to be part of the resulting group.
SEARCH_TYPE
Specifies what type of descendants should be returned for each object type specified in the ROOT_LEVEL parameter.
• ROOT_TYPES—No descendants are returned, and only the types specified in the ROOT_LEVEL parameter are returned in the group.
• HARD_TYPES—Only descendants that are provide by PTC are returned along with the parent type.
• SOFT_TYPES—Only descendants that are customer-created are returned along with the parent type.
• BOTH—Descendants that are PTC-provided and customer-created types are returned along with the parent type.
