NetworkedPlanet | TMCore Web Services Guide |
This element is used wherever a refernce to a topic is required. It provides two different methods of identifying a topic when passed in to a web service operation and additionally provides a displayable label for a topic when received from a web service operation.
This element has the following structure:
<tm:topicref tref="OID
" psi="PSI
" displayname="NAME
" />
Identifies the referenced topic by its database object
identifier. The schema declares this attribute as OPTIONAL. The
attribute will always be present on
tm:topicref
elements received from web
service operations, but is optional on
tm:topicref
elements passed in to web service
operations (as long as the psi
attribute is
used to identify the topic by a subject identifier
instead).
Identifies the referenced topic by a subject identifier
for that topic. The schema declares this attribute as OPTIONAL.
The attribute will never be present on
tm:topicref
elements received from web
service operations, but may optionally be present on
tm:topicref
elements passed in to web service
operations.
Provides a displayable label for the referenced topic. The
schema declares this attribute as OPTIONAL. However, this
attribute is only used on tm:topicref
elements received from web service operations. This attribute
allows a client application to display a link to the topic
without the need to retrieve the topic to get a display name for
it.