WS-Beschreibung - Terminologieserver Authoring RemoveValueSetContent
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Removes one or more concepts from a value set version.
Prerequisites
Requires (Login).
Request/Response
Request
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| LoginType | LoginType | 1..1 | Login information | |
| sessionID | String | 1..1 | Session-ID from user (given by system) | |
| code_system_entity | code_system_entity | 1..N | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
| code_system_entity_version | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
| versionId | Long | 1..1 | The version-ID which should be removed from the Value set. Besides, the concept itself is not extinguished! | |
| value_set | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| value_set_version | value_set_version | 1..1 | Represents the version of an valueset. | |
| versionId | Long | 1..1 | The ID of the Value Set from which concepts should be removed. |
Response
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| returnInfos | 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 |
Annotations
Noteworthiness
Hints
Examples
SOAP messages
Removes two concepts from a value set version.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:RemoveValueSetContent> <parameter> <valueSet> <valueSetVersions> <versionId>1</versionId> </valueSetVersions> </valueSet> <codeSystemEntity> <codeSystemEntityVersions> <versionId>1</versionId> </codeSystemEntityVersions> </codeSystemEntity> <codeSystemEntity> <codeSystemEntityVersions> <versionId>2</versionId> </codeSystemEntityVersions> </codeSystemEntity> <login> <sessionID>INSERT SESSION-ID</sessionID> </login> </parameter> </aut:RemoveValueSetContent> </soapenv:Body> </soapenv:Envelope>
