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 57: Zeile 57:
 
<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>A subset of terms.Every valueset has at least one valueset-version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Points to the current version of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Description of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>ID of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">name</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Name of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Alteration time of the status.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 64: Zeile 108:
 
<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>Represents  the version of an valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Timestamp of the insertion of the valueset version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">preferredLanguageCd</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Points to the previous version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Start date for the validity of the valueset version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>The status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Alteration time of the status.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">validityRange</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Validity range (German: Gültigkeitsbereich)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">valueSetId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Foreign key to the ID of the valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 74: Zeile 191:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">exportParameter</td>
+
   <td id="param_level1">exportInfos</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>
 
   <td>Parameter for export</td>
 
   <td>Parameter for export</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">filecontent</td>
 +
  <td>byte[]</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>data content as a blob</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 87: Zeile 211:
 
CSV: 194
 
CSV: 194
 
SVS: 195</td>
 
SVS: 195</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">url</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>URL where exported data can be found</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 119: Zeile 251:
 
   <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>Format of data content.
+
   <td>CSV: 194
−
ClaML: 193
+
SVS: 195</td>
−
CSV: 194</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>

Version vom 30. September 2014, 12:19 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 currentVersionId Long - Points to the current version of the valueset.
2 description String 65535 - Description of the valueset.
2 id Long - ID of the valueset.
2 name String 50 - Name of the valueset.
2 status Integer - Status of the current entry. Can be found in a domain.
2 statusDate java.util.Date - Alteration time of the status.
2 valueSetVersion value_set_version 1..1 Represents the version of an valueset.
3 insertTimestamp java.util.Date - Timestamp of the insertion of the valueset version.
3 name String -
3 oid String -
3 preferredLanguageCd String 30 - Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
3 previousVersionId Long - Points to the previous version.
3 releaseDate java.util.Date - Start date for the validity of the valueset version.
3 status Integer - The status of the current entry. Can be found in a domain.
3 statusDate java.util.Date - Alteration time of the status.
3 validityRange Long - Validity range (German: Gültigkeitsbereich)
3 valueSetId Long - Foreign key to the ID of the valueset.
3 versionId Long 1..1 Version ID of the value set
1 exportInfos ExportType 1..1 Parameter for export
2 filecontent byte[] - data content as a blob
2 formatId Long 1..1 Format of data content.

CSV: 194

SVS: 195
2 url String - URL where exported data can be found


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 CSV: 194 SVS: 195
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