WS-Beschreibung - Terminologieserver Search ReturnConceptAssociationTypeDetails
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(→Request/Response) |
Becker (Diskussion | Beiträge) |
||
Zeile 1: | Zeile 1: | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
=Funktionalität= | =Funktionalität= | ||
Listet die Entity-Eigenschaften so wie den Assoziationstyp und die Properties der angegebenen Entity-Version auf. Für Details siehe Request/Response-Abschnitt. | Listet die Entity-Eigenschaften so wie den Assoziationstyp und die Properties der angegebenen Entity-Version auf. Für Details siehe Request/Response-Abschnitt. | ||
Zeile 458: | Zeile 440: | ||
</source> | </source> | ||
+ | parameter> |
Version vom 8. Juli 2013, 07:33 Uhr
Inhaltsverzeichnis |
Funktionalität
Listet die Entity-Eigenschaften so wie den Assoziationstyp und die Properties der angegebenen Entity-Version auf. Für Details siehe Request/Response-Abschnitt.
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 | 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 | - | Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
minorRevision | Integer | - | 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 |
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 | 1..1 | 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 | 0..N | Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung. | ||
codeSystemEntityId | Long | - | ||
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 | ||
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 | - | 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) |
property | 0..N | |||
currentVersionId | Long | 1..1 | ||
id | Long | 1..1 | ||
name | String | 65535 | - | |
property_version | 1..N | |||
codeSystemEntityVersionId | Long | - | ||
content | byte[] | 1..1 | ||
contentMimetype | String | 50 | 1..1 | |
contentName | String | 255 | 1..1 | |
contentSize | Integer | 1..1 | ||
description | String | 65535 | 1..1 | |
insertTimestamp | java.util.Date | 1..1 | ||
languageId | Long | 1..1 | ||
name | String | 65535 | 1..1 | |
previousVersionId | Long | 1..1 | ||
propertyId | Long | - | ||
propertyKindId | Long | 1..1 | ||
status | Integer | 1..1 | ||
statusDate | java.util.Date | 1..1 | ||
versionId | Long | 1..1 |
Anmerkungen
Besonderheiten
Hinweise
Die Ergebnismenge ist meistens eher klein.
Beispiele
SOAP-Nachrichten
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ReturnConceptAssociationTypeDetails> <parameter> <codeSystemEntity> <codeSystemEntityVersion> <versionId>17</versionId> </codeSystemEntityVersion> </codeSystemEntity> </parameter> </sear:ReturnConceptAssociationTypeDetails> </soapenv:Body> </soapenv:Envelope>
Code-Beispiele
Java
parameter>