WS-Beschreibung - Terminologieserver Authoring MaintainConceptAssociationType

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(Die Seite wurde neu angelegt: „<table border="0"> <tr> <td width="100px" style="font-weight: bold;">System</td> <td>Terminologieserver</td> </tr> <tr> <td style="font-weight: …“)
 
(Request/Response)
Zeile 25: Zeile 25:
  
 
=Request/Response=
 
=Request/Response=
 +
==Request==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 +
    <th>Beschreibung</th>
 +
  </tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">LoginType</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">0..1</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>
 +
  <td id="param_level2">sessionID</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</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 id="row_object">
 +
  <td id="param_level1">VersioningType</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Angaben zur Versionisierung</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">createNewVersion</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true, wenn eine neue Version erstellt werden soll</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">majorUpdate</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>true, wenn die Hauptversion hochgezählt werden soll</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">minorUpdate</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>true, wenn die Nebenversion hochgezählt werden soll</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system_entity</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 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 id="row_object">
 +
  <td id="param_level2">code_system_entity_version</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>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">effectiveDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</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>
 +
  <td id="param_level3">majorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">minorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">0..1</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>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level3">association_type</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">0..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>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level4">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Entspricht der versionId von code_system_entity_version</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">forwardName</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Name der Beziehung in normaler Leserichtung (ID 1->2)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">reverseName</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Name der Beziehung in umgekehrter Leserichtung (ID 2->1)</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level3">property</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">0..N</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level4">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">name</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level4">property_version</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..N</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level5">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">content</td>
 +
  <td>byte[]</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">contentMimetype</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">contentName</td>
 +
  <td>String</td>
 +
  <td>255</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">contentSize</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level5">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">languageId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">name</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Pflichtangabe, falls keine versionId angegeben wurde</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level5">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level5">propertyId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">propertyKindId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level5">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
</table>
 +
==Response==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 +
    <th>Beschreibung</th>
 +
  </tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">ReturnType</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Entählt Informationen über die Antwort.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level2">count</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Anzahl der Ergebnisse</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">message</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Status- oder Fehlermeldung</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">overallErrorCategory</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>INFO, WARN, ERROR</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">status</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>OK, FAILURE</td>
 +
</tr>
 +
</table>
  
 
=Anmerkungen=
 
=Anmerkungen=

Version vom 26. März 2012, 11:10 Uhr

System Terminologieserver
Webservice Authoring
WSDL http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Authoring?wsdl
Methode MaintainConceptAssociationType

Inhaltsverzeichnis

Funktionalität

Anlegen neuer oder verändern bestehender Assoziationen. Es können der Assoziationstyp sowie die Properties und deren Versionen geändert oder neu erstellt werden.

Vorbedingungen

Um diesen Webservice zu nutzen, müssen Sie sich zunächst am Terminologieserver anmelden (Login).

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
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
VersioningType 1..1 Angaben zur Versionisierung
createNewVersion Boolean 1..1 true, wenn eine neue Version erstellt werden soll
majorUpdate Boolean 0..1 true, wenn die Hauptversion hochgezählt werden soll
minorUpdate Boolean 0..1 true, wenn die Nebenversion hochgezählt werden soll
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 -
effectiveDate java.util.Date - 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 0..1 Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)
minorRevision Integer 0..1 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 1..1
association_type 0..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 - 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)
property 0..N
currentVersionId Long -
id Long 1..1
name String 65535 0..1
property_version 1..N
codeSystemEntityVersionId Long -
content byte[] 0..1
contentMimetype String 50 0..1
contentName String 255 0..1
contentSize Integer 0..1
description String 65535 0..1
insertTimestamp java.util.Date -
languageId Long 0..1
name String 65535 0..1 Pflichtangabe, falls keine versionId angegeben wurde
previousVersionId Long -
propertyId Long -
propertyKindId Long 0..1
status Integer 0..1
statusDate java.util.Date -
versionId Long 0..1

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType 1..1 Entählt Informationen über die Antwort.
count Integer - Anzahl der Ergebnisse
message String 1..1 Status- oder Fehlermeldung
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE

Anmerkungen

Besonderheiten

Hinweise

Beispiele

SOAP-Nachrichten

 

Code-Beispiele

Java

 
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge