WS-Beschreibung - Terminologieserver Administration ImportCodeSystem
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(→Funktionalität) |
|||
Zeile 1: | Zeile 1: | ||
+ | <div class="commonTable"> | ||
<table border="0"> | <table border="0"> | ||
<tr> | <tr> | ||
Zeile 246: | Zeile 247: | ||
==SOAP-Nachrichten== | ==SOAP-Nachrichten== | ||
==Code-Beispiele== | ==Code-Beispiele== | ||
+ | </div> |
Version vom 16. Februar 2012, 09:53 Uhr
System | Terminologieserver |
Webservice | Administration |
WSDL | http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Administration?wsdl |
Methode | ImportCodeSystem |
Inhaltsverzeichnis |
Funktionalität
Mit ImportCodeSystem können Sie komplette CodeSysteme importieren. Dabei stehen 2 Formate zur Wahl: ClaML oder CSV.
Sie müssen bei jedem Import ein Codesystem angeben, welches durch den Import erstellt wird. Alle neuen Konzepte werden in dieses Codesystem eingeordnet.
Vorbedingungen
Sie müssen am Terminologieserver angemeldet sein, um den Webservice nutzen zu können.
Request/Response
Eingabewerte
importInfos
Parameter | Typ | Optional | Beschreibung |
---|---|---|---|
formatId | Long | Das Format des Dateiinhalts. ClaML: 193 CSV: 194 |
|
filecontent | byte[] | Der Dateiinhalt. CSV-Dateien müssen mit ISO-8859-1 kodiert werden. |
codeSystem
Parameter | Typ | Optional | Beschreibung |
---|---|---|---|
name | String | Name des anzulegenden Codesystems | |
description | String | x | Beschreibung des anzulegenden Codesystems |
codeSystemVersion | CodeSystemVersion | Die Version des anzulegenden Codesystems | |
name | String | Der Name der anzulegenden Codesystem-Version | |
releaseDate | java.util.Date | x | |
expirationDate | java.util.Date | x | |
source | String | x | |
description | String | x | |
oid | String (Länge: 100) | x | |
licenceHolder | String | x | |
underLicence | boolean | Gibt an, ob die Codesystem-Version unter einer Lizenz steht oder nicht. | |
licenceType | List<LicenceType> | x | |
typeTxt | String | Typ der Lizenz |
login
Parameter | Typ | Optional | Beschreibung |
---|---|---|---|
sessionID | String | Die Session-ID, welche nach den erfolgreichen Login übergeben wurde. |
Rückgabewerte
returnInfos
Parameter | Typ | Optional | Beschreibung |
---|---|---|---|
overallErrorCategory | Enum | INFO, WARN oder ERROR | |
status | Enum | OK oder FAILURE | |
message | String | Status-Meldung |
codeSystem
Parameter | Typ | Optional | Beschreibung |
---|---|---|---|
id | long | Die neue ID des hinzugefügten Codesystems | |
currentVersionId | long | Die neue ID der hinzugefügten Codesystem-Version | |
codeSystemVersion | CodeSystemVersion | Die Version des anzulegenden Codesystems | |
versionId | long | Die neue ID der hinzugefügten Codesystem-Version |
Anmerkungen
Besonderheiten
CSV-Import
Die kommagetrennte Datei muss folgendermaßen aufgebaut sein:
- Syntax
- Codierung: ISO-8859-1
- Felder getrennt mit einem Semikolon ;
- 1. Zeile enthält Informationen über die Spalten
- Felder
- erlaubte Werte
- code (entweder code oder term verpflichtend)
- term (entweder code oder term verpflichtend)
- term_abbrevation
- is_axis (1/0 oder true/false, Standard: 0)
- is_mainclass (1/0 oder true/false, Standard: 0)
- relation (Code, zu dem eine Beziehung aufgebaut wird)
- association_kind (1=ontologisch, 2=taxonomisch, 3=cross mapping; Standard: 2)
- association_type (Assoziationsbeschreibung, String, z.B. 'ist Unterklasse von', verpflichtend, wenn 'relation' angegeben ist)
- association_type_reverse (Assoziationsbeschreibung rückwärts, String, z.B. 'ist Oberklasse von', verpflichtend, wenn 'relation' angegeben ist)
- erlaubte Werte
*Kursive Einträge sind optional
Ist kein Code angegeben, wird die Term-Bezeichnung dafür verwendet (wird gekürzt auf eine max. Länge von 100 Zeichen)