Terminologieserver - Authoring - MaintainValueSet
Aus Termserver-CTS2
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Create a new value set version or edit an existing one.
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 | versioning | VersioningType | 1..1 | Versioning information | |
| 2 | createNewVersion | Boolean | 1..1 | true if a new version should be created | |
| 2 | majorUpdate | Boolean | 0..1 | true if major version should count up | |
| 2 | minorUpdate | Boolean | 0..1 | true if minor version should count up | |
| 1 | valueSet | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 2 | description | String | 65535 | 0..1 | Description of the valueset. |
| 2 | id | Long | 1..1 | ID of the valueset. | |
| 2 | name | String | 50 | 1..1 | Name of the valueset. |
| 2 | valueSetVersion | value_set_version | - | Represents the version of an valueset. | |
| 3 | name | String | 0..1 | ||
| 3 | oid | String | 0..1 | ||
| 3 | preferredLanguageCd | String | 30 | 0..1 | Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
| 3 | releaseDate | java.util.Date | 0..1 | Start date for the validity of the valueset version. | |
| 3 | status | Integer | 0..1 | The status of the current entry. Can be found in a domain. | |
| 3 | validityRange | Long | 0..1 | Validity range (German: Gültigkeitsbereich) | |
| 3 | versionId | Long | 1..1 | Only mandatory, if no new version is put on. |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | returnInfos | ReturnType | 1..1 | Return information | |
| 2 | message | String | 1..1 | an additional message | |
| 2 | overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| 2 | status | 1..1 | OK, FAILURE |
Beispiele
SOAP
Simple sample
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:MaintainValueSet> <parameter> <valueSet> <id>1</id> <valueSetVersions> <versionId>1</versionId> <name>Changed Versionname</name> </valueSetVersions> </valueSet> <versioning> <createNewVersion>1</createNewVersion> </versioning> <login> <sessionID>xxx</sessionID> </login> </parameter> </aut:MaintainValueSet> </soapenv:Body> </soapenv:Envelope>
