Terminologieserver - ConceptAssociation - ListConceptAssociations

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(4 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt)
Zeile 1: Zeile 1:
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br>
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br>
  
 +
=Beschreibung=
 +
List all associations from a given concept. You can filter the results by association kind types.<br>
 
=Request/Response=
 
=Request/Response=
 
==Request==
 
==Request==
Zeile 12: Zeile 14:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
 +
<tr>
 +
  <td id="cardinality_cell">1</td>
 +
  <td id="param_level1">loginToken</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Login-Token that ensures the user is logged in.</td>
 +
</tr>
 
<tr>
 
<tr>
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
Zeile 17: Zeile 27:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td></td>
+
   <td>Looks for concpets which are associated with the given concept.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 24: Zeile 34:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td></td>
+
   <td>Looks for all concpets which have relations with the given concept.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 31: Zeile 41:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td></td>
+
   <td>Get the next associations from every association. Useful if you want to show a tree view and want to know if the following concepts have children.</td>
−
</tr>
+
−
<tr id="row_object">
+
−
  <td id="cardinality_cell">1</td>
+
−
  <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="cardinality_cell">2</td>
+
−
  <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>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 91: Zeile 86:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Point in time of the last change.</td>
+
   <td>Last change date of the entity version.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 107: Zeile 102:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">ReturnType</td>
+
   <td id="param_level1">returnInfos</td>
 
   <td>ReturnType</td>
 
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
Zeile 213: Zeile 208:
 
   <td>association_type</td>
 
   <td>association_type</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>
+
   <td>Name of an association. Specialization of code_system_entity_version. The codeSystemEntityVersionId is the same as the versionId of code_system_entity_version</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 220: Zeile 215:
 
   <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>Equates the versionId of code_system_entity_version</td>
+
   <td>Match to the versionId of code_system_entity_version</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 257: Zeile 252:
 
   <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>Point in time of the last change.</td>
+
   <td>Last change date of the entity version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 264: Zeile 259:
 
   <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>Point in time, when entry was inserted.</td>
+
   <td>Point in time when entry was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 271: Zeile 266:
 
   <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>Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only. </td>
+
   <td>Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 296: Zeile 291:
 
<tr>
 
<tr>
 
   <td id="cardinality_cell">3</td>
 
   <td id="cardinality_cell">3</td>
−
   <td id="param_level3">status</td>
+
   <td id="param_level3">statusDeactivated</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivatedDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Date when statusDeactivated changed</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusVisibility</td>
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
Zeile 303: Zeile 312:
 
<tr>
 
<tr>
 
   <td id="cardinality_cell">3</td>
 
   <td id="cardinality_cell">3</td>
−
   <td id="param_level3">statusDate</td>
+
   <td id="param_level3">statusVisibilityDate</td>
 
   <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>Point of time of the last change of the status.</td>
 
   <td>Point of time of the last change of the status.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflow</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>A workflow status, can be unique for each codesystem.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflowDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Date when statusWorkflow changed</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 313: Zeile 336:
 
   <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>Version-ID of Entity-Version</td>
+
   <td>The ID of this entry.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 361: Zeile 384:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
=Beispiele=
 +
==SOAP==
 +
===Example search for 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>
 +
      </con:ListConceptAssociations>
 +
  </soapenv:Body>
 +
</soapenv:Envelope>
 +
</source>
 +
===Search for all associations of a given term===
 +
<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>
 +
                <versionId>17</versionId>
 +
              </codeSystemEntityVersions>
 +
            </codeSystemEntity>
 +
        </parameter>
 +
      </con:ListConceptAssociations>
 +
  </soapenv:Body>
 +
</soapenv:Envelope>
 +
</source>
 
<br><br>
 
<br><br>
  
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]

Aktuelle Version vom 30. September 2014, 12:31 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

List all associations from a given concept. You can filter the results by association kind types.

Request/Response

Request

Level Parameter Typ Länge Kardinalität Beschreibung
1 loginToken String 0..1 Login-Token that ensures the user is logged in.
1 reverse Boolean 0..1 Looks for concpets which are associated with the given concept.
1 directionBoth Boolean 0..1 Looks for all concpets which have relations with the given concept.
1 lookForward Boolean 0..1 Get the next associations from every association. Useful if you want to show a tree view and want to know if the following concepts have children.
1 codeSystemEntityVersionAssociation code_system_entity_version_association 0..1 Associates two entity versions with each other.
2 associationKind Integer 1..1 1 = ontological,

2 = taxonomic, 3 = cross mapping,

4 = link
1 codeSystemEntity code_system_entity 1..1 Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
2 codeSystemEntityVersion code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
3 codeSystemEntityId Long 1..1 Foreign key to code system entities ID
3 effectiveDate java.util.Date 0..1 Last change date of the entity version.


Response

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

2 = taxonomic, 3 = cross mapping,

4 = link
2 associationTypeId Long 1..1 Specifies the Type of the association (e.g. 'belongs to')
2 codeSystemEntityVersionId2 Long 1..1 Points to the second entity of the association
2 id Long 1..1
2 insertTimestamp java.util.Date 1..1 Point of time, when the association was inserted.
2 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.
2 status Integer 1..1 Status of the current entry. Can be taken from a domain.
2 statusDate java.util.Date 1..1 Point of time of the last change of the status.
2 associationType association_type 1..1 Name of an association. Specialization of code_system_entity_version. The codeSystemEntityVersionId is the same as the versionId of code_system_entity_version
3 codeSystemEntityVersionId Long 1..1 Match to the versionId of code_system_entity_version
3 forwardName String 50 1..1 Name of association in normal reading direction (ID 1->2)
3 reverseName String 50 1..1 Name of association in reversed reading direction (ID 2->1)
2 codeSystemEntityVersion code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
3 codeSystemEntityId Long 1..1 Foreign key to code system entities ID
3 effectiveDate java.util.Date 1..1 Last change date of the entity version.
3 insertTimestamp java.util.Date 1..1 Point in time when entry was inserted.
3 isLeaf Boolean 1..1 Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only.
3 majorRevision Integer 1..1 Major revision of this entry (composition of major and minor version e.g. 1.3).
3 minorRevision Integer 1..1 Minor revision of this entry (composition of major and minor version e.g. 1.3)
3 previousVersionId Long 1..1 Refers to the prior version, if there are more than one version.
3 statusDeactivated Integer 1..1 Defines the state. Default value is 0 (=visible). Look for available values in the according domain.
3 statusDeactivatedDate java.util.Date 1..1 Date when statusDeactivated changed
3 statusVisibility Integer 1..1 Status of the current entry. Can be taken from a domain.
3 statusVisibilityDate java.util.Date 1..1 Point of time of the last change of the status.
3 statusWorkflow Integer 1..1 A workflow status, can be unique for each codesystem.
3 statusWorkflowDate java.util.Date 1..1 Date when statusWorkflow changed
3 versionId Long 1..1 The ID of this entry.
3 codeSystemConcept code_system_concept 1..1 Displays a concept or term. Specialization of code_system_entity_version.
4 code String 100 1..1 Code of a concept or term.
4 codeSystemEntityVersionId Long 1..1
4 isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
4 term String 65535 1..1 The term itself
4 termAbbrevation String 50 1..1 The abbrevation of the term.

Beispiele

SOAP

Example search for 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>

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>
                <versionId>17</versionId>
              </codeSystemEntityVersions>
            </codeSystemEntity>
         </parameter>
      </con:ListConceptAssociations>
   </soapenv:Body>
</soapenv:Envelope>



zurück zur Webservice-Übersicht

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