WS-Beschreibung - Terminologieserver Search ReturnConceptAssociationTypeDetails

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Request/Response)
 
(Eine dazwischenliegende Version von einem Benutzer wird nicht angezeigt)
Zeile 16: Zeile 16:
 
<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-Informationen</td>
+
   <td>Login information</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">ip</td>
+
−
  <td>String</td>
+
−
  <td></td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Die IP-Adresse des Benutzers (wird intern vergeben)</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">password</td>
+
−
  <td>String</td>
+
−
  <td></td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Passwort des Benutzers (als MD5-Wert)</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 39: Zeile 25:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Die Session-ID des Benutzers</td>
+
   <td>Session-ID from user (given by system)</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">username</td>
+
−
  <td>String</td>
+
−
  <td></td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Benutzername</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>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</td>
+
   <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">currentVersionId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Die aktuelle ID der code_system_entity_version</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">id</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td></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>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td>
+
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">codeSystemEntityId</td>
+
−
  <td>Long</td>
+
−
<td></td> <td id="cardinality_cell">-</td>
+
−
  <td></td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">effectiveDate</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Zeitpunkt der letzten Änderung</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">insertTimestamp</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Zeitstempel, wann der Eintrag eingefügt worden ist</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">isLeaf</td>
+
−
  <td>Boolean</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden.</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">majorRevision</td>
+
−
  <td>Integer</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">minorRevision</td>
+
−
  <td>Integer</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">previousVersionId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">status</td>
+
−
  <td>Integer</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">statusDate</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Änderungszeitpunkt des Status</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 130: Zeile 43:
 
   <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>
 
</table>
 
</table>
Zeile 144: Zeile 57:
 
<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>Entählt Informationen über die Antwort.</td>
+
   <td>Return information</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">count</td>
+
−
  <td>Integer</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Anzahl der Ergebnisse</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 159: Zeile 66:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Status- oder Fehlermeldung</td>
+
   <td>an additional message</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 175: Zeile 82:
 
<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>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</td>
+
   <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 183: Zeile 90:
 
   <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>Die aktuelle ID der code_system_entity_version</td>
+
   <td>Current ID of code_system_entity_version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 193: Zeile 100:
 
<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">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
−
   <td>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td>
+
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">codeSystemEntityId</td>
+
−
  <td>Long</td>
+
−
<td></td> <td id="cardinality_cell">-</td>
+
−
  <td></td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 207: Zeile 108:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Zeitpunkt der letzten Änderung</td>
+
   <td>Point in time of the last change.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 213: Zeile 114:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Zeitstempel, wann der Eintrag eingefügt worden ist</td>
+
   <td>Point in time, when entry was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 219: Zeile 120:
 
   <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>Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden.</td>
+
   <td>Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 225: Zeile 126:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
   <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 231: Zeile 132:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
   <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 237: Zeile 138:
 
   <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>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
+
   <td>Refers to the prior version, if there are more than one version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 243: Zeile 144:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
   <td>Status of the current entry. Can be taken from a domain.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 249: Zeile 150:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Änderungszeitpunkt des Status</td>
+
   <td>Point of time of the last change of the status.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 255: Zeile 156:
 
   <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">association_type</td>
 
   <td id="param_level3">association_type</td>
−
   <td></td>
+
   <td>association_type</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Stellt den Namen einer Beziehung dar. Speziealisierung von code_system_entity_version. Die codeSystemEntityVersionId entspricht der versionId aus code_system_entity_version.</td>
+
   <td>Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level4">codeSystemEntityVersionId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Entspricht der versionId von code_system_entity_version</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 274: Zeile 169:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Name der Beziehung in normaler Leserichtung (ID 1->2)</td>
+
   <td>Name of association in normal reading direction (ID 1->2)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 281: Zeile 176:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Name der Beziehung in umgekehrter Leserichtung (ID 2->1)</td>
+
   <td>Name of association in reversed reading direction (ID 2->1)</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>
Zeile 299: Zeile 194:
 
   <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>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="param_level4">name</td>
 
−
  <td>String</td>
 
−
  <td>65535</td>
 
−
  <td id="cardinality_cell">-</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>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="param_level5">codeSystemEntityVersionId</td>
 
−
  <td>Long</td>
 
−
<td></td>  <td id="cardinality_cell">-</td>
 
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
Zeile 376: Zeile 258:
 
   <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>
 
−
</tr>
 
−
<tr id="gray">
 
−
  <td id="param_level5">propertyId</td>
 
−
  <td>Long</td>
 
−
<td></td>  <td id="cardinality_cell">-</td>
 
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
Zeile 439: Zeile 315:
  
 
</source>
 
</source>
−
parameter>
 

Aktuelle Version vom 9. August 2013, 09:30 Uhr

Inhaltsverzeichnis

Functionality

Lists all properties and association type (with details) of the given concept. See request/response section for a list of details returned.

Prerequisites

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)
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.
versionId Long 1..1 Version-ID of Entity-Version

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
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.
currentVersionId Long 1..1 Current ID of code_system_entity_version.
id Long 1..1
code_system_entity_version code_system_entity_version 0..N code_system_entity_version is the superclass of every Concept and Association.
effectiveDate java.util.Date 1..1 Point in time of the last change.
insertTimestamp java.util.Date 1..1 Point in time, when entry was inserted.
isLeaf Boolean 1..1 Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only.
majorRevision Integer 1..1 Major revision of this entry (composition of major and minor version e.g. 1.3).
minorRevision Integer 1..1 Minor revision of this entry (composition of major and minor version e.g. 1.3)
previousVersionId Long 1..1 Refers to the prior version, if there are more than one version.
status Integer 1..1 Status of the current entry. Can be taken from a domain.
statusDate java.util.Date 1..1 Point of time of the last change of the status.
versionId Long 1..1 Version-ID of Entity-Version
association_type association_type 1..1 Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version
forwardName String 50 1..1 Name of association in normal reading direction (ID 1->2)
reverseName String 50 1..1 Name of association in reversed reading direction (ID 2->1)
property property 0..N
currentVersionId Long 1..1
id Long 1..1
property_version property_version 1..N
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
propertyKindId Long 1..1
status Integer 1..1
statusDate java.util.Date 1..1
versionId Long 1..1

Annotations

Noteworthiness

Hints

Typically the result set is small.

Examples

SOAP messages

<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 examples

Java

 
Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=WS-Beschreibung_-_Terminologieserver_Search_ReturnConceptAssociationTypeDetails“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge