Terminologieserver - ConceptAssociation - TraverseConceptToRoot
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
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= | ||
+ | Return all concepts at a higher level up to the root, starting by the given concept.<br> | ||
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
Zeile 14: | Zeile 16: | ||
<tr> | <tr> | ||
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
− | <td id="param_level1"> | + | <td id="param_level1">loginToken</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
<td>String</td> | <td>String</td> | ||
<td></td> | <td></td> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">0..1</td> |
− | <td> | + | <td>Login-Token that ensures the user is logged in.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 50: | Zeile 38: | ||
<tr> | <tr> | ||
<td id="cardinality_cell">3</td> | <td id="cardinality_cell">3</td> | ||
− | <td id="param_level3"> | + | <td id="param_level3">versionId</td> |
<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>The ID of this entry.</td> |
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">1</td> | ||
+ | <td id="param_level1">readEntityDetails</td> | ||
+ | <td>Boolean</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">1</td> | ||
+ | <td id="param_level1">directionToRoot</td> | ||
+ | <td>Boolean</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td></td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
Zeile 69: | Zeile 71: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
− | <td id="param_level1"> | + | <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 105: | Zeile 107: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
− | <td id="param_level1"> | + | <td id="param_level1">codeSystemEntityVersionRoot</td> |
+ | <td>code_system_entity_version</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td>code_system_entity_version is the superclass of every Concept and Association. </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">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="cardinality_cell">2</td> | ||
+ | <td id="param_level2">effectiveDate</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Last change date of the entity version.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">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="cardinality_cell">2</td> | ||
+ | <td id="param_level2">isLeaf</td> | ||
+ | <td>Boolean</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</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> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">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="cardinality_cell">2</td> | ||
+ | <td id="param_level2">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="cardinality_cell">2</td> | ||
+ | <td id="param_level2">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="cardinality_cell">2</td> | ||
+ | <td id="param_level2">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">2</td> | ||
+ | <td id="param_level2">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">2</td> | ||
+ | <td id="param_level2">statusVisibility</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="cardinality_cell">2</td> | ||
+ | <td id="param_level2">statusVisibilityDate</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="cardinality_cell">2</td> | ||
+ | <td id="param_level2">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">2</td> | ||
+ | <td id="param_level2">statusWorkflowDate</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Date when statusWorkflow changed</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">versionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>The ID of this entry.</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">codeSystemEntityVersionAssociationsForCodeSystemEntityVersionId2</td> | ||
<td>code_system_entity_version_association</td> | <td>code_system_entity_version_association</td> | ||
− | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">1..1</td> |
<td>Associates two entity versions with each other.</td> | <td>Associates two entity versions with each other.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">3</td> |
− | <td id=" | + | <td id="param_level3">associationKind</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 121: | Zeile 228: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">3</td> |
− | <td id=" | + | <td id="param_level3">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="cardinality_cell">3</td> | ||
+ | <td id="param_level3">codeSystemEntityVersionId1</td> | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
Zeile 128: | Zeile 242: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">3</td> |
− | <td id=" | + | <td id="param_level3">codeSystemEntityVersionId2</td> |
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
Zeile 135: | Zeile 249: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">3</td> |
− | <td id=" | + | <td id="param_level3">id</td> |
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
Zeile 142: | Zeile 256: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">3</td> |
− | <td id=" | + | <td id="param_level3">insertTimestamp</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> | ||
Zeile 149: | Zeile 263: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id="cardinality_cell">2</td> | + | <td id="cardinality_cell">3</td> |
− | <td id=" | + | <td id="param_level3">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="cardinality_cell">3</td> | ||
+ | <td id="param_level3">status</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 156: | Zeile 278: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">3</td> |
− | <td id=" | + | <td id="param_level3">statusDate</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> | ||
Zeile 163: | Zeile 285: | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">3</td> |
− | <td id=" | + | <td id="param_level3">ALL UPPER CONCEPTS</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="cardinality_cell">4</td> | ||
+ | <td id="param_level4">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="cardinality_cell">4</td> | ||
+ | <td id="param_level4">effectiveDate</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Last change date of the entity version.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">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="cardinality_cell">4</td> | ||
+ | <td id="param_level4">isLeaf</td> | ||
+ | <td>Boolean</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</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> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">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="cardinality_cell">4</td> | ||
+ | <td id="param_level4">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="cardinality_cell">4</td> | ||
+ | <td id="param_level4">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="cardinality_cell">4</td> | ||
+ | <td id="param_level4">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">4</td> | ||
+ | <td id="param_level4">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">4</td> | ||
+ | <td id="param_level4">statusVisibility</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="cardinality_cell">4</td> | ||
+ | <td id="param_level4">statusVisibilityDate</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="cardinality_cell">4</td> | ||
+ | <td id="param_level4">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">4</td> | ||
+ | <td id="param_level4">statusWorkflowDate</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Date when statusWorkflow changed</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">versionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>The ID of this entry.</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">associationType</td> | ||
<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> | ||
Zeile 170: | Zeile 397: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">4</td> |
− | <td id=" | + | <td id="param_level4">codeSystemEntityVersionId</td> |
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
Zeile 177: | Zeile 404: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">4</td> |
− | <td id=" | + | <td id="param_level4">forwardName</td> |
<td>String</td> | <td>String</td> | ||
<td>50</td> | <td>50</td> | ||
Zeile 185: | Zeile 412: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">4</td> |
− | <td id=" | + | <td id="param_level4">reverseName</td> |
<td>String</td> | <td>String</td> | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
<td>Name of association in reversed reading direction (ID 2->1)</td> | <td>Name of association in reversed reading direction (ID 2->1)</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">codeSystemConcept</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="cardinality_cell">3</td> | ||
+ | <td id="param_level3">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="cardinality_cell">3</td> | ||
+ | <td id="param_level3">codeSystemEntityVersionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">description</td> | ||
+ | <td>String</td> | ||
+ | <td></td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Description of a term or concept</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">hints</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">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="cardinality_cell">3</td> | ||
+ | <td id="param_level3">meaning</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">term</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>The term itself</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">termAbbrevation</td> | ||
+ | <td>String</td> | ||
+ | <td>50</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>The abbrevation of the term.</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">codeSystemEntity</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> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">currentVersionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Current ID of code_system_entity_version.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">id</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
+ | =Beispiele= | ||
+ | ==SOAP== | ||
+ | ===Traverse concept to root=== | ||
+ | <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:TraverseConceptToRoot> | ||
+ | <parameter> | ||
+ | <codeSystemEntity> | ||
+ | <codeSystemEntityVersions> | ||
+ | <versionId>6633</versionId> | ||
+ | </codeSystemEntityVersions> | ||
+ | </codeSystemEntity> | ||
+ | </parameter> | ||
+ | </con:TraverseConceptToRoot> | ||
+ | </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]] |
Version vom 22. Juli 2014, 12:54 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Return all concepts at a higher level up to the root, starting by the given concept.
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 | 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 | versionId | Long | 1..1 | The ID of this entry. | |
1 | readEntityDetails | Boolean | 0..1 | ||
1 | directionToRoot | Boolean | 0..1 |
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 | codeSystemEntityVersionRoot | code_system_entity_version | 0..1 | code_system_entity_version is the superclass of every Concept and Association. | |
2 | codeSystemEntityId | Long | 1..1 | Foreign key to code system entities ID | |
2 | effectiveDate | java.util.Date | 1..1 | Last change date of the entity version. | |
2 | insertTimestamp | java.util.Date | 1..1 | Point in time when entry was inserted. | |
2 | isLeaf | Boolean | 1..1 | Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. | |
2 | majorRevision | Integer | 1..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
2 | minorRevision | Integer | 1..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
2 | previousVersionId | Long | 1..1 | Refers to the prior version, if there are more than one version. | |
2 | statusDeactivated | Integer | 1..1 | Defines the state. Default value is 0 (=visible). Look for available values in the according domain. | |
2 | statusDeactivatedDate | java.util.Date | 1..1 | Date when statusDeactivated changed | |
2 | statusVisibility | Integer | 1..1 | Status of the current entry. Can be taken from a domain. | |
2 | statusVisibilityDate | java.util.Date | 1..1 | Point of time of the last change of the status. | |
2 | statusWorkflow | Integer | 1..1 | A workflow status, can be unique for each codesystem. | |
2 | statusWorkflowDate | java.util.Date | 1..1 | Date when statusWorkflow changed | |
2 | versionId | Long | 1..1 | The ID of this entry. | |
2 | codeSystemEntityVersionAssociationsForCodeSystemEntityVersionId2 | code_system_entity_version_association | 1..1 | Associates two entity versions with each other. | |
3 | associationKind | Integer | 1..1 | 1 = ontological,
2 = taxonomic, 3 = cross mapping, 4 = link |
|
3 | associationTypeId | Long | 1..1 | Specifies the Type of the association (e.g. 'belongs to') | |
3 | codeSystemEntityVersionId1 | Long | 1..1 | Points to the first entity of the association | |
3 | codeSystemEntityVersionId2 | Long | 1..1 | Points to the second entity of the association | |
3 | id | Long | 1..1 | ||
3 | insertTimestamp | java.util.Date | 1..1 | Point of time, when the association was inserted. | |
3 | 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. | |
3 | status | Integer | 1..1 | Status of the current entry. Can be taken from a domain. | |
3 | statusDate | java.util.Date | 1..1 | Point of time of the last change of the status. | |
3 | ALL UPPER CONCEPTS | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
4 | codeSystemEntityId | Long | 1..1 | Foreign key to code system entities ID | |
4 | effectiveDate | java.util.Date | 1..1 | Last change date of the entity version. | |
4 | insertTimestamp | java.util.Date | 1..1 | Point in time when entry was inserted. | |
4 | isLeaf | Boolean | 1..1 | Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. | |
4 | majorRevision | Integer | 1..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
4 | minorRevision | Integer | 1..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
4 | previousVersionId | Long | 1..1 | Refers to the prior version, if there are more than one version. | |
4 | statusDeactivated | Integer | 1..1 | Defines the state. Default value is 0 (=visible). Look for available values in the according domain. | |
4 | statusDeactivatedDate | java.util.Date | 1..1 | Date when statusDeactivated changed | |
4 | statusVisibility | Integer | 1..1 | Status of the current entry. Can be taken from a domain. | |
4 | statusVisibilityDate | java.util.Date | 1..1 | Point of time of the last change of the status. | |
4 | statusWorkflow | Integer | 1..1 | A workflow status, can be unique for each codesystem. | |
4 | statusWorkflowDate | java.util.Date | 1..1 | Date when statusWorkflow changed | |
4 | versionId | Long | 1..1 | The ID of this entry. | |
3 | associationType | 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 | |
4 | codeSystemEntityVersionId | Long | 1..1 | Equates the versionId of code_system_entity_version | |
4 | forwardName | String | 50 | 1..1 | Name of association in normal reading direction (ID 1->2) |
4 | reverseName | String | 50 | 1..1 | Name of association in reversed reading direction (ID 2->1) |
2 | codeSystemConcept | code_system_concept | 1..1 | Displays a concept or term. Specialization of code_system_entity_version. | |
3 | code | String | 100 | 1..1 | Code of a concept or term. |
3 | codeSystemEntityVersionId | Long | 1..1 | ||
3 | description | String | 1..1 | Description of a term or concept | |
3 | hints | String | 65535 | 1..1 | |
3 | isPreferred | Boolean | 1..1 | Specifies, if a term or concept is preferred or not. | |
3 | meaning | String | 65535 | 1..1 | |
3 | term | String | 65535 | 1..1 | The term itself |
3 | termAbbrevation | String | 50 | 1..1 | The abbrevation of the term. |
2 | codeSystemEntity | code_system_entity | 1..1 | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
3 | currentVersionId | Long | 1..1 | Current ID of code_system_entity_version. | |
3 | id | Long | 1..1 |
Beispiele
SOAP
Traverse concept to root
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <con:TraverseConceptToRoot> <parameter> <codeSystemEntity> <codeSystemEntityVersions> <versionId>6633</versionId> </codeSystemEntityVersions> </codeSystemEntity> </parameter> </con:TraverseConceptToRoot> </soapenv:Body> </soapenv:Envelope>