WS-Beschreibung - Terminologieserver Authoring CreateConcept

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Request/Response)
(→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">code_system</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 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 Versions-ID</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level2">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Beschreibung eines Codesystems</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</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>Zeitstempel, wann das Codesystem eingefügt worden ist</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level2">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Name des Codesystems. Der genau Name sollte in der Version angegeben werden</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_version</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Version eines Codesystems</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">codeSystemId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Beschreibung des Codesystems</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">expirationDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Datum, bis wann die Version gültig ist</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 die Codesystem-Version eingefügt worden ist</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">licenceHolder</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Besitzer der Lizenz</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Vollständiger Name des Codesystems</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Offizielle OID</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">preferredLanguageId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)</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">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Datum, ab wann die Version gültig ist</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">source</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Herausgeber der Codesystem-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">underLicence</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)</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_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 id="gray">
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level3">code_system_concept</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>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">code</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level4">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">isPreferred</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">term</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">termAbbrevation</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level4">code_system_concept_translation</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">0..N</td>
 +
  <td>Übersetzung eines Begriffs.</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 id="gray">
 +
  <td id="param_level5">id</td>
 +
  <td>Long</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">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">term</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">termAbbrevation</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></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 id="gray">
 +
  <td id="param_level4">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</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">1..1</td>
 +
  <td></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 id="gray">
 +
  <td id="param_level5">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_version_entity_membership</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her.</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">codeSystemVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">isAxis</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true, wenn die zugehörige Entity des Eintrags eine Achse des Codesystems ist</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">isMainClass</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true, wenn die zugehörige Entity des Eintrags eine Hauptklasse (root-Element) des Codesystems ist</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>
 +
<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>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Die aktuelle ID der code_system_entity_version</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</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 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>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
</table>
  
 
=Anmerkungen=
 
=Anmerkungen=

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

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

Inhaltsverzeichnis

Funktionalität

Anlegen neuer Kontepte innerhalb einer bestimmten Vokabular-Version.

Vorbedingungen

Um diesen Webservice zu nutzen, müssen Sie sich zunächst am Terminologieserver anmelden (Login). Es müssen ein Vokabular und eine Vokabular-Version vorhanden sein.

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
code_system 1..1 Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.
currentVersionId Long - Die aktuelle Versions-ID
description String 65535 - Beschreibung eines Codesystems
id Long 1..1
insertTimestamp java.util.Date - Zeitstempel, wann das Codesystem eingefügt worden ist
name String 100 - Name des Codesystems. Der genau Name sollte in der Version angegeben werden
code_system_version 1..1 Version eines Codesystems
codeSystemId Long -
description String 65535 - Beschreibung des Codesystems
expirationDate java.util.Date - Datum, bis wann die Version gültig ist
insertTimestamp java.util.Date - Zeitstempel, wann die Codesystem-Version eingefügt worden ist
licenceHolder String 65535 - Besitzer der Lizenz
name String 100 - Vollständiger Name des Codesystems
oid String 100 - Offizielle OID
preferredLanguageId Long - Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)
previousVersionID Long - Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.
releaseDate java.util.Date - Datum, ab wann die Version gültig ist
source String 65535 - Herausgeber der Codesystem-Version
status Integer - Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.
statusDate java.util.Date - Änderungszeitpunkt des Status
underLicence Boolean - true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)
versionId Long 1..1
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 -
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 -
isPreferred Boolean 1..1
term String 65535 1..1
termAbbrevation String 50 0..1
code_system_concept_translation 0..N Übersetzung eines Begriffs.
codeSystemEntityVersionId Long -
id Long -
languageId Long 1..1
term String 65535 1..1
termAbbrevation String 50 0..1
property 0..N
currentVersionId Long -
id Long -
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 1..1
previousVersionId Long -
propertyId Long -
propertyKindId Long 0..1
status Integer 0..1
statusDate java.util.Date -
versionId Long -
code_system_version_entity_membership 0..1 Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her.
codeSystemEntityId Long -
codeSystemVersionId Long -
isAxis Boolean 1..1 true, wenn die zugehörige Entity des Eintrags eine Achse des Codesystems ist
isMainClass Boolean 1..1 true, wenn die zugehörige Entity des Eintrags eine Hauptklasse (root-Element) des Codesystems ist

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
code_system_entity 1..1 Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.
currentVersionId Long 1..1 Die aktuelle ID der code_system_entity_version
id Long 1..1
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 - 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 1..1

Anmerkungen

Besonderheiten

Hinweise

Beispiele

SOAP-Nachrichten

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <aut:CreateConcept>
         <parameter>
            <codeSystem>   
               <id>1</id>
               <codeSystemVersions>
 		    <versionId>1</versionId>
               </codeSystemVersions>              
	    </codeSystem>
            <codeSystemEntity>
		<codeSystemEntityVersions>
			<codeSystemConcepts>
				<code> x </code>
				<term> y </term>
 				<isPreferred>true</isPreferred>
			</codeSystemConcepts>
                </codeSystemEntityVersions>
	    </codeSystemEntity>
            <login>               
               <sessionID> xxx </sessionID>  
            </login>            
         </parameter>
      </aut:CreateConcept>
   </soapenv:Body>
</soapenv:Envelope

Code-Beispiele

Java

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