WS-Beschreibung - Terminologieserver Administration ImportValueSet

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Request/Response)
(→Request/Response)
 
(7 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
<div class="commonTable">
+
=Functionality=
−
<table border="0">
+
Import value sets from a file in CSV format.<br>
−
  <tr>
+
<br>
−
    <td width="100px" style="font-weight: bold;">System</td>
+
−
    <td>Terminologieserver</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Webservice</td>
+
−
    <td>Administration</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">WSDL</td>
+
−
    <td>http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Administration?wsdl</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Methode</td>
+
−
    <td>ImportValueSet</td>
+
−
  </tr>
+
−
</table><br>
+
−
=Funktionalität=
+
−
Mit ImportValueSet können Value Set-Inhalte in den Terminologieserver importiert werden. Dabei müssen die Daten im CSV-Format vorliegen.  
+
−
<br><br>
+
  
−
=Vorbedingungen=
+
=Prerequisites=
−
Erfordert [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]].
+
Requires [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]].
  
 
=Request/Response=
 
=Request/Response=
Zeile 39: Zeile 20:
 
   <td>ImportType</td>
 
   <td>ImportType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Import-Metadaten</td>
+
   <td>Parameter for import</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 45: Zeile 26:
 
   <td>byte[]</td>
 
   <td>byte[]</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Der Dateiinhalt. CSV-Dateien müssen mit ISO-8859-1 kodiert werden.</td>
+
   <td>The file content as a blob. CSV files have to be encoded with ISO-8859-1.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 51: Zeile 32:
 
   <td>LoginType</td>
 
   <td>LoginType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Login-Informationen</td>
+
   <td>Login information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 58: Zeile 39:
 
   <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>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 64: Zeile 45:
 
   <td>value_set</td>
 
   <td>value_set</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.</td>
+
   <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 71: Zeile 52:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Beschreibung des Valuesets
+
   <td>Description of the valueset.
−
Dieses Feld wird nur benötigt, wenn Sie ein neues Value Set anlegen.</td>
+
This field is only required if you create a new Value set.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 78: Zeile 59:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>ID des Valuesets
+
   <td>ID of the valueset.
−
Sie müssen entweder die ID eines Value Sets angeben oder einen Namen angeben, falls Sie ein neues Value Set erstellen möchten.</td>
+
They must list either the ID of a Value set, or list a name, if you liked to create a new Value set.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 86: Zeile 67:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Name des Valuesets
+
   <td>Name of the valueset.
−
Sie müssen entweder die ID eines Value Sets angeben oder einen Namen angeben, falls Sie ein neues Value Set erstellen möchten.</td>
+
They must list either the ID of a Value set, or list a name, if you liked to create a new Value set.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 93: Zeile 74:
 
   <td>value_set_version</td>
 
   <td>value_set_version</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Stellt die Version eines Valuesets dar.</td>
+
   <td>Represents  the version of an valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 99: Zeile 80:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)</td>
+
   <td>The preferred langue of the code system. (The ID has to be taken from the domain 'ISO_639_1_Language_Codes' - ID 1)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 105: Zeile 86:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Datum, ab dem die Valueset-Version gültig ist</td>
+
   <td>Start date for the validity of the valueset version.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 121: Zeile 102:
 
   <td>ReturnType</td>
 
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Enthält Informationen über die Antwort.</td>
+
   <td>Return information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 127: Zeile 108:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Anzahl der Ergebnisse</td>
+
   <td>number of results</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 134: Zeile 115:
 
   <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 152: Zeile 133:
 
   <td>value_set</td>
 
   <td>value_set</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.</td>
+
   <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 158: Zeile 139:
 
   <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>ID des Valuesets</td>
+
   <td>ID of the valueset.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 164: Zeile 145:
 
   <td>value_set_version</td>
 
   <td>value_set_version</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Stellt die Version eines Valuesets dar.</td>
+
   <td>Represents  the version of an valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 170: Zeile 151:
 
   <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>Versions-ID des Valuesets</td>
+
   <td>Version ID of the value set</td>
 
</tr>
 
</tr>
 
</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)
−
***conecpt_id (entweder code oder conecpt_id verpflichtend)
+
***concept_id (either code or conecpt_id required)
−
<!--***''sub_entries'' (1/0 oder true/false, Standard: 0 - Fügt zusätzlich alle Untereinträge hinzu, falls das Konzept welche beinhaltet)-->
+
***''codesystem_version_id'' (required if code angegeben is set)
−
<nowiki>*</nowiki>''Kursive'' Einträge sind optional
+
<!--***''sub_entries'' (1/0 or true/false, standard: 0 - Adds additional sub entries if concept contains any)-->
 +
<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==
 +
===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/">
 
   <soapenv:Header/>
 
   <soapenv:Header/>
 
   <soapenv:Body>
 
   <soapenv:Body>
−
       <adm:ImportCodeSystem>
+
       <adm:ImportValueSet>
 
         <parameter>
 
         <parameter>
−
             <codeSystem>
+
             <valueSet>
−
              <codeSystemVersions>
+
               <name>NEUER VALUESET NAME</name>
−
                  <name>Administrative sex (HL7)</name>
+
             </valueSet>
−
                  <underLicence>0</underLicence>
+
−
              </codeSystemVersions>
+
−
               <name>Administrative sex (HL7)</name>
+
−
             </codeSystem>
+
 
             <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 -->
−
              <formatId>194</formatId>
+
 
             </importInfos>
 
             </importInfos>
 
             <login>
 
             <login>
−
               <sessionID>71a4f756-dc1a-41a6-941d-0e4fb0145f7f</sessionID>  <!-- Session-ID vom Login einfügen -->
+
               <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID>  <!-- insert Session-ID from login -->
 
             </login>
 
             </login>
 
         </parameter>
 
         </parameter>
−
       </adm:ImportCodeSystem>
+
       </adm:ImportValueSet>
 
   </soapenv:Body>
 
   </soapenv:Body>
−
</soapenv:Envelope>
+
</soapenv:Envelope>
 +
</source>
  
 +
===Insert into a existing value set===
 +
<source lang="xml">
 +
<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>
 
</source>
 
</source>

Aktuelle Version vom 9. August 2013, 08:30 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 Parameter for import
filecontent byte[] 1..1 The file content as a blob. CSV files have to be encoded with ISO-8859-1.
LoginType LoginType 1..1 Login information
sessionID String 1..1 Session-ID from user (given by system)
value_set value_set 1..1 A subset of terms.Every valueset has at least one valueset-version.
description String 65535 0..1 Description of the valueset. This field is only required if you create a new Value set.
id Long 0..1 ID of the valueset. They must list either the ID of a Value set, or list a name, if you liked to create a new Value set.
name String 50 0..1 Name of the valueset. They must list either the ID of a Value set, or list a name, if you liked to create a new Value set.
value_set_version value_set_version 0..1 Represents the version of an valueset.
preferredLanguageId Long 0..1 The preferred langue of the code system. (The ID has to be taken from the domain 'ISO_639_1_Language_Codes' - ID 1)
releaseDate java.util.Date 0..1 Start date for the validity of the valueset version.

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Return information
count Integer 1..1 number of results
message String 1..1 an additional message
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE
value_set value_set 0..1 A subset of terms.Every valueset has at least one valueset-version.
id Long 1..1 ID of the valueset.
value_set_version value_set_version 1..1 Represents the version of an valueset.
versionId Long 1..1 Version ID of the value set

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