Parameters
|
Required
|
Interdependent
|
Optional
|
|
|
|
|
|
CONTAINER_REF
|
|
|
CONTENT_ITEM
|
|
|
|
|
|
|
|
|
|
GROUP_OUT
|
|
|
|
|
|
|
|
|
|
|
|
|
|
OBJECT_REF
|
|
|
|
|
|
|
|
|
STAGED_FILE_ID
|
|
|
STAGING_AREA
|
|
|
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.
CONTENT_ITEM
The UFID of the content item to be deleted. The content item is contained by the content holder object specified by the TYPE, WHERE, or OBJECT_REF parameters. The value for this parameter can be the OBID attribute returned in each element of the GROUP_OUT produced by the List-ContentItems webject. If STAGED_FILE_ID is not specified, then this parameter is required.
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.
STAGED_FILE_ID
The identifier of a previously staged content item to delete. The webject then deletes the specified staged content items and returns an empty output group. This parameter can have multiple values.
STAGING_AREA
A relative path to a file directory located on a server where content items that have been previously staged are now located.
The STAGING_AREA parameter is enabled only when an administrator has defined the wt.adapter.stagingAreaRoot property, which identifies the root file directory path of the staging area. The value specified for the STAGING_AREA parameter is appended to this property to create an absolute file path to the directory in which staged content items are stored. The wt.adapter.stagingAreaRoot property can be set in the wt.properties file
The absolute path for the staged files is:
stagingAreaRoot/STAGING_AREA/username
• stagingAreaRoot is the value defined for the wt.adapter.stagingAreaRoot property.
• STAGING_AREA is the value specified for this parameter.
• username is the user name of the current user.
If the current user has one or more alternate user names, you cannot predict or control which alternate name is used to build the staging area directory path.
TYPE
The object type name. If WHERE is specified, TYPE must also be specified. For more information, see
Specifying the TYPE and WHERE Parameters.
WHERE
A query expression that selects the content holder object from which content will be deleted. 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.
