Delete-Objects
The Delete-Objects webject deletes Windchill objects. This webject can delete any object that Windchill allows to be deleted by its normal rules.
The objects are first fetched or queried for. As each object is deleted it is added to the output group. The operations are automatically performed within a transaction.
If one delete fails, all deletes are rolled back. If the objects are successfully deleted, then an output group containing the objects is returned. Otherwise, an exception is thrown.
Syntax
<ie:webject name="Delete-Objects" type="ACT">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute_name"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONTAINER_REF" data="[ufid | MEMBERSHIP]"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DESCRIPTOR" data="attribute_name"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_FILTER" data="group_name"/>
<ie:param name="GROUP_IN" data="group_in"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INCLUDE_ARGS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_CONSTRAINTS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_DESCRIPTORS" data="[TRUE | FALSE]"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="NEXT_OP" data="operation_name"/>
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="REFERENCE_DELIMITER" data="^"
<ie:param name="REFERENCE_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_OUTPUT_DELIMITER" data="^" />
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="UNFORMATTED" data="dataType" />
<ie:param name="WHERE" data="where_clause"/>
<ie:param name="WHERE_CASE_SENSITIVITY" data="[TRUE | FALSE]"/>
</ie:webject>
Parameters
|
Required
|
Interdependent
|
Optional
|
|
INSTANCE
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
CONTAINER_REF
|
ATTRIBUTE
|
|
DBUSER
|
CONNECTION_ATTEMPTS
|
|
DESCRIPTOR
|
CONNECTION_ATTEMPT_INTERVAL
|
|
GROUP_FILTER
|
FORMAT
|
|
INCLUDE_ARGS
|
GROUP_IN
|
|
INCLUDE_CONSTRAINTS
|
GROUP_OUT
|
|
INCLUDE_DESCRIPTORS
|
REFERENCE_DELIMITER
|
|
NEXT_OP
|
REFERENCE_OUTPUT_DELIMITER
|
|
OBJECT_REF
|
SESSION_ID
|
|
PASSWD
|
UNFORMATTED
|
|
REFERENCE_EXCEPTIONS
|
|
|
TYPE
|
|
|
WHERE
|
|
|
WHERE_CASE_SENSITIVITY
|
|
|
|
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 the section Common Webject Parameters in Adapter Webjects Overview. |
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.
GROUP_IN
The name of an input group containing one UFID per element (OBID attribute). This parameter is optional.
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.
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 identifying the objects for which to query. 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.
