Terminologieserver - ConceptAssociation - MaintainConceptAssociation

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
Zeile 38: Zeile 38:
 
3 = cross mapping,
 
3 = cross mapping,
 
4 = link</td>
 
4 = link</td>
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">associationTypeId</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Specifies the Type of the association (e.g. 'belongs to')</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">codeSystemEntityVersionId1</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Points to the first entity of the association</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">codeSystemEntityVersionId2</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Points to the second entity of the association</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 66: 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 id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">insertTimestamp</td>
 
  <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Point of time, when the association was inserted.</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 81: Zeile 53:
 
   <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.
 
   <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>
 
If the direction should be ID2 -> ID1, forwardName and reverseName have to be reverted as well. </td>
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">status</td>
 
  <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Status of the current entry. Can be taken from a domain. </td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">statusDate</td>
 
  <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Point of time of the last change of the status.</td>
 
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 109: Zeile 67:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Match to the versionId of code_system_entity_version</td>
 
   <td>Match to the versionId of code_system_entity_version</td>
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">forwardName</td>
 
  <td>String</td>
 
  <td>50</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Name of association in normal reading direction (ID 1->2)</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">reverseName</td>
 
  <td>String</td>
 
  <td>50</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Name of association in reversed reading direction (ID 2->1)</td>
 
 
</tr>
 
</tr>
 
</table>
 
</table>

Aktuelle Version vom 30. September 2014, 12:31 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 Name of an association. Specialization of code_system_entity_version. The codeSystemEntityVersionId is the same as the versionId of code_system_entity_version
3 codeSystemEntityVersionId Long 1..1 Match to 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>



zurück zur Webservice-Übersicht

Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge