Parameters
|
Required
|
Interdependent
|
Optional
|
|
|
|
|
|
CONTAINER_REF
|
|
|
|
|
|
|
|
|
FOLDER_PATH
|
|
|
FOLDER_REF
|
GROUP_OUT
|
|
|
|
|
GROUP_IN
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
OBJECT_REF
|
|
|
|
|
|
|
|
|
TYPE
|
|
|
WHERE
|
|
|
|
|
|
|
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. |
CONTAINER_REF
A Windchill context to apply the webject against. This parameter accepts the following types of input:
• The UFID of a Windchill context. Multiple UFIDs can be specified for this parameter.
• MEMBERSHIP—The query finds only those contexts of which the user is a member.
When this parameter is specified, the scope of queries executed against the TYPE and WHERE parameters are restricted to the associated context.
FOLDER_PATH
The fully qualified path for the folder or cabinet to which the objects will be moved. If FOLDER_PATH is specified, the value of CONTAINER_REF is used to determine the context the FOLDER_PATH is relative to. If no CONTAINER_REF is specified, the exchange context is assumed. This parameter is mutually exclusive with FOLDER_REF.
FOLDER_REF
The UFID of the folder or cabinet to which the objects will be moved. This parameter is mutually exclusive with FOLDER_PATH.
GROUP_IN
The name of an input group containing the objects to move. The input group should contain one UFID per element (OBID attribute).
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 a Windchill object. Multiple values can be specified for this parameter to identify multiple objects.
This parameter can be used instead of or in combination with WHERE. If WHERE is not specified, then OBJECT_REF must be specified.
GROUP_IN can be specified instead of any combination of TYPE, WHERE, or OBJECT_REF.
TYPE
The object type name. If WHERE is specified, TYPE must also be specified. For more information, see
Specifying the TYPE and WHERE Parameters.
GROUP_IN can be specified instead of any combination of TYPE, WHERE, or OBJECT_REF.
WHERE
Specifies a query expression identifying the objects to be moved. This parameter can be used instead of or in combination with OBJECT_REF.
If OBJECT_REF is not specified, WHERE must be specified. If WHERE is specified, TYPE must also be specified. For more information, see
Specifying the TYPE and WHERE Parameters.
GROUP_IN can be specified instead of any combination of TYPE, WHERE, or OBJECT_REF.
