Terminologieserver - Administration - ExportCodeSystemContent
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(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 35: | Zeile 58: | ||
<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 42: | Zeile 80: | ||
<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 56: | Zeile 207: | ||
<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 65: | Zeile 223: | ||
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:19 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 | codeSystemType | String | 30 | - | Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6 |
2 | currentVersionId | Long | - | Version of the Code System | |
2 | description | String | 65535 | - | Narrative description of Code System |
2 | id | Long | 1..1 | Internal ID = Primary Key of Code System | |
2 | insertTimestamp | java.util.Date | - | Timestamp, when the Code System was inserted | |
2 | name | String | 100 | - | Name of the Code System. The precise name should be specified in the Code System Version. |
2 | codeSystemVersion | code_system_version | 0..1 | Version of a Code System | |
3 | codeSystemId | Long | - | ||
3 | description | String | 65535 | - | Description of the Code System |
3 | expirationDate | java.util.Date | - | Point of time the Code System looses its validity. | |
3 | insertTimestamp | java.util.Date | - | Point of time when the Code System Version was inserted. | |
3 | licenceHolder | String | 65535 | - | Owner of the licence. |
3 | name | String | 100 | - | Complete Name of the Code System. |
3 | oid | String | 100 | - | Official OID |
3 | preferredLanguageCd | String | 30 | - | Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
3 | previousVersionID | Long | - | Refers to the prior version, if there are more than one. | |
3 | releaseDate | java.util.Date | - | Point of time, when this version starts to be valid. | |
3 | source | String | 65535 | - | Source of the Code System Version |
3 | status | Integer | - | Status of the current entry. Can be taken from a domain. | |
3 | statusDate | java.util.Date | - | Point of time of the last change of the status | |
3 | underLicence | Boolean | - | true, if Code System is under license (Code System will be invisible for all users without proper license) | |
3 | validityRange | String | 30 | - | Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional) |
3 | versionId | Long | 1..1 | ||
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.
ClaML: 193 CSV: 194 |
|
2 | url | String | - | URL where exported data can be found | |
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>