WS-Beschreibung - Terminologieserver Concept Association ReturnConceptAssociationDetails
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(→Request/Response) |
Becker (Diskussion | Beiträge) (→Request/Response) |
||
| (3 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| − | + | =Functionality= | |
| − | + | Returns all details about a association and the two entities that are linked by it. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | = | + | =Prerequisites= |
=Request/Response= | =Request/Response= | ||
| Zeile 34: | 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 | + | <td>Login information</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 57: | Zeile 25: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Session-ID from user (given by system)</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system_entity_version_association</td> | <td id="param_level1">code_system_entity_version_association</td> | ||
| − | <td></td> | + | <td>code_system_entity_version_association</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Associates two entity versions with each other.</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 103: | Zeile 38: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td></td> | <td></td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
</table> | </table> | ||
| Zeile 140: | Zeile 51: | ||
<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> | + | <td>Return information</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 155: | Zeile 60: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>an additional message</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 171: | Zeile 76: | ||
<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">2..2</td> | <td></td> <td id="cardinality_cell">2..2</td> | ||
| − | <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 179: | Zeile 84: | ||
<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>Current ID of code_system_entity_version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 189: | Zeile 94: | ||
<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> | + | <td>code_system_entity_version is the superclass of every Concept and Association. </td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 197: | Zeile 102: | ||
<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>Foreign key to code system entities ID</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 203: | 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> | + | <td>Point in time of the last change.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 209: | 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> | + | <td>Point in time, when entry was inserted.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 215: | 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> | + | <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 221: | 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> | + | <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 227: | 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> | + | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 233: | 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> | + | <td>Refers to the prior version, if there are more than one version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 239: | 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> | + | <td>Status of the current entry. Can be taken from a domain.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 245: | 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> | + | <td>Point of time of the last change of the status.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 251: | 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">code_system_concept</td> | <td id="param_level3">code_system_concept</td> | ||
| − | <td></td> | + | <td>code_system_concept</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Displays a concept or term. Specialization of code_system_entity_version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 264: | Zeile 169: | ||
<td>100</td> | <td>100</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Code of a concept or term.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 276: | Zeile 181: | ||
<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></td> | + | <td>Specifies, if a term or concept is preferred or not.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 283: | Zeile 188: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>The term itself</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 290: | Zeile 195: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>The abbrevation of the term.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system_entity_version_association</td> | <td id="param_level1">code_system_entity_version_association</td> | ||
| − | <td></td> | + | <td>code_system_entity_version_association</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
| − | <td> | + | <td>Associates two entity versions with each other.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 302: | Zeile 207: | ||
<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>1 = | + | <td>1 = ontological, |
| − | 2 = | + | 2 = taxonomic, |
| − | 3 = cross mapping</td> | + | 3 = cross mapping, |
| + | 4 = link</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 310: | Zeile 216: | ||
<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>Specifies the Type of the association (e.g. 'belongs to')</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 322: | Zeile 222: | ||
<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>Points to the second entity of the association</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 334: | Zeile 234: | ||
<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> | + | <td>Point of time, when the association was inserted.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 340: | Zeile 240: | ||
<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>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> | ||
<tr> | <tr> | ||
| Zeile 346: | Zeile 247: | ||
<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> | + | <td>Status of the current entry. Can be taken from a domain. </td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 352: | Zeile 253: | ||
<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> | + | <td>Point of time of the last change of the status.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">association_type</td> | <td id="param_level2">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> | + | <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> | ||
<tr> | <tr> | ||
| Zeile 364: | Zeile 265: | ||
<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>Equates the versionId of code_system_entity_version</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 371: | Zeile 272: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td>Name | + | <td>Name of association in normal reading direction (ID 1->2)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 378: | Zeile 279: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td>Name | + | <td>Name of association in reversed reading direction (ID 2->1)</td> |
</tr> | </tr> | ||
</table> | </table> | ||
| − | = | + | =Annotations= |
| − | == | + | ==Noteworthiness== |
| − | == | + | ==Hints== |
| − | = | + | =Examples= |
| − | ==SOAP | + | ==SOAP messages== |
<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 403: | Zeile 304: | ||
</source> | </source> | ||
| − | ==Code | + | ==Code examples== |
===Java=== | ===Java=== | ||
<source lang="java"> | <source lang="java"> | ||
</source> | </source> | ||
Aktuelle Version vom 9. August 2013, 09:23 Uhr
Inhaltsverzeichnis |
Functionality
Returns all details about a association and the two entities that are linked by it.
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_version_association | code_system_entity_version_association | 1..1 | Associates two entity versions with each other. | |
| id | Long | 1..1 |
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 | 2..2 | 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 | 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. |
| 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 |
|
| 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) |
Annotations
Noteworthiness
Hints
Examples
SOAP messages
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <con:ReturnConceptAssociationDetails> <parameter> <codeSystemEntityVersionAssociation> <id>1555</id> </codeSystemEntityVersionAssociation> </parameter> </con:ReturnConceptAssociationDetails> </soapenv:Body> </soapenv:Envelope>
