Changes between Version 5 and Version 6 of DataFormat


Ignore:
Timestamp:
02.09.2011 23:47:31 (9 years ago)
Author:
jri
Comment:

Association format explanation

Legend:

Unmodified
Added
Removed
Modified
  • DataFormat

    v5 v6  
    33= Data Format = 
    44 
    5 This page describes the data format of DeepaMehta's core objects (and some application objects) as retrieved via the [[RestApi|REST API]]. 
     5This page describes the data format of DeepaMehta's core objects (and some non-core objects) as retrieved via the [[RestApi|REST API]]. 
    66 
    77Note: The format used in create and update operations differs slightly. See the respective notes on the REST API page. 
     
    8888== Association == 
    8989 
    90 Example 2: an association that connects 2 topics 
     90An 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''. 
     91 
     92An association has the same 5 properties as a [[#Topic|Topic]] plus 2 role properties: 
     93 
     94||= Property =||= Description =||= Format =|| 
     95{{{#!td 
     96`id` 
     97}}} 
     98{{{#!td rowspan=2 colspan=2 align=center 
     99''See [[#Topic|Topic]]'' 
     100}}} 
     101|----- 
     102{{{#!td 
     103`uri` 
     104}}} 
     105|----- 
     106|| `type_uri` || The URI of the association's type. || A string of format <domain>.<project>.<name>, e.g. `dm4.core.aggregation` || 
     107|----- 
     108{{{#!td 
     109`value` 
     110}}} 
     111{{{#!td rowspan=2 colspan=2 align=center 
     112''See [[#Topic|Topic]]'' 
     113}}} 
     114|----- 
     115{{{#!td 
     116`composite` 
     117}}} 
     118|----- 
     119{{{#!td 
     120`role_1` 
     121}}} 
     122{{{#!td 
     123One association's end: a pair of a topic/association reference and a role type.\\\\ 
     124Topics are specified by ID or URI.\\\\ 
     125Associations are specified by ID. 
     126}}} 
     127{{{#!td rowspan=2 
     128Either 
     129{{{ 
     130{ 
     131  "topic_id": <Topic ID>, 
     132  "role_type_uri": <Role Type URI> 
     133} 
     134}}} 
     135or 
     136{{{ 
     137{ 
     138  "topic_uri": <Topic URI>, 
     139  "role_type_uri": <Role Type URI> 
     140} 
     141}}} 
     142or 
     143{{{ 
     144{ 
     145  "assoc_id": <Association ID>, 
     146  "role_type_uri": <Role Type URI> 
     147} 
     148}}} 
     149}}} 
     150|----- 
     151{{{#!td 
     152`role_2` 
     153}}} 
     154{{{#!td 
     155The other association's end. 
     156}}} 
     157 
     158Example 1: an association that connects 2 topics 
    91159 
    92160{{{