NetworkedPlanet | TMCore Web Services Guide |
This action removes names, occurrences and/or identifiers from a specified topic. The content of this element specifies the topic to be updated, and lists the names, occurrences and identifiers to be removed.
This method allows two ways of specifying the items to be removed from a topic:
Deletion By Reference - names and
occurrences can be specified with the database object identifier
of the name or occurrence to be deleted in the
oid
attribute of the
tmd:name
, tmd:variant
or
tmd:occurrence
elements. The name, variant name
or occurrence with that OID will be deleted ONLY IF it is
contained within the topic specified by the request.
Deletion By Value - names, occurrences and identifiers can be specified for deletion by defining the complete value of the item to be matched. The value must match in all respects. For names, this means that the name string and scope must match; for variants, the name string or resource and scope must match; for occurrences, the data string or resource and the scope must match; and for identifiers just the identifier string must match. String values can be matched using the SQLServer wildcard operators _ and % to match a single character or a sequence of characters respectively.
In either case if a match is not found for an item to be deleted, this method WILL NOT fail, however if that the deletions are to be performed on cannot be found, the method WILL fail.
The DeleteTopicProperty element has the following structure
<txn:DeleteTopicProperty id="..."> <tmd:topic oid="..." subjectIdentifier="..." subjectLocator="..." sourceLocator="..." version="..."> ... </tmd:topic> </txn:DeleteTopicProperty>
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.
REQUIRED. Identifies the topic that deletions are to be performed on and contains the items to be deleted.
Identifies the topic to be updated by its database object identifier or the identifier assigned to the topic in a preceding CreateTopic action.
Identifies the topic to be updated by its subject
identifier. This attribute will be used only if no value is
provided for the oid
attribute.
OPTIONAL attribute. Identifies the topic to be updated by
its subject locator. This attribute will be used only if no
value is provided for the oid
and
subjectIdentifier
attributes.
OPTIONAL attribute. Identifies the topic to be updated by
its source locator. This attribute will be used only if no value
is provided for the oid
subjectIdentifier
, and
subjectLocator
attributes.
This OPTIONAL attribute identifies the version of the topic to be updated. The topic will only be updated if its current version number matches the value of this attribute. If the topic's current version number does not match the value specified here, then an error will be returned.
If this attribute is ommitted, the update will be applied to the latest version of the topic.
Although the Topic Map Fragment XML Schema allows the
oid
, subjectIdentifier
,
subjectLocator
and
sourceLocator
attributes to be ommitted, this
action requires that at least one of these attributes has a
value.