WS-Beschreibung - Terminologieserver Concept Association ReturnConceptAssociationDetails
Aus Termserver-CTS2
Version vom 27. März 2012, 09:15 Uhr von Muetzner (Diskussion | Beiträge)
| System | Terminologieserver |
| Webservice | Concept Association |
| WSDL | http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/ConceptAssociations?wsdl |
| Methode | CreateConceptAssociation |
Inhaltsverzeichnis |
Funktionalität
Gibt die Details der zwei Entitäten die durch die angegebene Assoziation verknüpft werden, sowie die Details zur Assoziation selbst an.
Vorbedingungen
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 | |
| code_system_entity_version_association | 1..1 | Setzt 2 Entity-Versionen in Beziehung miteinander. | ||
| associationKind | Integer | - | 1 = ontologisch,
2 = taxonomisch, 3 = cross mapping |
|
| associationTypeId | Long | - | Gibt den Typ der Beziehung an (z.B. 'gehört zu') | |
| codeSystemEntityVersionId1 | Long | - | Eine Entity der Beziehung | |
| codeSystemEntityVersionId2 | Long | - | Eine Entity der Beziehung | |
| id | Long | 1..1 | ||
| insertTimestamp | java.util.Date | - | Zeitpunkt, wann die Beziehung eingefügt worden ist. | |
| leftId | Long | - | Gibt an, wie die Leserichtung von ID 1 und ID 2 ist. Ist entweder gleich der codeSystemEntityVersionId1 oder codeSystemEntityVersionId2. Sollte die Leserichtung von ID2 -> ID1 gerichtet sein, müssen ebenfalls die Beziehungsnamen (forwardName und reverseName) umgedreht werden. | |
| status | Integer | - | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
| statusDate | java.util.Date | - | Änderungszeitpunkt des Status |
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 | ||
| code_system_entity | 2..2 | Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen. | ||
| currentVersionId | Long | 1..1 | Die aktuelle ID der code_system_entity_version | |
| id | Long | 1..1 | ||
| code_system_entity_version | 1..1 | Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung. | ||
| codeSystemEntityId | Long | 1..1 | ||
| effectiveDate | java.util.Date | 1..1 | Zeitpunkt der letzten Änderung | |
| insertTimestamp | java.util.Date | 1..1 | Zeitstempel, wann der Eintrag eingefügt worden ist | |
| isLeaf | Boolean | 1..1 | Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden. | |
| majorRevision | Integer | 1..1 | Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
| minorRevision | Integer | 1..1 | Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
| previousVersionId | Long | 1..1 | Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version. | |
| status | Integer | 1..1 | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
| statusDate | java.util.Date | 1..1 | Änderungszeitpunkt des Status | |
| versionId | Long | 1..1 | ||
| code_system_concept | 1..1 | Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version. | ||
| code | String | 100 | 1..1 | |
| codeSystemEntityVersionId | Long | 1..1 | ||
| isPreferred | Boolean | 1..1 | ||
| term | String | 65535 | 1..1 | |
| termAbbrevation | String | 50 | 1..1 | |
| code_system_entity_version_association | 0..1 | Setzt 2 Entity-Versionen in Beziehung miteinander. | ||
| associationKind | Integer | 1..1 | 1 = ontologisch,
2 = taxonomisch, 3 = cross mapping |
|
| associationTypeId | Long | 1..1 | Gibt den Typ der Beziehung an (z.B. 'gehört zu') | |
| codeSystemEntityVersionId1 | Long | - | Eine Entity der Beziehung | |
| codeSystemEntityVersionId2 | Long | 1..1 | Eine Entity der Beziehung | |
| id | Long | 1..1 | ||
| insertTimestamp | java.util.Date | 1..1 | Zeitpunkt, wann die Beziehung eingefügt worden ist. | |
| leftId | Long | 1..1 | Gibt an, wie die Leserichtung von ID 1 und ID 2 ist. Ist entweder gleich der codeSystemEntityVersionId1 oder codeSystemEntityVersionId2. Sollte die Leserichtung von ID2 -> ID1 gerichtet sein, müssen ebenfalls die Beziehungsnamen (forwardName und reverseName) umgedreht werden. | |
| status | Integer | 1..1 | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
| statusDate | java.util.Date | 1..1 | Änderungszeitpunkt des Status | |
| association_type | 1..1 | Stellt den Namen einer Beziehung dar. Speziealisierung von code_system_entity_version. Die codeSystemEntityVersionId entspricht der versionId aus code_system_entity_version. | ||
| codeSystemEntityVersionId | Long | 1..1 | Entspricht der versionId von code_system_entity_version | |
| forwardName | String | 50 | 1..1 | Name der Beziehung in normaler Leserichtung (ID 1->2) |
| reverseName | String | 50 | 1..1 | Name der Beziehung in umgekehrter Leserichtung (ID 2->1) |
Anmerkungen
Besonderheiten
Hinweise
Beispiele
SOAP-Nachrichten
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <con:ReturnConceptAssociationDetails> <parameter> <codeSystemEntityVersionAssociation> <id>1555</id> </codeSystemEntityVersionAssociation> </parameter> </con:ReturnConceptAssociationDetails> </soapenv:Body> </soapenv:Envelope>
