Terminologieserver - Administration - ExportCodeSystemContent

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
Zeile 28: Zeile 28:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Name of codesystem. Each codesystem requires at least one version.</td>
 
   <td>Name of codesystem. Each codesystem requires at least one version.</td>
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">2</td>
 
−
  <td id="param_level2">codeSystemType</td>
 
−
  <td>String</td>
 
−
  <td>30</td>
 
−
  <td id="cardinality_cell">-</td>
 
−
  <td>Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6</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>Version of the Code System</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>Narrative description of Code System</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 58: Zeile 35:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Internal ID = Primary Key of Code System</td>
 
   <td>Internal ID = Primary Key of Code System</td>
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">2</td>
 
−
  <td id="param_level2">insertTimestamp</td>
 
−
  <td>java.util.Date</td>
 
−
<td></td>  <td id="cardinality_cell">-</td>
 
−
  <td>Timestamp, when the Code System was inserted</td>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">2</td>
 
−
  <td id="param_level2">name</td>
 
−
  <td>String</td>
 
−
  <td>100</td>
 
−
  <td id="cardinality_cell">-</td>
 
−
  <td>Name of the Code System. The precise name should be specified in the Code System Version.</td>
 
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 80: Zeile 42:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Version of a Code System</td>
 
   <td>Version of a Code System</td>
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">3</td>
 
−
  <td id="param_level3">codeSystemId</td>
 
−
  <td>Long</td>
 
−
<td></td>  <td id="cardinality_cell">-</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">3</td>
 
−
  <td id="param_level3">description</td>
 
−
  <td>String</td>
 
−
  <td>65535</td>
 
−
  <td id="cardinality_cell">-</td>
 
−
  <td>Description of the Code System</td>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">3</td>
 
−
  <td id="param_level3">expirationDate</td>
 
−
  <td>java.util.Date</td>
 
−
<td></td>  <td id="cardinality_cell">-</td>
 
−
  <td>Point of time the Code System looses its validity.</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>Point of time when the Code System Version was inserted.</td>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">3</td>
 
−
  <td id="param_level3">licenceHolder</td>
 
−
  <td>String</td>
 
−
  <td>65535</td>
 
−
  <td id="cardinality_cell">-</td>
 
−
  <td>Owner of the licence.</td>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">3</td>
 
−
  <td id="param_level3">name</td>
 
−
  <td>String</td>
 
−
  <td>100</td>
 
−
  <td id="cardinality_cell">-</td>
 
−
  <td>Complete Name of the Code System.</td>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">3</td>
 
−
  <td id="param_level3">oid</td>
 
−
  <td>String</td>
 
−
  <td>100</td>
 
−
  <td id="cardinality_cell">-</td>
 
−
  <td>Official OID</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 for this code system. 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>Refers to the prior version, if there are more than one.</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>Point of time, when this version starts to be valid.</td>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">3</td>
 
−
  <td id="param_level3">source</td>
 
−
  <td>String</td>
 
−
  <td>65535</td>
 
−
  <td id="cardinality_cell">-</td>
 
−
  <td>Source of the Code System 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>Status of the current entry. Can be taken from 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>Point of time of the last change of the status</td>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">3</td>
 
−
  <td id="param_level3">underLicence</td>
 
−
  <td>Boolean</td>
 
−
<td></td>  <td id="cardinality_cell">-</td>
 
−
  <td>true, if Code System is under license (Code System will be invisible for all users without proper license)</td>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="cardinality_cell">3</td>
 
−
  <td id="param_level3">validityRange</td>
 
−
  <td>String</td>
 
−
  <td>30</td>
 
−
  <td id="cardinality_cell">-</td>
 
−
  <td>Validity range, Values from domain list "codesystem_validityrange".
 
−
Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 207: Zeile 56:
 
<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 223: Zeile 65:
 
ClaML: 193
 
ClaML: 193
 
CSV: 194</td>
 
CSV: 194</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>
 
<tr id="row_object">
 
<tr id="row_object">

Version vom 30. September 2014, 12:30 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Export whole code systems in given export format.

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 codeSystem code_system 1..1 Name of codesystem. Each codesystem requires at least one version.
2 id Long 1..1 Internal ID = Primary Key of Code System
2 codeSystemVersion code_system_version 0..1 Version of a Code System
3 versionId Long 1..1
1 exportInfos ExportType 1..1 Parameter for export
2 formatId Long 1..1 Format of data content.

ClaML: 193

CSV: 194
1 exportParameter 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


Response

Level Parameter Typ Länge Kardinalität Beschreibung
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
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

Beispiele

SOAP

Export example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <adm:ExportCodeSystemContent>
         <parameter>
            <codeSystem>
               <id>7</id>
               <codeSystemVersions>
                 <versionId>8</versionId>
               </codeSystemVersions>
            </codeSystem>
            <exportInfos>
               <formatId>193</formatId>
            </exportInfos>
            <exportParameter>
              <dateFrom>2010-01-01T00:00:00.0</dateFrom>
            </exportParameter>
         </parameter>
      </adm:ExportCodeSystemContent>
   </soapenv:Body>
</soapenv:Envelope>



zurück zur Webservice-Übersicht

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