WS-Beschreibung - Terminologieserver Authoring MaintainConcept
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Becker (Diskussion | Beiträge) |
Becker (Diskussion | Beiträge) (→Request/Response) |
||
Zeile 17: | Zeile 17: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">LoginType</td> | <td id="param_level1">LoginType</td> | ||
− | <td></td> | + | <td>LoginType</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td>Login | + | <td>Login information</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 40: | Zeile 26: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Session-ID from user (given by system)</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">VersioningType</td> | <td id="param_level1">VersioningType</td> | ||
− | <td></td> | + | <td>VersioningType</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Versioning information</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 59: | Zeile 38: | ||
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td>true | + | <td>true if a new version should be created</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 65: | Zeile 44: | ||
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td>true | + | <td>true if major version should count up</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 71: | Zeile 50: | ||
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td>true | + | <td>true if minor version should count up</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system_entity</td> | <td id="param_level1">code_system_entity</td> | ||
− | <td></td> | + | <td>code_system_entity</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">code_system_entity_version</td> | <td id="param_level2">code_system_entity_version</td> | ||
− | <td></td> | + | <td>code_system_entity_version</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>code_system_entity_version is the superclass of every Concept and Association. </td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 125: | Zeile 68: | ||
<td>Integer</td> | <td>Integer</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 131: | Zeile 74: | ||
<td>Integer</td> | <td>Integer</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 155: | Zeile 80: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td></td> | + | <td>Version-ID of Entity-Version</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level3">code_system_concept</td> | <td id="param_level3">code_system_concept</td> | ||
− | <td></td> | + | <td>code_system_concept</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Displays a concept or term. Specialization of code_system_entity_version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 168: | Zeile 93: | ||
<td>100</td> | <td>100</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>It must not be listed, if existing version is worked on.</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 180: | Zeile 99: | ||
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>It must not be listed, if existing version is worked on.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 187: | Zeile 106: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>It must not be listed, if existing version is worked on.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 194: | Zeile 113: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | <td></td> | + | <td>The abbrevation of the term.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level4">code_system_concept_translation</td> | <td id="param_level4">code_system_concept_translation</td> | ||
− | <td></td> | + | <td>code_system_concept_translation</td> |
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
− | <td> | + | <td>Translation of a term</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 212: | Zeile 125: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>It must be listed only, if an existing translation should be worked on.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 218: | Zeile 131: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>It must not be listed, if existing version is worked on.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 225: | Zeile 138: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>It must not be listed, if existing version is worked on.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 232: | Zeile 145: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | <td></td> | + | <td>Abbreviation of the translated term.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level3">property</td> | <td id="param_level3">property</td> | ||
− | <td></td> | + | <td>property</td> |
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
Zeile 250: | Zeile 157: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level4">property_version</td> | <td id="param_level4">property_version</td> | ||
− | <td></td> | + | <td>property_version</td> |
<td></td> <td id="cardinality_cell">1..N</td> | <td></td> <td id="cardinality_cell">1..N</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
Zeile 302: | Zeile 196: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
Zeile 321: | Zeile 209: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
Zeile 345: | Zeile 221: | ||
<td>Integer</td> | <td>Integer</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
Zeile 361: | Zeile 231: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">code_system_version_entity_membership</td> | <td id="param_level2">code_system_version_entity_membership</td> | ||
− | <td></td> | + | <td>code_system_version_entity_membership</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Connects the version of a Code System to the entities.</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 381: | Zeile 239: | ||
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td>true, | + | <td>true, if the belonging entity of the entry is an axis of the code system</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 387: | Zeile 245: | ||
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td>true, | + | <td>true, if the belonging entity of the entry is a root element of the code system.</td> |
</tr> | </tr> | ||
</table> | </table> | ||
Zeile 401: | Zeile 259: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">ReturnType</td> | <td id="param_level1">ReturnType</td> | ||
− | <td></td> | + | <td>ReturnType</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Return information</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 416: | Zeile 268: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>an additional message</td> |
</tr> | </tr> | ||
<tr> | <tr> |
Version vom 9. August 2013, 08:36 Uhr
Inhaltsverzeichnis |
Funktionalität
Neue Konzepte anlegen oder bestehende Versionen bearbeiten.
Vorbedingungen
Um diesen Webservice zu nutzen, müssen Sie sich zunächst am Terminologieserver anmelden (Login).
Request/Response
Request
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
LoginType | LoginType | 0..1 | Login information | |
sessionID | String | 1..1 | Session-ID from user (given by system) | |
VersioningType | VersioningType | 1..1 | Versioning information | |
createNewVersion | Boolean | 1..1 | true if a new version should be created | |
majorUpdate | Boolean | 0..1 | true if major version should count up | |
minorUpdate | Boolean | 0..1 | true if minor version should count up | |
code_system_entity | code_system_entity | 1..1 | 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. | |
majorRevision | Integer | 0..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
minorRevision | Integer | 0..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
versionId | Long | 1..1 | Version-ID of Entity-Version | |
code_system_concept | code_system_concept | 0..1 | Displays a concept or term. Specialization of code_system_entity_version. | |
code | String | 100 | 1..1 | It must not be listed, if existing version is worked on. |
isPreferred | Boolean | 1..1 | It must not be listed, if existing version is worked on. | |
term | String | 65535 | 1..1 | It must not be listed, if existing version is worked on. |
termAbbrevation | String | 50 | 0..1 | The abbrevation of the term. |
code_system_concept_translation | code_system_concept_translation | 0..N | Translation of a term | |
id | Long | 0..1 | It must be listed only, if an existing translation should be worked on. | |
languageId | Long | 1..1 | It must not be listed, if existing version is worked on. | |
term | String | 65535 | 1..1 | It must not be listed, if existing version is worked on. |
termAbbrevation | String | 50 | 0..1 | Abbreviation of the translated term. |
property | property | 0..N | ||
id | Long | 1..1 | ||
property_version | property_version | 1..N | ||
content | byte[] | 0..1 | ||
contentMimetype | String | 50 | 0..1 | |
contentName | String | 255 | 0..1 | |
contentSize | Integer | 0..1 | ||
description | String | 65535 | 0..1 | |
languageId | Long | 0..1 | ||
name | String | 65535 | 0..1 | |
propertyKindId | Long | 0..1 | ||
status | Integer | 0..1 | ||
versionId | Long | 0..1 | ||
code_system_version_entity_membership | code_system_version_entity_membership | 0..1 | Connects the version of a Code System to the entities. | |
isAxis | Boolean | 1..1 | true, if the belonging entity of the entry is an axis of the code system | |
isMainClass | Boolean | 1..1 | true, if the belonging entity of the entry is a root element of the code system. |
Response
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
ReturnType | ReturnType | 1..1 | Return information | |
message | String | 1..1 | an additional message | |
overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
status | 1..1 | OK, FAILURE |
Anmerkungen
Besonderheiten
Die Anforderungen an den Eingabe-Parameter hängen davon ab, ob eine neue Version angelegt werden soll oder nicht. Wird eine neue Version angelegt, so muss, wie bei der entsprechenden Create-Methode, der Name, Term und isPreferred der neuen Version angegeben werden. Soll hingegen eine bestehende Version verändert werden, ist nur die Angabe der CodeSystemEntity-Id und der CodeSystemEntityVersion-Id zwingend erforderlich. Alle anderen Angaben sind dann optional.
Hinweise
Beispiele
SOAP-Nachrichten
Minimale SOAP-Nachricht
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:MaintainConcept> <parameter> <codeSystemEntity> <id>1</id> <codeSystemEntityVersions> <versionId>1</versionId> <codeSystemConcepts> <code>X</code> <term>Y</term> <isPreferred>1</isPreferred> </codeSystemConcepts> </codeSystemEntityVersions> </codeSystemEntity> <login> <sessionID>abc</sessionID> </login> <versioning> <createNewVersion>1</createNewVersion> </versioning> </parameter> </aut:MaintainConcept> </soapenv:Body> </soapenv:Envelope>