Terminologieserver - Administration - ExportValueSetContent
Aus Termserver-CTS2
Version vom 30. September 2014, 12:19 Uhr von Muetzner (Diskussion | Beiträge)
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 |
