Terminologieserver - ConceptAssociation - MaintainConceptAssociation
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= | ||
+ | Edit the associations between two entity versions. <br> | ||
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
Zeile 12: | Zeile 14: | ||
<th>Beschreibung</th> | <th>Beschreibung</th> | ||
</tr> | </tr> | ||
− | <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">1..1</td> | <td id="cardinality_cell">1..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 33: | Zeile 28: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <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> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">associationKind</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td>1 = ontological, | ||
+ | 2 = taxonomic, | ||
+ | 3 = cross mapping, | ||
+ | 4 = link</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 40: | Zeile 45: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td></td> | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">leftId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">0..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> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 69: | Zeile 82: | ||
<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> | ||
<td>Return information</td> | <td>Return information</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">count</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>number of results</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 97: | Zeile 117: | ||
</tr> | </tr> | ||
</table> | </table> | ||
+ | =Beispiele= | ||
+ | ==SOAP== | ||
+ | ===Maintain association=== | ||
+ | <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:MaintainConceptAssociation> | ||
+ | <parameter> | ||
+ | <codeSystemEntityVersionAssociation> | ||
+ | <id>1</id> | ||
+ | <associationType> | ||
+ | <codeSystemEntityVersionId>10</codeSystemEntityVersionId> | ||
+ | </associationType> | ||
+ | </codeSystemEntityVersionAssociation> | ||
+ | <loginToken>INSERT LOGIN TOKEN</loginToken> | ||
+ | </parameter> | ||
+ | </con:MaintainConceptAssociation> | ||
+ | </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
Edit the associations between two entity versions.
Request/Response
Request
Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|---|
1 | loginToken | String | 1..1 | Login-Token that ensures the user is logged in. | |
1 | codeSystemEntityVersionAssociation | code_system_entity_version_association | 1..1 | Associates two entity versions with each other. | |
2 | associationKind | Integer | 0..1 | 1 = ontological,
2 = taxonomic, 3 = cross mapping, 4 = link |
|
2 | id | Long | 1..1 | ||
2 | leftId | Long | 0..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 | associationType | association_type | 0..1 | Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version | |
3 | codeSystemEntityVersionId | Long | 1..1 | Equates the versionId of code_system_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 |
Beispiele
SOAP
Maintain association
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <con:MaintainConceptAssociation> <parameter> <codeSystemEntityVersionAssociation> <id>1</id> <associationType> <codeSystemEntityVersionId>10</codeSystemEntityVersionId> </associationType> </codeSystemEntityVersionAssociation> <loginToken>INSERT LOGIN TOKEN</loginToken> </parameter> </con:MaintainConceptAssociation> </soapenv:Body> </soapenv:Envelope>