WS-Beschreibung - Terminologieserver Administration ImportValueSet

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
Zeile 1: Zeile 1:
−
=Funktionalität=
+
=Functionality=
−
Mit ImportValueSet können Value Set-Inhalte in den Terminologieserver importiert werden. Dabei müssen die Daten im CSV-Format vorliegen.  
+
Import value sets from a file in CSV format.<br>
−
<br><br>
+
<br>
  
−
=Vorbedingungen=
+
=Prerequisites=
−
Erfordert [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]].
+
Requires [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]].
  
 
=Request/Response=
 
=Request/Response=
Zeile 155: Zeile 155:
 
</table>
 
</table>
  
−
=Anmerkungen=
+
=Annotations=
−
==Besonderheiten==
+
==Noteworthiness==
 
'''CSV-Import'''<br>
 
'''CSV-Import'''<br>
−
Die kommagetrennte Datei muss folgendermaßen aufgebaut sein:<br>
+
The comma separated file has to be build in this pattern:<br>
 
*Syntax
 
*Syntax
−
**Codierung: ISO-8859-1
+
**Coding: ISO-8859-1
−
**Felder getrennt mit einem Semikolon ;
+
**Fields will be separated by a ";"
−
**Strings können, falls Sie Sonderzeichen oder Trennzeichen enthalten, mit " " angegeben werden
+
**Strings has to be encapsulated with " ", if there are any special or delimiter symbols
−
**1. Zeile enthält Informationen über die Spalten
+
**First row contains informations about columns
−
*Felder
+
*Fields
−
**erlaubte Werte
+
**legal values
−
***code (entweder code oder conecpt_id verpflichtend)
+
***code (either code or term are required)
−
***concept_id (entweder code oder conecpt_id verpflichtend)
+
***concept_id (either code or conecpt_id required)
−
***''codesystem_version_id'' (muss angegeben werden, wenn der code angegeben ist)
+
***''codesystem_version_id'' (required if code angegeben is set)
−
<!--***''sub_entries'' (1/0 oder true/false, Standard: 0 - Fügt zusätzlich alle Untereinträge hinzu, falls das Konzept welche beinhaltet)-->
+
<!--***''sub_entries'' (1/0 or true/false, standard: 0 - Adds additional sub entries if concept contains any)-->
−
<nowiki>*</nowiki>''Kursive'' Einträge sind optional
+
<nowiki>*</nowiki>''Italic'' Entries are optional
  
−
Ist keine Konzept-ID angegeben, wird die Code-Bezeichnung verwendet, um die Konzept-ID zu lesen (schlechtere Performance).
+
If no concept id is given, the code denotation will be used to read concept id (lower performance)
  
−
==Hinweise==
+
==Hints==
  
−
=Beispiele=
+
=Examples=
−
==Dateien==
+
==Files==
−
<!--Die folgende Datei zeigt ein Beispiel eines CSV-Imports mit einem kleinen Vokabular inklusive Beziehungen: [[:File:CSV-Import_Beispiel.csv|CSV-Import_Beispiel]]
+
<!--Following files shows a example for a CSV import for a small code system with associations: [[:File:CSV-Import_Beispiel.csv|CSV-Import_Beispiel]]
  
−
Eine Beispieldatei (CSV) mit verschiedenen Übersetzungen ist hier zu finden: [[:File:ISO_IEC_5218 Geschlechtercodes.csv|Geschlechtercodes CSV]]-->
+
A example file (CSV) with different translations can be found here: [[:File:ISO_IEC_5218 Geschlechtercodes.csv|Geschlechtercodes CSV]]-->
  
−
==SOAP-Nachrichten==
+
==SOAP messages==
−
===Einfügen in ein neues Value Set===
+
===Insert a new value set===
 
  <source lang="xml">
 
  <source lang="xml">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/">
Zeile 194: Zeile 194:
 
             </valueSet>
 
             </valueSet>
 
             <importInfos>
 
             <importInfos>
−
               <filecontent>BASE64-CONTENT</filecontent>  <!-- kann man in Soap-UI direkt importieren (Kontextmenü) -->
+
               <filecontent>BASE64-CONTENT</filecontent>  <!-- can be imported directly in soap-Ui via context menu -->
 
             </importInfos>
 
             </importInfos>
 
             <login>
 
             <login>
−
               <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID>  <!-- Session-ID vom Login einfügen -->
+
               <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID>  <!-- insert Session-ID from login -->
 
             </login>
 
             </login>
 
         </parameter>
 
         </parameter>
Zeile 205: Zeile 205:
 
</source>
 
</source>
  
−
===Einfügen in ein vorhandenes Value Set===
+
===Insert into a existing value set===
 
  <source lang="xml">
 
  <source lang="xml">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/">
Zeile 219: Zeile 219:
 
             </valueSet>
 
             </valueSet>
 
             <importInfos>
 
             <importInfos>
−
               <filecontent>BASE64-CONTENT</filecontent>  <!-- kann man in Soap-UI direkt importieren (Kontextmenü) -->
+
               <filecontent>BASE64-CONTENT</filecontent>  <!-- can be imported directly in soap-Ui via context menu -->
 
             </importInfos>
 
             </importInfos>
 
             <login>
 
             <login>
−
               <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID>  <!-- Session-ID vom Login einfügen -->
+
               <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID>  <!-- insert Session-ID from login -->
 
             </login>
 
             </login>
 
         </parameter>
 
         </parameter>

Version vom 8. August 2013, 09:37 Uhr

Inhaltsverzeichnis

Functionality

Import value sets from a file in CSV format.

Prerequisites

Requires Login.

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
importInfos ImportType 1..1 Import-Metadaten
filecontent byte[] 1..1 Der Dateiinhalt. CSV-Dateien müssen mit ISO-8859-1 kodiert werden.
LoginType LoginType 1..1 Login-Informationen
sessionID String 1..1 Die Session-ID des Benutzers
value_set value_set 1..1 Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.
description String 65535 0..1 Beschreibung des Valuesets Dieses Feld wird nur benötigt, wenn Sie ein neues Value Set anlegen.
id Long 0..1 ID des Valuesets Sie müssen entweder die ID eines Value Sets angeben oder einen Namen angeben, falls Sie ein neues Value Set erstellen möchten.
name String 50 0..1 Name des Valuesets Sie müssen entweder die ID eines Value Sets angeben oder einen Namen angeben, falls Sie ein neues Value Set erstellen möchten.
value_set_version value_set_version 0..1 Stellt die Version eines Valuesets dar.
preferredLanguageId Long 0..1 Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)
releaseDate java.util.Date 0..1 Datum, ab dem die Valueset-Version gültig ist

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Enthält 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
value_set value_set 0..1 Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.
id Long 1..1 ID des Valuesets
value_set_version value_set_version 1..1 Stellt die Version eines Valuesets dar.
versionId Long 1..1 Versions-ID des Valuesets

Annotations

Noteworthiness

CSV-Import
The comma separated file has to be build in this pattern:

*Italic Entries are optional

If no concept id is given, the code denotation will be used to read concept id (lower performance)

Hints

Examples

Files

SOAP messages

Insert a new value set

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <adm:ImportValueSet>
         <parameter>
            <valueSet>
               <name>NEUER VALUESET NAME</name>
            </valueSet>
            <importInfos>
              <filecontent>BASE64-CONTENT</filecontent>  <!-- can be imported directly in soap-Ui via context menu -->
            </importInfos>
            <login>
               <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID>  <!-- insert Session-ID from login -->
            </login>
         </parameter>
      </adm:ImportValueSet>
   </soapenv:Body>
</soapenv:Envelope>

Insert into a existing value set

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <adm:ImportValueSet>
         <parameter>
            <valueSet>
               <id>10</id>
               <valueSetVersions>
                 <versionId>11</versionId>
               </valueSetVersions>
            </valueSet>
            <importInfos>
              <filecontent>BASE64-CONTENT</filecontent>  <!-- can be imported directly in soap-Ui via context menu -->
            </importInfos>
            <login>
               <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID>  <!-- insert Session-ID from login -->
            </login>
         </parameter>
      </adm:ImportValueSet>
   </soapenv:Body>
</soapenv:Envelope>
Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=WS-Beschreibung_-_Terminologieserver_Administration_ImportValueSet“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge