WS-Beschreibung - Terminologieserver Authoring MaintainConcept
Aus Termserver-CTS2
Version vom 8. Juli 2013, 07:29 Uhr von Becker (Diskussion | Beiträge)
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 | 0..1 | Login-Informationen | ||
ip | String | - | Die IP-Adresse des Benutzers (wird intern vergeben) | |
password | String | - | Passwort des Benutzers (als MD5-Wert) | |
sessionID | String | 1..1 | Die Session-ID des Benutzers | |
username | String | - | Benutzername | |
VersioningType | 1..1 | Angaben zur Versionisierung | ||
createNewVersion | Boolean | 1..1 | true, wenn eine neue Version erstellt werden soll | |
majorUpdate | Boolean | 0..1 | true, wenn die Hauptversion hochgezählt werden soll | |
minorUpdate | Boolean | 0..1 | true, wenn die Nebenversion hochgezählt werden soll | |
code_system_entity | 1..1 | Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen. | ||
currentVersionId | Long | - | Die aktuelle ID der code_system_entity_version | |
id | Long | - | ||
code_system_entity_version | 1..1 | Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung. | ||
codeSystemEntityId | Long | - | ||
effectiveDate | java.util.Date | - | Zeitpunkt der letzten Änderung | |
insertTimestamp | java.util.Date | - | Zeitstempel, wann der Eintrag eingefügt worden ist | |
isLeaf | Boolean | - | Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden. | |
majorRevision | Integer | 0..1 | Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
minorRevision | Integer | 0..1 | Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
previousVersionId | Long | - | Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version. | |
status | Integer | - | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
statusDate | java.util.Date | - | Änderungszeitpunkt des Status | |
versionId | Long | 1..1 | ||
code_system_concept | 0..1 | Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version. | ||
code | String | 100 | 1..1 | Muss nicht angegeben werden, falls bestehende Version bearbeitet wird. |
codeSystemEntityVersionId | Long | - | ||
isPreferred | Boolean | 1..1 | Muss nicht angegeben werden, falls eine bestehende Version bearbeitet wird. | |
term | String | 65535 | 1..1 | Muss nicht angegeben werden, falls eine bestehende Version bearbeitet wird. |
termAbbrevation | String | 50 | 0..1 | |
code_system_concept_translation | 0..N | Übersetzung eines Begriffs. | ||
codeSystemEntityVersionId | Long | - | ||
id | Long | 0..1 | Muss nur angegeben werden, falls eine bestehende Übersetzung bearbeitet werden soll. | |
languageId | Long | 1..1 | Muss nicht angegeben werden, falls eine bestehende Version bearbeitet wird. | |
term | String | 65535 | 1..1 | Muss nicht angegeben werden, falls eine bestehende Version bearbeitet wird. |
termAbbrevation | String | 50 | 0..1 | |
property | 0..N | |||
currentVersionId | Long | - | ||
id | Long | 1..1 | ||
name | String | 65535 | - | |
property_version | 1..N | |||
codeSystemEntityVersionId | Long | - | ||
content | byte[] | 0..1 | ||
contentMimetype | String | 50 | 0..1 | |
contentName | String | 255 | 0..1 | |
contentSize | Integer | 0..1 | ||
description | String | 65535 | 0..1 | |
insertTimestamp | java.util.Date | - | ||
languageId | Long | 0..1 | ||
name | String | 65535 | 0..1 | |
previousVersionId | Long | - | ||
propertyId | Long | - | ||
propertyKindId | Long | 0..1 | ||
status | Integer | 0..1 | ||
statusDate | java.util.Date | - | ||
versionId | Long | 0..1 | ||
code_system_version_entity_membership | 0..1 | Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her. | ||
codeSystemEntityId | Long | - | ||
codeSystemVersionId | Long | - | ||
isAxis | Boolean | 1..1 | true, wenn die zugehörige Entity des Eintrags eine Achse des Codesystems ist | |
isMainClass | Boolean | 1..1 | true, wenn die zugehörige Entity des Eintrags eine Hauptklasse (root-Element) des Codesystems ist |
Response
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
ReturnType | 1..1 | Entählt Informationen über die Antwort. | ||
count | Integer | - | Anzahl der Ergebnisse | |
message | String | 1..1 | Status- oder Fehlermeldung | |
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>