WS-Beschreibung - Terminologieserver Administration ImportValueSet
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Becker (Diskussion | Beiträge) |
Becker (Diskussion | Beiträge) (→Request/Response) |
||
(Eine dazwischenliegende Version von einem Benutzer wird nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | = | + | =Functionality= |
− | + | Import value sets from a file in CSV format.<br> | |
− | <br><br> | + | <br> |
− | = | + | =Prerequisites= |
− | + | Requires [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]]. | |
=Request/Response= | =Request/Response= | ||
Zeile 20: | 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> | + | <td>Parameter for import</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 26: | 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> | + | <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 32: | 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 | + | <td>Login information</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 39: | Zeile 39: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Session-ID from user (given by system)</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 45: | 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> | + | <td>A subset of terms.Every valueset has at least one valueset-version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 52: | Zeile 52: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Description of the valueset. |
− | + | This field is only required if you create a new Value set.</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 59: | 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 | + | <td>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.</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 67: | Zeile 67: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | <td>Name | + | <td>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.</td> | |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 74: | 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> | + | <td>Represents the version of an valueset.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 80: | 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> | + | <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 86: | 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> | + | <td>Start date for the validity of the valueset version.</td> |
</tr> | </tr> | ||
</table> | </table> | ||
Zeile 102: | 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> | + | <td>Return information</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 108: | 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> | + | <td>number of results</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 115: | Zeile 115: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>an additional message</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 133: | 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> | + | <td>A subset of terms.Every valueset has at least one valueset-version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 139: | 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 | + | <td>ID of the valueset.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 145: | 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> | + | <td>Represents the version of an valueset.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 151: | 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> | + | <td>Version ID of the value set</td> |
</tr> | </tr> | ||
</table> | </table> | ||
− | = | + | =Annotations= |
− | == | + | ==Noteworthiness== |
'''CSV-Import'''<br> | '''CSV-Import'''<br> | ||
− | + | The comma separated file has to be build in this pattern:<br> | |
*Syntax | *Syntax | ||
− | ** | + | **Coding: ISO-8859-1 |
− | ** | + | **Fields will be separated by a ";" |
− | **Strings | + | **Strings has to be encapsulated with " ", if there are any special or delimiter symbols |
− | ** | + | **First row contains informations about columns |
− | * | + | *Fields |
− | ** | + | **legal values |
− | ***code ( | + | ***code (either code or term are required) |
− | ***concept_id ( | + | ***concept_id (either code or conecpt_id required) |
− | ***''codesystem_version_id'' ( | + | ***''codesystem_version_id'' (required if code angegeben is set) |
− | <!--***''sub_entries'' (1/0 | + | <!--***''sub_entries'' (1/0 or true/false, standard: 0 - Adds additional sub entries if concept contains any)--> |
− | <nowiki>*</nowiki>'' | + | <nowiki>*</nowiki>''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== |
− | <!-- | + | <!--Following files shows a example for a CSV import for a small code system with associations: [[:File:CSV-Import_Beispiel.csv|CSV-Import_Beispiel]] |
− | + | A example file (CSV) with different translations can be found here: [[:File:ISO_IEC_5218 Geschlechtercodes.csv|Geschlechtercodes CSV]]--> | |
− | ==SOAP | + | ==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/"> | ||
Zeile 194: | Zeile 194: | ||
</valueSet> | </valueSet> | ||
<importInfos> | <importInfos> | ||
− | <filecontent>BASE64-CONTENT</filecontent> <!-- | + | <filecontent>BASE64-CONTENT</filecontent> <!-- can be imported directly in soap-Ui via context menu --> |
</importInfos> | </importInfos> | ||
<login> | <login> | ||
− | <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID> <!-- Session-ID | + | <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID> <!-- insert Session-ID from login --> |
</login> | </login> | ||
</parameter> | </parameter> | ||
Zeile 205: | Zeile 205: | ||
</source> | </source> | ||
− | === | + | ===Insert into a existing 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/"> | ||
Zeile 219: | Zeile 219: | ||
</valueSet> | </valueSet> | ||
<importInfos> | <importInfos> | ||
− | <filecontent>BASE64-CONTENT</filecontent> <!-- | + | <filecontent>BASE64-CONTENT</filecontent> <!-- can be imported directly in soap-Ui via context menu --> |
</importInfos> | </importInfos> | ||
<login> | <login> | ||
− | <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID> <!-- Session-ID | + | <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID> <!-- insert Session-ID from login --> |
</login> | </login> | ||
</parameter> | </parameter> |
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:
- Syntax
- Coding: ISO-8859-1
- Fields will be separated by a ";"
- Strings has to be encapsulated with " ", if there are any special or delimiter symbols
- First row contains informations about columns
- Fields
- legal values
- code (either code or term are required)
- concept_id (either code or conecpt_id required)
- codesystem_version_id (required if code angegeben is set)
- legal values
*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>