WS-Beschreibung - Terminologieserver Concept Association ListConceptAssociations

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(Funktionalität)
(Request/Response)
Zeile 55: Zeile 55:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Login-Informationen</td>
 
   <td>Login-Informationen</td>
</tr>
 
<tr id="gray">
 
  <td id="param_level2">ip</td>
 
  <td>String</td>
 
  <td></td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Die IP-Adresse des Benutzers (wird intern vergeben)</td>
 
</tr>
 
<tr id="gray">
 
  <td id="param_level2">password</td>
 
  <td>String</td>
 
  <td></td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Passwort des Benutzers (als MD5-Wert)</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 76: Zeile 62:
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td>Die Session-ID des Benutzers</td>
 
   <td>Die Session-ID des Benutzers</td>
</tr>
 
<tr id="gray">
 
  <td id="param_level2">username</td>
 
  <td>String</td>
 
  <td></td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Benutzername</td>
 
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 88: Zeile 67:
 
   <td></td>
 
   <td></td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
   <td>Setzt 2 Entity-Versionen in Beziehung miteinander.</td>
+
   <td>Setzt 2 Entity-Versionen miteinander in Beziehung.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 96: Zeile 75:
 
   <td>1 = ontologisch,
 
   <td>1 = ontologisch,
 
2 = taxonomisch,
 
2 = taxonomisch,
3 = cross mapping</td>
+
3 = cross mapping,
</tr>
+
4 = link</td>
<tr id="gray">
+
  <td id="param_level2">associationTypeId</td>
+
  <td>Long</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Gibt den Typ der Beziehung an (z.B. 'gehört zu')</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level2">codeSystemEntityVersionId1</td>
+
  <td>Long</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Eine Entity der Beziehung</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level2">codeSystemEntityVersionId2</td>
+
  <td>Long</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Eine Entity der Beziehung</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level2">id</td>
+
  <td>Long</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td></td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level2">insertTimestamp</td>
+
  <td>java.util.Date</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Zeitpunkt, wann die Beziehung eingefügt worden ist.</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level2">leftId</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>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level2">status</td>
+
  <td>Integer</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level2">statusDate</td>
+
  <td>java.util.Date</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Änderungszeitpunkt des Status</td>
+
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 151: Zeile 83:
 
<td></td>  <td id="cardinality_cell">1..1</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>
 
   <td>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</td>
</tr>
 
<tr id="gray">
 
  <td id="param_level2">currentVersionId</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Die aktuelle ID der code_system_entity_version</td>
 
</tr>
 
<tr id="gray">
 
  <td id="param_level2">id</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td></td>
 
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 181: Zeile 101:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Zeitpunkt der letzten Änderung</td>
 
   <td>Zeitpunkt der letzten Änderung</td>
</tr>
 
<tr id="gray">
 
  <td id="param_level3">insertTimestamp</td>
 
  <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Zeitstempel, wann der Eintrag eingefügt worden ist</td>
 
</tr>
 
<tr id="gray">
 
  <td id="param_level3">isLeaf</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>
 
</tr>
 
<tr id="gray">
 
  <td id="param_level3">majorRevision</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>
 
</tr>
 
<tr id="gray">
 
  <td id="param_level3">minorRevision</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>
 
</tr>
 
<tr id="gray">
 
  <td id="param_level3">previousVersionId</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>
 
</tr>
 
<tr id="gray">
 
  <td id="param_level3">status</td>
 
  <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
 
</tr>
 
<tr id="gray">
 
  <td id="param_level3">statusDate</td>
 
  <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Änderungszeitpunkt des Status</td>
 
</tr>
 
<tr id="gray">
 
  <td id="param_level3">versionId</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td></td>
 
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 275: Zeile 147:
 
   <td></td>
 
   <td></td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
   <td>Setzt 2 Entity-Versionen in Beziehung miteinander.</td>
+
   <td>Setzt 2 Entity-Versionen miteinander in Beziehung.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 283: Zeile 155:
 
   <td>1 = ontologisch,
 
   <td>1 = ontologisch,
 
2 = taxonomisch,
 
2 = taxonomisch,
3 = cross mapping</td>
+
3 = cross mapping,
 +
4 = link</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 290: Zeile 163:
 
<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>Gibt den Typ der Beziehung an (z.B. 'gehört zu')</td>
</tr>
 
<tr id="gray">
 
  <td id="param_level2">codeSystemEntityVersionId1</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Eine Entity der Beziehung</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 436: Zeile 303:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td></td>
+
   <td>Der Code zu einem Begriff bzw. Konzepts</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 448: Zeile 315:
 
   <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></td>
+
   <td>Gibt an, ob es sich um einen Vorzugsbegriff handelt</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 455: Zeile 322:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td></td>
+
   <td>Der Begriff selbst</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 462: Zeile 329:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td></td>
+
   <td>Abkürzung des Begriffs</td>
 
</tr>
 
</tr>
 
</table>
 
</table>

Version vom 20. August 2012, 05:53 Uhr

System Terminologieserver
Webservice Concept Association
WSDL http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/ConceptAssociations?wsdl
Methode ListConceptAssociations

Inhaltsverzeichnis

Funktionalität

Gibt zu einem bestimmten Konzept alle Assoziationen wieder.

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
sessionID String 1..1 Die Session-ID des Benutzers
code_system_entity_version_association 0..1 Setzt 2 Entity-Versionen miteinander in Beziehung.
associationKind Integer 1..1 1 = ontologisch,

2 = taxonomisch, 3 = cross mapping,

4 = link
code_system_entity 1..1 Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.
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

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 miteinander in Beziehung.
associationKind Integer 1..1 1 = ontologisch,

2 = taxonomisch, 3 = cross mapping,

4 = link
associationTypeId Long 1..1 Gibt den Typ der Beziehung an (z.B. 'gehört zu')
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 Der Code zu einem Begriff bzw. Konzepts
codeSystemEntityVersionId Long 1..1
isPreferred Boolean 1..1 Gibt an, ob es sich um einen Vorzugsbegriff handelt
term String 65535 1..1 Der Begriff selbst
termAbbrevation String 50 1..1 Abkürzung des Begriffs

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>

Code-Beispiele

Java

 
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge