WS-Beschreibung - Terminologieserver Concept Association ReturnConceptAssociationDetails

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Request/Response)
 
(Eine dazwischenliegende Version von einem Benutzer wird nicht angezeigt)
Zeile 1: Zeile 1:
−
=Funktionalität=
+
=Functionality=
−
Gibt die Details der zwei Entitäten die durch die angegebene Assoziation verknüpft werden, sowie die Details zur Assoziation selbst an.
+
Returns all details about a association and the two entities that are linked by it.
  
−
=Vorbedingungen=
+
=Prerequisites=
  
 
=Request/Response=
 
=Request/Response=
Zeile 16: Zeile 16:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">LoginType</td>
 
   <td id="param_level1">LoginType</td>
−
   <td></td>
+
   <td>LoginType</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Login-Informationen</td>
+
   <td>Login information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 25: Zeile 25:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Die Session-ID des Benutzers</td>
+
   <td>Session-ID from user (given by system)</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>code_system_entity_version_association</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Setzt 2 Entity-Versionen miteinander in Beziehung.</td>
+
   <td>Associates two entity versions with each other.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 51: Zeile 51:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">ReturnType</td>
 
   <td id="param_level1">ReturnType</td>
−
   <td></td>
+
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Entählt Informationen über die Antwort.</td>
+
   <td>Return information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 60: Zeile 60:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Status- oder Fehlermeldung</td>
+
   <td>an additional message</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 76: Zeile 76:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">code_system_entity</td>
 
   <td id="param_level1">code_system_entity</td>
−
   <td></td>
+
   <td>code_system_entity</td>
 
<td></td>  <td id="cardinality_cell">2..2</td>
 
<td></td>  <td id="cardinality_cell">2..2</td>
−
   <td>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</td>
+
   <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 84: Zeile 84:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Die aktuelle ID der code_system_entity_version</td>
+
   <td>Current ID of code_system_entity_version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 94: Zeile 94:
 
<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>code_system_entity_version</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>code_system_entity_version is the superclass of every Concept and Association. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 102: Zeile 102:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td></td>
+
   <td>Foreign key to code system entities ID</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 108: Zeile 108:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Zeitpunkt der letzten Änderung</td>
+
   <td>Point in time of the last change.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 114: Zeile 114:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Zeitstempel, wann der Eintrag eingefügt worden ist</td>
+
   <td>Point in time, when entry was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 120: Zeile 120:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 126: Zeile 126:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>Major revision of this entry (composition of major and minor version e.g. 1.3).</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 132: Zeile 132:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 138: Zeile 138:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>Refers to the prior version, if there are more than one version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 144: Zeile 144:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
   <td>Status of the current entry. Can be taken from a domain.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 150: Zeile 150:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Änderungszeitpunkt des Status</td>
+
   <td>Point of time of the last change of the status.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 156: Zeile 156:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td></td>
+
   <td>Version-ID of Entity-Version</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>code_system_concept</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>Displays a concept or term. Specialization of code_system_entity_version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 169: Zeile 169:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Der Code zu einem Begriff bzw. Konzepts</td>
+
   <td>Code of a concept or term.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 181: Zeile 181:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Gibt an, ob es sich um einen Vorzugsbegriff handelt</td>
+
   <td>Specifies, if a term or concept is preferred or not.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 188: Zeile 188:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Der Begriff selbst</td>
+
   <td>The term itself</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 195: Zeile 195:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Abkürzung des Begriffs</td>
+
   <td>The abbrevation of the term.</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>code_system_entity_version_association</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Setzt 2 Entity-Versionen miteinander in Beziehung.</td>
+
   <td>Associates two entity versions with each other.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 207: Zeile 207:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>1 = ontologisch,
+
   <td>1 = ontological,
−
2 = taxonomisch,
+
2 = taxonomic,
 
3 = cross mapping,
 
3 = cross mapping,
 
4 = link</td>
 
4 = link</td>
Zeile 216: Zeile 216:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Gibt den Typ der Beziehung an (z.B. 'gehört zu')</td>
+
   <td>Specifies the Type of the association (e.g. 'belongs to')</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 222: Zeile 222:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Eine Entity der Beziehung</td>
+
   <td>Points to the second entity of the association</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 234: Zeile 234:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Zeitpunkt, wann die Beziehung eingefügt worden ist.</td>
+
   <td>Point of time, when the association was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 240: Zeile 240:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>Specifies the reading direction of the association, if ID 1 or ID 2 is on the left side. E.g.  ID 1 = 12, Id 2 = 14:  12 belongs to 14, or  14 belongs to 12.
 +
