WS-Beschreibung - Terminologieserver Concept Association ListConceptAssociations

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(Die Seite wurde neu angelegt: „<table border="0"> <tr> <td width="100px" style="font-weight: bold;">System</td> <td>Terminologieserver</td> </tr> <tr> <td style="font-weight: …“)
 
(→Request/Response)
 
(11 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
<table border="0">
+
=Functionality=
−
  <tr>
+
Lists all associations of the given concept.
−
    <td width="100px" style="font-weight: bold;">System</td>
+
−
    <td>Terminologieserver</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Webservice</td>
+
−
    <td>Concept Association</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">WSDL</td>
+
−
    <td>http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/ConceptAssociations?wsdl</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Methode</td>
+
−
    <td>ListConceptAssociations</td>
+
−
  </tr>
+
−
</table><br>
+
−
=Funktionalität=
+
−
Auflistung aller Konzepte und deren Assiziationen mit dem angegebenen Konzept.
+
  
−
=Vorbedingungen=
+
=Prerequisites=
  
 
=Request/Response=
 
=Request/Response=
 +
==Request==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 +
    <th>Beschreibung</th>
 +
  </tr>
 +
<tr>
 +
  <td id="param_level1">reverse</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level1">directionBoth</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level1">lookForward</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">LoginType</td>
 +
  <td>LoginType</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Login information</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">sessionID</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Session-ID from user (given by system)</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system_entity_version_association</td>
 +
  <td>code_system_entity_version_association</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Associates two entity versions with each other.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">associationKind</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>1 = ontological,
 +
2 = taxonomic,
 +
3 = cross mapping,
 +
4 = link</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system_entity</td>
 +
  <td>code_system_entity</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_entity_version</td>
 +
  <td>code_system_entity_version</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Foreign key to code system entities ID</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">effectiveDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Point in time of the last change.</td>
 +
</tr>
 +
</table>
 +
==Response==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 +
    <th>Beschreibung</th>
 +
  </tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">ReturnType</td>
 +
  <td>ReturnType</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Return information</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">count</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>number of results</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">message</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>an additional message</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">overallErrorCategory</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>INFO, WARN, ERROR</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">status</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>OK, FAILURE</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system_entity_version_association</td>
 +
  <td>code_system_entity_version_association</td>
 +
<td></td>  <td id="cardinality_cell">0..N</td>
 +
  <td>Associates two entity versions with each other.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">associationKind</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>1 = ontological,
 +
2 = taxonomic,
 +
3 = cross mapping,
 +
4 = link</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">associationTypeId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Specifies the Type of the association (e.g. 'belongs to')</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">codeSystemEntityVersionId2</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Points to the second entity of the association</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time, when the association was inserted.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">leftId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Specifies the reading direction of the association, if ID 1 or ID 2 is on the left side. E.g.  ID 1 = 12, Id 2 = 14:  12 belongs to 14, or  14 belongs to 12.
 +
If the direction should be ID2 -> ID1, forwardName and reverseName have to be reverted as well. </td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Status of the current entry. Can be taken from a domain. </td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time of the last change of the status.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">association_type</td>
 +
  <td>association_type</td>
 +
<td></td>  <td id="cardinality_cell">1..1</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>
 +
  <td id="param_level3">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Equates the versionId of code_system_entity_version</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">forwardName</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Name of association in normal reading direction (ID 1->2)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">reverseName</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Name of association in reversed reading direction (ID 2->1)</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_entity_version</td>
 +
  <td>code_system_entity_version</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Foreign key to code system entities ID</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">effectiveDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point in time of the last change.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point in time, when entry was inserted.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">isLeaf</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</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>
 +
  <td id="param_level3">majorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">minorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Refers to the prior version, if there are more than one version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Status of the current entry. Can be taken from a domain.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time of the last change of the status.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Version-ID of Entity-Version</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level3">code_system_concept</td>
 +
  <td>code_system_concept</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Displays a concept or term. Specialization of code_system_entity_version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">code</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Code of a concept or term.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">isPreferred</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Specifies, if a term or concept is preferred or not.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">term</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>The term itself</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">termAbbrevation</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>The abbrevation of the term.</td>
 +
</tr>
 +
</table>
  
−
=Anmerkungen=
+
=Annotations=
−
==Besonderheiten==
+
==Noteworthiness==
−
==Hinweise==
+
==Hints==
−
Die Ergebnismenge ist meistens eher klein bis mittelmäßig.
+
A typical result set is rather small.
  
−
=Beispiele=
+
=Examples=
−
==SOAP-Nachrichten==
+
==SOAP messages==
 +
===Search for all associations of a given term===
 
<source lang="xml">
 
<source lang="xml">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/">
Zeile 42: Zeile 335:
 
               </codeSystemEntityVersions>
 
               </codeSystemEntityVersions>
 
             </codeSystemEntity>
 
             </codeSystemEntity>
 +
        </parameter>
 +
      </con:ListConceptAssociations>
 +
  </soapenv:Body>
 +
</soapenv:Envelope>
 +
</source>
 +
===Example search fo Cross-Mappings===
 +
<source lang="xml">
 +
<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>
 
         </parameter>
 
       </con:ListConceptAssociations>
 
       </con:ListConceptAssociations>
Zeile 48: Zeile 363:
 
</source>
 
</source>
  
−
==Code-Beispiele==
+
==Code example==
 
===Java===
 
===Java===
 
<source lang="java">
 
<source lang="java">
  
 
</source>
 
</source>

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

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 LoginType 0..1 Login information
sessionID String 1..1 Session-ID from user (given by system)
code_system_entity_version_association code_system_entity_version_association 0..1 Associates two entity versions with each other.
associationKind Integer 1..1 1 = ontological,

2 = taxonomic, 3 = cross mapping,

4 = link
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.
codeSystemEntityId Long 1..1 Foreign key to code system entities ID
effectiveDate java.util.Date 0..1 Point in time of the last change.

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Return information
count Integer 1..1 number of results
message String 1..1 an additional message
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE
code_system_entity_version_association code_system_entity_version_association 0..N Associates two entity versions with each other.
associationKind Integer 1..1 1 = ontological,

2 = taxonomic, 3 = cross mapping,

4 = link
associationTypeId Long 1..1 Specifies the Type of the association (e.g. 'belongs to')
codeSystemEntityVersionId2 Long 1..1 Points to the second entity of the association
id Long 1..1
insertTimestamp java.util.Date 1..1 Point of time, when the association was inserted.
leftId Long 1..1 Specifies the reading direction of the association, if ID 1 or ID 2 is on the left side. E.g. ID 1 = 12, Id 2 = 14: 12 belongs to 14, or 14 belongs to 12. If the direction should be ID2 -> ID1, forwardName and reverseName have to be reverted as well.
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.
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
codeSystemEntityVersionId Long 1..1 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)
code_system_entity_version code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
codeSystemEntityId Long 1..1 Foreign key to code system entities ID
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
code_system_concept code_system_concept 1..1 Displays a concept or term. Specialization of code_system_entity_version.
code String 100 1..1 Code of a concept or term.
codeSystemEntityVersionId Long 1..1
isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
term String 65535 1..1 The term itself
termAbbrevation String 50 1..1 The abbrevation of the term.

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>

Code example

Java

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