NetworkedPlanet | TMCore Web Services Guide |
This element contains all of the information about a single association. The element has the following syntax:
<tm:association oid="OID
" version="VERSION"> <tm:sourceLocators> <tm:locator href="URI
"/> </tm:sourceLocators> <tm:type displayname="NAME
" tref="OID
" psi="PSI
"/> <tm:playsrole displayname="NAME
" tref="OID
" psi="PSI
"> <tm:label>STRING
</tm:label> <tm:role> <tm:sourceLocators> <tm:locator href="URI
"/> </tm:sourceLocators> <tm:type displayname="NAME
" tref="OID
" psi="PSI
"/> <tm:player displayname="NAME
" tref="OID
" psi="PSI
"/> </tm:role> <tm:scope> ... </tm:scope> </tm:association>
Contains the unique object identifier of the association. This attribute is OPTIONAL - it may be omitted when specifying a new association to add to the topic map.
Specifies the version number of the association. This
attribute is OPTIONAL. This attribute will always be present on
tm:association
elements received from web
service operations and will show the latest version number of
the association. If present on tm:association
elements passed in to web service operations, this attribute
identifies the version of the association to be
used/updated.
Contains a list of the source locators for this association. This element is OPTIONAL.
Contain a single source locator URI for this association. This attribute is REQUIRED.
References the topic that defines the type of this association. This element is OPTIONAL. If not present, the association is untyped.
Contains a display label for the topic that defines the type of this association. This attribute is OPTIONAL.
Contains the object identifier of the topic that defines the type of this association. This attribute is OPTIONAL.
References the topic that defines the type of this association by a subject identifier for that topic. This attribute is OPTIONAL.
References the topic that defines the type of the role
played by the topic described by the ancestor
tm:topic
element of this element. This
element is OPTIONAL and MUST be omitted when this element is not
a descendant of a tm:topic
element.
Contains the display label for the topic that defines the role type played by the topic described by the ancestor tm:topic element.
Contains the object identifier of the topic that defines
the role type played by the topic described by the ancestor
tm:topic
element.
References the topic that defines the role type played by
the topic described by the ancestor tm:topic
element. This attribute contains a subject identifier for the
referenced topic. This attribute is OPTIONAL.
Contains the "arc label" for the association. The arc
label is a name assigned to the association type that is scoped
by the topic that types the role identified by the
tm:playsrole
element. This element is
OPTIONAL and MUST be omitted when this element is not a
descendant of a tm:topic
element.
Contains information about a single role in the association. This element is OPTIONAL and REPEATABLE. If the tm:association element is contained in a tm:topic element, then there will be one tm:role element for each topic that participates in the association other than the topic described by the ancestor tm:topic element (whose role is instead described by the tm:playsrole element). If the tm:association element is not contained inside a tm:topic element, there will be one tm:role element for each topic that participates in the association.
Contains a list of the source locators for this role. This element is OPTIONAL.
Contains a single source locator URI for this role. This attribute is REQUIRED.
Contains a reference to the topic that defines the type of this role. This element is OPTIONAL. If omitted, then the role is untyped.
Contains a display label for the topic that defines the type of this role. This attribute is OPTIONAL.
Contains the unique object identifier of the topic that defines the type of this role. This attribute is OPTIONAL.
References the topic that defines the type of this role by a subject identifier. This attribute is OPTIONAL.
Contains a reference to the topic that participates in the association via this role. This element is OPTIONAL. If omitted, then the role is present in the association but is currently not fulfilled by any role-playing topic.
Contains a display label for the topic that participates in the association via this role. This attribute is OPTIONAL.
Contains the unique object identifier of the topic that participates in the association via this role. This attribute is OPTIONAL.
References the topic that participates in the association via this role by a subject identifier of that topic. This attribute is OPTIONAL.
Specifies the scope of this association. This element is OPTIONAL.