WS-Beschreibung - Terminologieserver Authoring CreateValueSetContent
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Links one or more existing concepts with the specified 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 | Version-ID of Entity-Version | |
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 | Version ID of the value set |
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 |
Annotations
Noteworthiness
Hints
Examples
SOAP messages
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:CreateValueSetContent> <parameter> <codeSystemEntity> <id>17</id> <codeSystemEntityVersions> <versionId>17</versionId> </codeSystemEntityVersions> </codeSystemEntity> <valueSet> <id>1</id> <valueSetVersions> <versionId>1</versionId> </valueSetVersions> </valueSet> <login> <sessionID>xxx</sessionID> </login> </parameter> </aut:CreateValueSetContent> </soapenv:Body> </soapenv:Envelope>