If the direction should be ID2 -> ID1, forwardName and reverseName have to be reverted as well. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 246: Zeile 247:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
   <td>Status of the current entry. Can be taken from a domain. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 252: Zeile 253:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Änderungszeitpunkt des Status</td>
+
   <td>Point of time of the last change of the status.</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>association_type</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 264: Zeile 265:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Entspricht der versionId von code_system_entity_version</td>
+
   <td>Equates the versionId of code_system_entity_version</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 271: Zeile 272:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Name der Beziehung in normaler Leserichtung (ID 1->2)</td>
+
   <td>Name of association in normal reading direction (ID 1->2)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 278: Zeile 279:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Name der Beziehung in umgekehrter Leserichtung (ID 2->1)</td>
+
   <td>Name of association in reversed reading direction (ID 2->1)</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
−
=Anmerkungen=
+
=Annotations=
−
==Besonderheiten==
+
==Noteworthiness==
−
==Hinweise==
+
==Hints==
  
−
=Beispiele=
+
=Examples=
−
==SOAP-Nachrichten==
+
==SOAP messages==
 
<source lang="xml">
 
<source lang="xml">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/">
Zeile 303: Zeile 304:
 
</source>
 
</source>
  
−
==Code-Beispiele==
+
==Code examples==
 
===Java===
 
===Java===
 
<source lang="java">
 
<source lang="java">
  
 
</source>
 
</source>

Aktuelle Version vom 9. August 2013, 09:23 Uhr

Inhaltsverzeichnis

Functionality

Returns all details about a association and the two entities that are linked by it.

Prerequisites

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
LoginType LoginType 0..1 Login information
sessionID String 1..1 Session-ID from user (given by system)
code_system_entity_version_association code_system_entity_version_association 1..1 Associates two entity versions with each other.
id Long 1..1

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Return information
message String 1..1 an additional message
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE
code_system_entity code_system_entity 2..2 Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
currentVersionId Long 1..1 Current ID of code_system_entity_version.
id Long 1..1
code_system_entity_version code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
codeSystemEntityId Long 1..1 Foreign key to code system entities ID
effectiveDate java.util.Date 1..1 Point in time of the last change.
insertTimestamp java.util.Date 1..1 Point in time, when entry was inserted.
isLeaf Boolean 1..1 Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only.
majorRevision Integer 1..1 Major revision of this entry (composition of major and minor version e.g. 1.3).
minorRevision Integer 1..1 Minor revision of this entry (composition of major and minor version e.g. 1.3)
previousVersionId Long 1..1 Refers to the prior version, if there are more than one version.
status Integer 1..1 Status of the current entry. Can be taken from a domain.
statusDate java.util.Date 1..1 Point of time of the last change of the status.
versionId Long 1..1 Version-ID of Entity-Version
code_system_concept code_system_concept 1..1 Displays a concept or term. Specialization of code_system_entity_version.
code String 100 1..1 Code of a concept or term.
codeSystemEntityVersionId Long 1..1
isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
term String 65535 1..1 The term itself
termAbbrevation String 50 1..1 The abbrevation of the term.
code_system_entity_version_association code_system_entity_version_association 0..1 Associates two entity versions with each other.
associationKind Integer 1..1 1 = ontological,

2 = taxonomic, 3 = cross mapping,

4 = link
associationTypeId Long 1..1 Specifies the Type of the association (e.g. 'belongs to')
codeSystemEntityVersionId2 Long 1..1 Points to the second entity of the association
id Long 1..1
insertTimestamp java.util.Date 1..1 Point of time, when the association was inserted.
leftId Long 1..1 Specifies the reading direction of the association, if ID 1 or ID 2 is on the left side. E.g. ID 1 = 12, Id 2 = 14: 12 belongs to 14, or 14 belongs to 12. If the direction should be ID2 -> ID1, forwardName and reverseName have to be reverted as well.
status Integer 1..1 Status of the current entry. Can be taken from a domain.
statusDate java.util.Date 1..1 Point of time of the last change of the status.
association_type association_type 1..1 Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version
codeSystemEntityVersionId Long 1..1 Equates the versionId of code_system_entity_version
forwardName String 50 1..1 Name of association in normal reading direction (ID 1->2)
reverseName String 50 1..1 Name of association in reversed reading direction (ID 2->1)

Annotations

Noteworthiness

Hints

Examples

SOAP messages

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <con:ReturnConceptAssociationDetails>
         <parameter>
             <codeSystemEntityVersionAssociation>
		 <id>1555</id>
             </codeSystemEntityVersionAssociation>
         </parameter>
      </con:ReturnConceptAssociationDetails>
   </soapenv:Body>
</soapenv:Envelope>

Code examples

Java

 
Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=WS-Beschreibung_-_Terminologieserver_Concept_Association_ReturnConceptAssociationDetails“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge