WS-Beschreibung - Terminologieserver Concept Association CreateConceptAssociation
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Creates a new association that links two entity versions with each other.
Prerequisites
Requires Login.
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. | |
| associationKind | Integer | 1..1 | 1 = ontological,
2 = taxonomic, 3 = cross mapping, 4 = link |
|
| codeSystemEntityVersionId1 | Long | 1..1 | Points to the first entity of the association | |
| codeSystemEntityVersionId2 | Long | 1..1 | Points to the second entity of the association | |
| 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. | |
| 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 |
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_version_association | code_system_entity_version_association | 1..1 | Associates two entity versions with each other. | |
| id | Long | 1..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:CreateConceptAssociation> <parameter> <codeSystemEntityVersionAssociation> <associationKind>1</associationKind> <associationType> <codeSystemEntityVersionId>41</codeSystemEntityVersionId> </associationType> <codeSystemEntityVersionByCodeSystemEntityVersionId1> <versionId>1</versionId> </codeSystemEntityVersionByCodeSystemEntityVersionId1> <codeSystemEntityVersionByCodeSystemEntityVersionId2> <versionId>2</versionId> </codeSystemEntityVersionByCodeSystemEntityVersionId2> </codeSystemEntityVersionAssociation> <login> <sessionID>xxx</sessionID> </login> </parameter> </con:CreateConceptAssociation> </soapenv:Body> </soapenv:Envelope>
