WS-Beschreibung - Terminologieserver Authoring MaintainConceptAssociationType

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Request/Response)
 
(3 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt)
Zeile 1: Zeile 1:
−
=Funktionalität=
+
=Functionality=
−
Anlegen neuer oder verändern bestehender Assoziationen. Es können der Assoziationstyp sowie die Properties und deren Versionen geändert oder neu erstellt werden.
+
Create a new or edit a existing association. Association type, properties and their versions can be edited or created.
  
−
=Vorbedingungen=
+
=Prerequisites=
−
Um diesen Webservice zu nutzen, müssen Sie sich zunächst am Terminologieserver anmelden ([[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]]).  
+
Requires [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]].
  
 
=Request/Response=
 
=Request/Response=
 +
The required request parameters differs for creating a new version and editing an existing one. The request and response table below refers to the creation of a new version only.
 +
 +
Required fields: new version
 +
*
 +
 +
Required fields: edit version
 +
*
 +
 
==Request==
 
==Request==
 
<table border="1" cellpadding="1" class="ws_table">
 
<table border="1" cellpadding="1" class="ws_table">
Zeile 17: Zeile 25:
 
<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 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 40: Zeile 34:
 
   <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 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">
 
   <td id="param_level1">VersioningType</td>
 
   <td id="param_level1">VersioningType</td>
−
   <td></td>
+
   <td>VersioningType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Angaben zur Versionisierung</td>
+
   <td>Versioning information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 59: Zeile 46:
 
   <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>true, wenn eine neue Version erstellt werden soll</td>
+
   <td>true if a new version should be created</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 65: Zeile 52:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>true, wenn die Hauptversion hochgezählt werden soll</td>
+
   <td>true if major version should count up</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 71: Zeile 58:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>true, wenn die Nebenversion hochgezählt werden soll</td>
+
   <td>true if minor version should count up</td>
 
</tr>
 
</tr>
 
<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">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>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </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">
 
   <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 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>
 
<tr>
 
<tr>
Zeile 125: Zeile 76:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..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 131: Zeile 82:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..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 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>
 
<tr>
 
<tr>
Zeile 155: Zeile 88:
 
   <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">association_type</td>
 
   <td id="param_level3">association_type</td>
−
   <td></td>
+
   <td>association_type</td>
 
<td></td>  <td id="cardinality_cell">0..1</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>
+
   <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 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>
 
<tr>
 
<tr>
Zeile 174: Zeile 101:
 
   <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 181: Zeile 108:
 
   <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>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level3">property</td>
 
   <td id="param_level3">property</td>
−
   <td></td>
+
   <td>property</td>
 
<td></td>  <td id="cardinality_cell">0..N</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>
 
   <td></td>
 
</tr>
 
</tr>
Zeile 210: Zeile 131:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level4">property_version</td>
 
   <td id="param_level4">property_version</td>
−
   <td></td>
+
   <td>property_version</td>
 
<td></td>  <td id="cardinality_cell">1..N</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>
 
   <td></td>
 
</tr>
 
</tr>
Zeile 251: Zeile 166:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</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>
 
   <td></td>
 
</tr>
 
</tr>
Zeile 270: Zeile 179:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Pflichtangabe, falls keine versionId angegeben wurde</td>
+
   <td>Mandatory, if versionId is not listed.</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>
 
<tr>
 
<tr>
Zeile 294: Zeile 191:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">0..1</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>
 
   <td></td>
 
</tr>
 
</tr>
Zeile 320: Zeile 211:
 
<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 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>
 
<tr>
 
<tr>
Zeile 335: Zeile 220:
 
   <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 351: Zeile 236:
 
</table>
 
</table>
  
−
=Anmerkungen=
+
=Annotations=
−
==Besonderheiten==
+
==Noteworthiness==
−
==Hinweise==
+
==Hints==
  
−
=Beispiele=
+
=Examples=
−
==SOAP-Nachrichten==
+
==SOAP messages==
 
<source lang="xml">
 
<source lang="xml">
  
 
</source>
 
</source>
  
−
==Code-Beispiele==
+
==Code examples==
 
===Java===
 
===Java===
 
<source lang="java">
 
<source lang="java">
  
 
</source>
 
</source>

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

Inhaltsverzeichnis

Functionality

Create a new or edit a existing association. Association type, properties and their versions can be edited or created.

Prerequisites

Requires Login.

Request/Response

The required request parameters differs for creating a new version and editing an existing one. The request and response table below refers to the creation of a new version only.

Required fields: new version

Required fields: edit version

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)
VersioningType VersioningType 1..1 Versioning information
createNewVersion Boolean 1..1 true if a new version should be created
majorUpdate Boolean 0..1 true if major version should count up
minorUpdate Boolean 0..1 true if minor version should count up
code_system_entity code_system_entity 1..1 Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
code_system_entity_version code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
majorRevision Integer 0..1 Major revision of this entry (composition of major and minor version e.g. 1.3).
minorRevision Integer 0..1 Minor revision of this entry (composition of major and minor version e.g. 1.3)
versionId Long 1..1 Version-ID of Entity-Version
association_type association_type 0..1 Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId 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)
property property 0..N
id Long 1..1
name String 65535 0..1
property_version property_version 1..N
content byte[] 0..1
contentMimetype String 50 0..1
contentName String 255 0..1
contentSize Integer 0..1
description String 65535 0..1
languageId Long 0..1
name String 65535 0..1 Mandatory, if versionId is not listed.
propertyKindId Long 0..1
status Integer 0..1
versionId Long 0..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

Annotations

Noteworthiness

Hints

Examples

SOAP messages

 

Code examples

Java

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