WS-Beschreibung - Terminologieserver Concept Association ListConceptAssociations
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(→Request) |
(→Request/Response) |
||
| Zeile 32: | Zeile 32: | ||
<th>Beschreibung</th> | <th>Beschreibung</th> | ||
</tr> | </tr> | ||
| − | <tr | + | <tr> |
| − | <td id="param_level1"> | + | <td id="param_level1">reverse</td> |
| − | <td></td> | + | <td>Boolean</td> |
| − | + | <td></td> <td id="cardinality_cell">0..1</td> | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td id=" | + | <td id="param_level1">directionBoth</td> |
| − | <td> | + | <td>Boolean</td> |
| − | + | <td></td> <td id="cardinality_cell">0..1</td> | |
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td id=" | + | <td id="param_level1">lookForward</td> |
| − | <td> | + | <td>Boolean</td> |
| − | + | <td></td> <td id="cardinality_cell">0..1</td> | |
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| − | <tr id=" | + | <tr id="row_object"> |
| − | <td id=" | + | <td id="param_level1">LoginType</td> |
| − | + | ||
| − | + | ||
| − | + | ||
<td></td> | <td></td> | ||
| + | <td></td> <td id="cardinality_cell">0..1</td> | ||
| + | <td>Login-Informationen</td> | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
| − | <td id=" | + | <td id="param_level2">ip</td> |
| − | <td> | + | <td>String</td> |
| − | + | ||
| − | + | ||
<td></td> | <td></td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<td id="cardinality_cell">-</td> | <td id="cardinality_cell">-</td> | ||
| − | <td></td> | + | <td>Die IP-Adresse des Benutzers (wird intern vergeben)</td> |
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
| − | <td id=" | + | <td id="param_level2">password</td> |
| − | <td> | + | <td>String</td> |
| − | + | ||
| − | + | ||
<td></td> | <td></td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<td id="cardinality_cell">-</td> | <td id="cardinality_cell">-</td> | ||
| − | <td></td> | + | <td>Passwort des Benutzers (als MD5-Wert)</td> |
</tr> | </tr> | ||
| − | <tr | + | <tr> |
| − | <td id=" | + | <td id="param_level2">sessionID</td> |
| − | <td> | + | <td>String</td> |
| − | + | ||
| − | + | ||
<td></td> | <td></td> | ||
| + | <td id="cardinality_cell">1..1</td> | ||
| + | <td>Die Session-ID des Benutzers</td> | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
| − | <td id=" | + | <td id="param_level2">username</td> |
| − | <td> | + | <td>String</td> |
| − | + | ||
| − | + | ||
<td></td> | <td></td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<td id="cardinality_cell">-</td> | <td id="cardinality_cell">-</td> | ||
| − | <td></td> | + | <td>Benutzername</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system_entity_version_association</td> | <td id="param_level1">code_system_entity_version_association</td> | ||
<td></td> | <td></td> | ||
| − | + | <td></td> <td id="cardinality_cell">0..1</td> | |
| − | + | <td>Setzt 2 Entity-Versionen in Beziehung miteinander.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">associationKind</td> | <td id="param_level2">associationKind</td> | ||
| − | <td> | + | <td>Integer</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>1 = ontologisch, | |
| − | <td></td> | + | 2 = taxonomisch, |
| + | 3 = cross mapping</td> | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
<td id="param_level2">associationTypeId</td> | <td id="param_level2">associationTypeId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Gibt den Typ der Beziehung an (z.B. 'gehört zu')</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
<td id="param_level2">codeSystemEntityVersionId1</td> | <td id="param_level2">codeSystemEntityVersionId1</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Eine Entity der Beziehung</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
<td id="param_level2">codeSystemEntityVersionId2</td> | <td id="param_level2">codeSystemEntityVersionId2</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Eine Entity der Beziehung</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
<td id="param_level2">id</td> | <td id="param_level2">id</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
<td id="param_level2">insertTimestamp</td> | <td id="param_level2">insertTimestamp</td> | ||
| − | <td> | + | <td>java.util.Date</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Zeitpunkt, wann die Beziehung eingefügt worden ist.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
<td id="param_level2">leftId</td> | <td id="param_level2">leftId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Gibt an, wie die Leserichtung von ID 1 und ID 2 ist. Ist entweder gleich der codeSystemEntityVersionId1 oder codeSystemEntityVersionId2. Sollte die Leserichtung von ID2 -> ID1 gerichtet sein, müssen ebenfalls die Beziehungsnamen (forwardName und reverseName) umgedreht werden.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
<td id="param_level2">status</td> | <td id="param_level2">status</td> | ||
| − | <td> | + | <td>Integer</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
<td id="param_level2">statusDate</td> | <td id="param_level2">statusDate</td> | ||
| − | <td> | + | <td>java.util.Date</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Änderungszeitpunkt des Status</td> | |
| − | <td> | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
| − | <td id="param_level1"> | + | <td id="param_level1">code_system_entity</td> |
| − | + | ||
| − | + | ||
| − | + | ||
<td></td> | <td></td> | ||
| + | <td></td> <td id="cardinality_cell">1..1</td> | ||
| + | <td>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</td> | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
| − | <td id="param_level2"> | + | <td id="param_level2">currentVersionId</td> |
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Die aktuelle ID der code_system_entity_version</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<td id="param_level2">id</td> | <td id="param_level2">id</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| Zeile 367: | Zeile 167: | ||
<td id="param_level2">code_system_entity_version</td> | <td id="param_level2">code_system_entity_version</td> | ||
<td></td> | <td></td> | ||
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">codeSystemEntityId</td> | <td id="param_level3">codeSystemEntityId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">effectiveDate</td> | <td id="param_level3">effectiveDate</td> | ||
| − | <td> | + | <td>java.util.Date</td> |
| − | + | <td></td> <td id="cardinality_cell">0..1</td> | |
| − | + | <td>Zeitpunkt der letzten Änderung</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
| − | <tr> | + | <tr id="gray"> |
<td id="param_level3">insertTimestamp</td> | <td id="param_level3">insertTimestamp</td> | ||
| − | <td> | + | <td>java.util.Date</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Zeitstempel, wann der Eintrag eingefügt worden ist</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
| − | <tr> | + | <tr id="gray"> |
<td id="param_level3">isLeaf</td> | <td id="param_level3">isLeaf</td> | ||
| − | <td> | + | <td>Boolean</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
| − | <tr> | + | <tr id="gray"> |
<td id="param_level3">majorRevision</td> | <td id="param_level3">majorRevision</td> | ||
| − | <td> | + | <td>Integer</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
| − | <tr> | + | <tr id="gray"> |
<td id="param_level3">minorRevision</td> | <td id="param_level3">minorRevision</td> | ||
| − | <td> | + | <td>Integer</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
| − | <tr> | + | <tr id="gray"> |
<td id="param_level3">previousVersionId</td> | <td id="param_level3">previousVersionId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
| − | <tr> | + | <tr id="gray"> |
<td id="param_level3">status</td> | <td id="param_level3">status</td> | ||
| − | <td> | + | <td>Integer</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
| − | <tr> | + | <tr id="gray"> |
<td id="param_level3">statusDate</td> | <td id="param_level3">statusDate</td> | ||
| − | <td> | + | <td>java.util.Date</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Änderungszeitpunkt des Status</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
| − | <tr> | + | <tr id="gray"> |
<td id="param_level3">versionId</td> | <td id="param_level3">versionId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| + | </table> | ||
| + | ==Response== | ||
| + | <table border="1" cellpadding="1" class="ws_table"> | ||
| + | <tr class="ws_table_head"> | ||
| + | <th>Parameter</th> | ||
| + | <th>Typ</th> | ||
| + | <th>Länge</th> | ||
| + | <th id="cardinality_cell">Kardinalität</th> | ||
| + | <th>Beschreibung</th> | ||
| + | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">ReturnType</td> | <td id="param_level1">ReturnType</td> | ||
<td></td> | <td></td> | ||
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Entählt Informationen über die Antwort.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">count</td> | <td id="param_level2">count</td> | ||
| − | <td> | + | <td>Integer</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Anzahl der Ergebnisse</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">message</td> | <td id="param_level2">message</td> | ||
| − | <td> | + | <td>String</td> |
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Status- oder Fehlermeldung</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">overallErrorCategory</td> | <td id="param_level2">overallErrorCategory</td> | ||
| − | |||
<td></td> | <td></td> | ||
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
<td>INFO, WARN, ERROR</td> | <td>INFO, WARN, ERROR</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">status</td> | <td id="param_level2">status</td> | ||
| − | |||
<td></td> | <td></td> | ||
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
<td>OK, FAILURE</td> | <td>OK, FAILURE</td> | ||
</tr> | </tr> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system_entity_version_association</td> | <td id="param_level1">code_system_entity_version_association</td> | ||
<td></td> | <td></td> | ||
| − | + | <td></td> <td id="cardinality_cell">0..N</td> | |
| − | + | <td>Setzt 2 Entity-Versionen in Beziehung miteinander.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">associationKind</td> | <td id="param_level2">associationKind</td> | ||
| − | <td> | + | <td>Integer</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>1 = ontologisch, | |
| − | <td></td> | + | 2 = taxonomisch, |
| + | 3 = cross mapping</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">associationTypeId</td> | <td id="param_level2">associationTypeId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Gibt den Typ der Beziehung an (z.B. 'gehört zu')</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
| − | <tr> | + | <tr id="gray"> |
<td id="param_level2">codeSystemEntityVersionId1</td> | <td id="param_level2">codeSystemEntityVersionId1</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">-</td> | |
| − | + | <td>Eine Entity der Beziehung</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">codeSystemEntityVersionId2</td> | <td id="param_level2">codeSystemEntityVersionId2</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Eine Entity der Beziehung</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">id</td> | <td id="param_level2">id</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">insertTimestamp</td> | <td id="param_level2">insertTimestamp</td> | ||
| − | <td> | + | <td>java.util.Date</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Zeitpunkt, wann die Beziehung eingefügt worden ist.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">leftId</td> | <td id="param_level2">leftId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Gibt an, wie die Leserichtung von ID 1 und ID 2 ist. Ist entweder gleich der codeSystemEntityVersionId1 oder codeSystemEntityVersionId2. Sollte die Leserichtung von ID2 -> ID1 gerichtet sein, müssen ebenfalls die Beziehungsnamen (forwardName und reverseName) umgedreht werden.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">status</td> | <td id="param_level2">status</td> | ||
| − | <td> | + | <td>Integer</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">statusDate</td> | <td id="param_level2">statusDate</td> | ||
| − | <td> | + | <td>java.util.Date</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Änderungszeitpunkt des Status</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
| − | |||
| − | |||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">association_type</td> | <td id="param_level2">association_type</td> | ||
<td></td> | <td></td> | ||
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Stellt den Namen einer Beziehung dar. Speziealisierung von code_system_entity_version. Die codeSystemEntityVersionId entspricht der versionId aus code_system_entity_version.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">codeSystemEntityVersionId</td> | <td id="param_level3">codeSystemEntityVersionId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Entspricht der versionId von code_system_entity_version</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">forwardName</td> | <td id="param_level3">forwardName</td> | ||
| − | <td> | + | <td>String</td> |
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Name der Beziehung in normaler Leserichtung (ID 1->2)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">reverseName</td> | <td id="param_level3">reverseName</td> | ||
| − | <td> | + | <td>String</td> |
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Name der Beziehung in umgekehrter Leserichtung (ID 2->1)</td> |
</tr> | </tr> | ||
| − | |||
| − | |||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">code_system_entity_version</td> | <td id="param_level2">code_system_entity_version</td> | ||
<td></td> | <td></td> | ||
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">codeSystemEntityId</td> | <td id="param_level3">codeSystemEntityId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">effectiveDate</td> | <td id="param_level3">effectiveDate</td> | ||
| − | <td> | + | <td>java.util.Date</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Zeitpunkt der letzten Änderung</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">insertTimestamp</td> | <td id="param_level3">insertTimestamp</td> | ||
| − | <td> | + | <td>java.util.Date</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Zeitstempel, wann der Eintrag eingefügt worden ist</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">isLeaf</td> | <td id="param_level3">isLeaf</td> | ||
| − | <td> | + | <td>Boolean</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">majorRevision</td> | <td id="param_level3">majorRevision</td> | ||
| − | <td> | + | <td>Integer</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">minorRevision</td> | <td id="param_level3">minorRevision</td> | ||
| − | <td> | + | <td>Integer</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">previousVersionId</td> | <td id="param_level3">previousVersionId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">status</td> | <td id="param_level3">status</td> | ||
| − | <td> | + | <td>Integer</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">statusDate</td> | <td id="param_level3">statusDate</td> | ||
| − | <td> | + | <td>java.util.Date</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Änderungszeitpunkt des Status</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">versionId</td> | <td id="param_level3">versionId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| − | |||
| − | |||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level3">code_system_concept</td> | <td id="param_level3">code_system_concept</td> | ||
<td></td> | <td></td> | ||
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version.</td> | |
| − | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level4">code</td> | <td id="param_level4">code</td> | ||
| − | <td> | + | <td>String</td> |
<td>100</td> | <td>100</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| Zeile 727: | Zeile 440: | ||
<tr> | <tr> | ||
<td id="param_level4">codeSystemEntityVersionId</td> | <td id="param_level4">codeSystemEntityVersionId</td> | ||
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level4">isPreferred</td> | <td id="param_level4">isPreferred</td> | ||
| − | <td> | + | <td>Boolean</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level4">term</td> | <td id="param_level4">term</td> | ||
| − | <td> | + | <td>String</td> |
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| Zeile 748: | Zeile 459: | ||
<tr> | <tr> | ||
<td id="param_level4">termAbbrevation</td> | <td id="param_level4">termAbbrevation</td> | ||
| − | <td> | + | <td>String</td> |
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</table> | </table> | ||
Version vom 27. März 2012, 09:14 Uhr
| System | Terminologieserver |
| Webservice | Concept Association |
| WSDL | http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/ConceptAssociations?wsdl |
| Methode | ListConceptAssociations |
Inhaltsverzeichnis |
Funktionalität
Auflistung aller Konzepte und deren Assiziationen mit dem angegebenen Konzept.
Vorbedingungen
Request/Response
Request
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| reverse | Boolean | 0..1 | ||
| directionBoth | Boolean | 0..1 | ||
| lookForward | Boolean | 0..1 | ||
| LoginType | 0..1 | Login-Informationen | ||
| ip | String | - | Die IP-Adresse des Benutzers (wird intern vergeben) | |
| password | String | - | Passwort des Benutzers (als MD5-Wert) | |
| sessionID | String | 1..1 | Die Session-ID des Benutzers | |
| username | String | - | Benutzername | |
| code_system_entity_version_association | 0..1 | Setzt 2 Entity-Versionen in Beziehung miteinander. | ||
| associationKind | Integer | 1..1 | 1 = ontologisch,
2 = taxonomisch, 3 = cross mapping |
|
| associationTypeId | Long | - | Gibt den Typ der Beziehung an (z.B. 'gehört zu') | |
| codeSystemEntityVersionId1 | Long | - | Eine Entity der Beziehung | |
| codeSystemEntityVersionId2 | Long | - | Eine Entity der Beziehung | |
| id | Long | - | ||
| insertTimestamp | java.util.Date | - | Zeitpunkt, wann die Beziehung eingefügt worden ist. | |
| leftId | Long | - | Gibt an, wie die Leserichtung von ID 1 und ID 2 ist. Ist entweder gleich der codeSystemEntityVersionId1 oder codeSystemEntityVersionId2. Sollte die Leserichtung von ID2 -> ID1 gerichtet sein, müssen ebenfalls die Beziehungsnamen (forwardName und reverseName) umgedreht werden. | |
| status | Integer | - | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
| statusDate | java.util.Date | - | Änderungszeitpunkt des Status | |
| code_system_entity | 1..1 | Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen. | ||
| currentVersionId | Long | - | Die aktuelle ID der code_system_entity_version | |
| id | Long | - | ||
| code_system_entity_version | 1..1 | Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung. | ||
| codeSystemEntityId | Long | 1..1 | ||
| effectiveDate | java.util.Date | 0..1 | Zeitpunkt der letzten Änderung | |
| insertTimestamp | java.util.Date | - | Zeitstempel, wann der Eintrag eingefügt worden ist | |
| isLeaf | Boolean | - | Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden. | |
| majorRevision | Integer | - | Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
| minorRevision | Integer | - | Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
| previousVersionId | Long | - | Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version. | |
| status | Integer | - | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
| statusDate | java.util.Date | - | Änderungszeitpunkt des Status | |
| versionId | Long | - |
Response
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| ReturnType | 1..1 | Entählt Informationen über die Antwort. | ||
| count | Integer | 1..1 | Anzahl der Ergebnisse | |
| message | String | 1..1 | Status- oder Fehlermeldung | |
| overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| status | 1..1 | OK, FAILURE | ||
| code_system_entity_version_association | 0..N | Setzt 2 Entity-Versionen in Beziehung miteinander. | ||
| associationKind | Integer | 1..1 | 1 = ontologisch,
2 = taxonomisch, 3 = cross mapping |
|
| associationTypeId | Long | 1..1 | Gibt den Typ der Beziehung an (z.B. 'gehört zu') | |
| codeSystemEntityVersionId1 | Long | - | Eine Entity der Beziehung | |
| codeSystemEntityVersionId2 | Long | 1..1 | Eine Entity der Beziehung | |
| id | Long | 1..1 | ||
| insertTimestamp | java.util.Date | 1..1 | Zeitpunkt, wann die Beziehung eingefügt worden ist. | |
| leftId | Long | 1..1 | Gibt an, wie die Leserichtung von ID 1 und ID 2 ist. Ist entweder gleich der codeSystemEntityVersionId1 oder codeSystemEntityVersionId2. Sollte die Leserichtung von ID2 -> ID1 gerichtet sein, müssen ebenfalls die Beziehungsnamen (forwardName und reverseName) umgedreht werden. | |
| status | Integer | 1..1 | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
| statusDate | java.util.Date | 1..1 | Änderungszeitpunkt des Status | |
| association_type | 1..1 | Stellt den Namen einer Beziehung dar. Speziealisierung von code_system_entity_version. Die codeSystemEntityVersionId entspricht der versionId aus code_system_entity_version. | ||
| codeSystemEntityVersionId | Long | 1..1 | Entspricht der versionId von code_system_entity_version | |
| forwardName | String | 50 | 1..1 | Name der Beziehung in normaler Leserichtung (ID 1->2) |
| reverseName | String | 50 | 1..1 | Name der Beziehung in umgekehrter Leserichtung (ID 2->1) |
| code_system_entity_version | 1..1 | Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung. | ||
| codeSystemEntityId | Long | 1..1 | ||
| effectiveDate | java.util.Date | 1..1 | Zeitpunkt der letzten Änderung | |
| insertTimestamp | java.util.Date | 1..1 | Zeitstempel, wann der Eintrag eingefügt worden ist | |
| isLeaf | Boolean | 1..1 | Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden. | |
| majorRevision | Integer | 1..1 | Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
| minorRevision | Integer | 1..1 | Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
| previousVersionId | Long | 1..1 | Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version. | |
| status | Integer | 1..1 | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
| statusDate | java.util.Date | 1..1 | Änderungszeitpunkt des Status | |
| versionId | Long | 1..1 | ||
| code_system_concept | 1..1 | Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version. | ||
| code | String | 100 | 1..1 | |
| codeSystemEntityVersionId | Long | 1..1 | ||
| isPreferred | Boolean | 1..1 | ||
| term | String | 65535 | 1..1 | |
| termAbbrevation | String | 50 | 1..1 |
Anmerkungen
Besonderheiten
Hinweise
Die Ergebnismenge ist meistens eher klein bis mittelmäßig.
Beispiele
SOAP-Nachrichten
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <con:ListConceptAssociations> <parameter> <codeSystemEntity> <codeSystemEntityVersions> <status/><versionId>17</versionId> </codeSystemEntityVersions> </codeSystemEntity> </parameter> </con:ListConceptAssociations> </soapenv:Body> </soapenv:Envelope>
