Changes between Version 5 and Version 6 of DataFormat

Timestamp:

02.09.2011 23:47:31 (13 years ago)

Author:

jri

Comment:

Association format explanation

DataFormat

@@ -3 +3 @@
 = Data Format =
 
-This page describes the data format of DeepaMehta's core objects (and some application objects) as retrieved via the [[RestApi|REST API]].
+This page describes the data format of DeepaMehta's core objects (and some non-core objects) as retrieved via the [[RestApi|REST API]].
 
 Note: The format used in create and update operations differs slightly. See the respective notes on the REST API page.
@@ -88 +88 @@
 == Association ==
 
-Example 2: an association that connects 2 topics
+An association has 2 ends. At each end there is a topic or an association. So, an association connects either 2 topics, or 1 topic and 1 association, or 2 associations. Both ends are qualified by a ''Role Type''.
+
+An association has the same 5 properties as a [[#Topic|Topic]] plus 2 role properties:
+
+||= Property =||= Description =||= Format =||
+{{{#!td
+`id`
+}}}
+{{{#!td rowspan=2 colspan=2 align=center
+''See [[#Topic|Topic]]''
+}}}
+|-----
+{{{#!td
+`uri`
+}}}
+|-----
+|| `type_uri` || The URI of the association's type. || A string of format <domain>.<project>.<name>, e.g. `dm4.core.aggregation` ||
+|-----
+{{{#!td
+`value`
+}}}
+{{{#!td rowspan=2 colspan=2 align=center
+''See [[#Topic|Topic]]''
+}}}
+|-----
+{{{#!td
+`composite`
+}}}
+|-----
+{{{#!td
+`role_1`
+}}}
+{{{#!td
+One association's end: a pair of a topic/association reference and a role type.\\\\
+Topics are specified by ID or URI.\\\\
+Associations are specified by ID.
+}}}
+{{{#!td rowspan=2
+Either
+{{{
+{
+  "topic_id": <Topic ID>,
+  "role_type_uri": <Role Type URI>
+}
+}}}
+or
+{{{
+{
+  "topic_uri": <Topic URI>,
+  "role_type_uri": <Role Type URI>
+}
+}}}
+or
+{{{
+{
+  "assoc_id": <Association ID>,
+  "role_type_uri": <Role Type URI>
+}
+}}}
+}}}
+|-----
+{{{#!td
+`role_2`
+}}}
+{{{#!td
+The other association's end.
+}}}
+
+Example 1: an association that connects 2 topics
 
 {{{