Terminologieserver - Authoring - RemoveValueSetContent
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
| (3 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt) | |||
| Zeile 2: | Zeile 2: | ||
=Beschreibung= | =Beschreibung= | ||
| − | + | Remove one or more concepts from a value set version. <br> | |
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
| Zeile 14: | Zeile 14: | ||
<th>Beschreibung</th> | <th>Beschreibung</th> | ||
</tr> | </tr> | ||
| − | <tr | + | <tr> |
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
| − | <td id="param_level1"> | + | <td id="param_level1">loginToken</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
<td>String</td> | <td>String</td> | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Login-Token that ensures the user is logged in.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
| Zeile 120: | Zeile 113: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| + | =Beispiele= | ||
| + | ==SOAP== | ||
| + | ===Sample to remove 2 concepts from a value set version=== | ||
| + | <source lang="xml"> | ||
| + | <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> | ||
| + | |||
| + | <loginToken>INSERT YOUR TOKEN</loginToken> | ||
| + | </parameter> | ||
| + | </aut:RemoveValueSetContent> | ||
| + | </soapenv:Body> | ||
| + | </soapenv:Envelope> | ||
| + | </source> | ||
<br><br> | <br><br> | ||
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]] | [[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]] | ||
Aktuelle Version vom 30. September 2014, 12:31 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Remove one or more concepts from a value set version.
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 | codeSystemEntity | code_system_entity | 1..N | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
| 2 | codeSystemEntityVersion | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
| 3 | versionId | Long | 1..1 | The version-ID which should be removed from the Value set. Besides, the concept itself is not extinguished! | |
| 1 | valueSet | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 2 | valueSetVersion | value_set_version | 1..1 | Represents the version of an valueset. | |
| 3 | versionId | Long | 1..1 | The ID of the Value Set from which concepts should be removed. |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 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 |
Beispiele
SOAP
Sample to remove 2 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> <loginToken>INSERT YOUR TOKEN</loginToken> </parameter> </aut:RemoveValueSetContent> </soapenv:Body> </soapenv:Envelope>
