Terminologieserver - Administration - ExportValueSetContent

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
Zeile 14: Zeile 14:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
 +
<tr>
 +
  <td id="cardinality_cell">1</td>
 +
  <td id="param_level1">loginToken</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Login-Token that ensures the user is logged in.</td>
 +
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">ExportParameterType</td>
+
   <td id="param_level1">exportInfos</td>
 
   <td>ExportParameterType</td>
 
   <td>ExportParameterType</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
Zeile 45: Zeile 53:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">ExportType</td>
+
   <td id="param_level1">valueSet</td>
 +
  <td>value_set</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">valueSetVersion</td>
 +
  <td>value_set_version</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Represents  the version of an valueset.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Version ID of the value set</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">1</td>
 +
  <td id="param_level1">exportParameter</td>
 
   <td>ExportType</td>
 
   <td>ExportType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
Zeile 59: Zeile 88:
 
SVS: 195</td>
 
SVS: 195</td>
 
</tr>
 
</tr>
 +
</table>
 +
<br>
 +
==Response==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Level</th>
 +
    <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">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">LoginType</td>
+
   <td id="param_level1">exportInfos</td>
−
   <td>LoginType</td>
+
   <td>ExportType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Login information</td>
+
   <td>Parameter for export</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
 
   <td id="cardinality_cell">2</td>
 
   <td id="cardinality_cell">2</td>
−
   <td id="param_level2">sessionID</td>
+
   <td id="param_level2">filecontent</td>
 +
  <td>byte[]</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>data content as a blob</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">formatId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Format of data content.
 +
ClaML: 193
 +
CSV: 194</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">url</td>
 
   <td>String</td>
 
   <td>String</td>
 
   <td></td>
 
   <td></td>
−
   <td id="cardinality_cell">1..1</td>
+
   <td id="cardinality_cell">0..1</td>
−
   <td>Session-ID from user (given by system)</td>
+
   <td>URL where exported data can be found</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">valueSet</td>
+
   <td id="param_level1">returnInfos</td>
−
   <td>value_set</td>
+
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>A subset of terms.Every valueset has at least one valueset-version.</td>
+
   <td>Return information</td>
 
</tr>
 
</tr>
−
<tr id="row_object">
+
<tr>
 
   <td id="cardinality_cell">2</td>
 
   <td id="cardinality_cell">2</td>
−
   <td id="param_level2">valueSetVersion</td>
+
   <td id="param_level2">count</td>
−
   <td>value_set_version</td>
+
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Represents  the version of an valueset.</td>
+
   <td>number of results</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
   <td id="cardinality_cell">3</td>
+
   <td id="cardinality_cell">2</td>
−
   <td id="param_level3">versionId</td>
+
   <td id="param_level2">message</td>
−
   <td>Long</td>
+
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>an additional message</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">overallErrorCategory</td>
 +
   <td></td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Version ID of the value set</td>
+
   <td>INFO, WARN, ERROR</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">status</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>OK, FAILURE</td>
 
</tr>
 
</tr>
−
</table>
 
−
<br>
 
−
==Response==
 
−
<table border="1" cellpadding="1" class="ws_table">
 
−
  <tr class="ws_table_head">
 
−
    <th>Level</th>
 
−
    <th>Parameter</th>
 
−
    <th>Typ</th>
 
−
    <th>L&auml;nge</th>
 
−
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 
−
    <th>Beschreibung</th>
 
−
  </tr>
 
 
</table>
 
</table>
 
<br><br>
 
<br><br>
  
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]

Version vom 22. Juli 2014, 12:53 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Exports all concepts from a given value set.

Request/Response

Request

Level Parameter Typ Länge Kardinalität Beschreibung
1 loginToken String 1..1 Login-Token that ensures the user is logged in.
1 exportInfos ExportParameterType 0..1 Contains additional parameters for export.
2 associationInfos String 1..1
2 codeSystemInfos Boolean 1..1 true, if additional information from a code system should be exported
2 translations Boolean 1..1 true, if translations should be exported
1 valueSet value_set 1..1 A subset of terms.Every valueset has at least one valueset-version.
2 valueSetVersion value_set_version 1..1 Represents the version of an valueset.
3 versionId Long 1..1 Version ID of the value set
1 exportParameter ExportType 1..1 Parameter for export
2 formatId Long 1..1 Format of data content.

CSV: 194

SVS: 195


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 exportInfos ExportType 1..1 Parameter for export
2 filecontent byte[] 0..1 data content as a blob
2 formatId Long 1..1 Format of data content.

ClaML: 193

CSV: 194
2 url String 0..1 URL where exported data can be found
1 returnInfos ReturnType 1..1 Return information
2 count Integer 1..1 number of results
2 message String 1..1 an additional message
2 overallErrorCategory 1..1 INFO, WARN, ERROR
2 status 1..1 OK, FAILURE



zurück zur Webservice-Übersicht

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