NetworkedPlanet | TMCore Web Services Guide |
This action element deletes an association from the database.
The association to be deleted can be identified either by its database
object identifier or by specifying the structure of the association to
be deleted. The DeleteAssociation
element has the
following structure:
<txn:DeleteAssociation id="..."> <tmd:association oid="..." sourceLocator="..." version="..."> ... </tmd:association> </txn:DeleteAssociation>
The wrapper element for this action.
The identifier for this operation. This identifier is used to correlate any error messages to the operation that caused the error.
Specifies the association to be deleted. If the
oid
attribute is present with a value, then
the association whose database object identifier matches the
attribute value will be deleted. Otherwise the association which
matches the structure defined by the content of this element
will be deleted.
OPTIONAL. Specifies the database object identifier of the association to be deleted. If this attribute is present, then the association whose database object identifier matches the attribute value will be deleted.
OPTIONAL. Specifies the source locator of the association
to be deleted. This attribute will be processed only if the
oid
attribute is not present.
This OPTIONAL attribute identifies the version of the association to be deleted. The association will only be updated if its current version number matches the value of this attribute. If the association's current version number does not match the value specified here, then an error will be returned.
If this attribute is ommitted, the association will be deleted regardless of the current version number.
If both the oid
and
sourceLocator
attributes are omitted, then the
association which matches the structure defined by the content of this
element will be deleted. When matching the association by its
structure, the association type, the scope of the association, the
number of association roles and the role type and role player of each
role are all considered and must all match. Some degree of wildcarding
is allowed in specifying the match structure - the association type
and the role type and role player of each role can be specified as a
wildcard using "-1" (without the double quotes) as the value of the
oid
attribute of the type
,
roletype
or player
elements.