WS-Beschreibung - Terminologieserver Concept Association ListConceptAssociations
Aus Termserver-CTS2
Version vom 8. August 2013, 10:52 Uhr von Becker (Diskussion | Beiträge)
Inhaltsverzeichnis |
Functionality
Lists all associations of the given concept.
Prerequisites
Request/Response
Request
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| reverse | Boolean | 0..1 | ||
| directionBoth | Boolean | 0..1 | ||
| lookForward | Boolean | 0..1 | ||
| LoginType | 0..1 | Login-Informationen | ||
| sessionID | String | 1..1 | Die Session-ID des Benutzers | |
| code_system_entity_version_association | 0..1 | Setzt 2 Entity-Versionen miteinander in Beziehung. | ||
| associationKind | Integer | 1..1 | 1 = ontologisch,
2 = taxonomisch, 3 = cross mapping, 4 = link |
|
| code_system_entity | 1..1 | Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen. | ||
| 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 | 0..1 | Zeitpunkt der letzten Änderung |
Response
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| ReturnType | 1..1 | Entählt Informationen über die Antwort. | ||
| count | Integer | 1..1 | Anzahl der Ergebnisse | |
| message | String | 1..1 | Status- oder Fehlermeldung | |
| overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| status | 1..1 | OK, FAILURE | ||
| code_system_entity_version_association | 0..N | Setzt 2 Entity-Versionen miteinander in Beziehung. | ||
| associationKind | Integer | 1..1 | 1 = ontologisch,
2 = taxonomisch, 3 = cross mapping, 4 = link |
|
| associationTypeId | Long | 1..1 | Gibt den Typ der Beziehung an (z.B. 'gehört zu') | |
| 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) |
| 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 | Der Code zu einem Begriff bzw. Konzepts |
| codeSystemEntityVersionId | Long | 1..1 | ||
| isPreferred | Boolean | 1..1 | Gibt an, ob es sich um einen Vorzugsbegriff handelt | |
| term | String | 65535 | 1..1 | Der Begriff selbst |
| termAbbrevation | String | 50 | 1..1 | Abkürzung des Begriffs |
Annotations
Noteworthiness
Hints
A typical result set is rather small.
Examples
SOAP messages
Search for all associations of a given term
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <con:ListConceptAssociations> <parameter> <codeSystemEntity> <codeSystemEntityVersions> <status/><versionId>17</versionId> </codeSystemEntityVersions> </codeSystemEntity> </parameter> </con:ListConceptAssociations> </soapenv:Body> </soapenv:Envelope>
Example search fo Cross-Mappings
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <con:ListConceptAssociations> <parameter> <codeSystemEntity> <codeSystemEntityVersions> <status/> <versionId>29769</versionId> </codeSystemEntityVersions> </codeSystemEntity> <codeSystemEntityVersionAssociation> <associationKind>3</associationKind> </codeSystemEntityVersionAssociation> <directionBoth>true</directionBoth> </parameter> </con:ListConceptAssociations> </soapenv:Body> </soapenv:Envelope>
