WS-Beschreibung - Terminologieserver Concept Association ListConceptAssociations
Aus Termserver-CTS2
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>
