Terminologieserver - ConceptAssociation - CreateConceptAssociation

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>
 
<tr>
 
<tr>
Zeile 52: Zeile 59:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Points to the second entity of the association</td>
 
   <td>Points to the second entity of the association</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</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 60: Zeile 81:
 
   <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 74: Zeile 109:
 
<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>
Zeile 93: Zeile 144:
 
<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 id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">count</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>number of results</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 122: Zeile 180:
 
<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 id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">associationKind</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>1 = ontological,
 +
2 = taxonomic,
 +
3 = cross mapping,
 +
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 129: Zeile 218:
 
<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 id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">leftId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</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 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>
 
</table>
 
</table>

Version vom 30. September 2014, 12:20 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Creates a new association that links two entity versions with each other.

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 1..1 1 = ontological,

2 = taxonomic, 3 = cross mapping,

4 = link
2 associationTypeId Long - Specifies the Type of the association (e.g. 'belongs to')
2 codeSystemEntityVersionId1 Long 1..1 Points to the first entity of the association
2 codeSystemEntityVersionId2 Long 1..1 Points to the second entity of the association
2 id Long -
2 insertTimestamp java.util.Date - Point of time, when the association was inserted.
2 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.
2 status Integer - Status of the current entry. Can be taken from a domain.
2 statusDate java.util.Date - Point of time of the last change of the status.
2 associationType association_type 1..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
3 forwardName String 50 - Name of association in normal reading direction (ID 1->2)
3 reverseName String 50 - Name of association in reversed reading direction (ID 2->1)


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 returnInfos ReturnType 1..1 Return information
2 count Integer - number of results
2 message String 1..1 an additional message
2 overallErrorCategory 1..1 INFO, WARN, ERROR
2 status 1..1 OK, FAILURE
1 codeSystemEntityVersionAssociation code_system_entity_version_association 1..1 Associates two entity versions with each other.
2 associationKind Integer - 1 = ontological,

2 = taxonomic, 3 = cross mapping,

4 = link
2 associationTypeId Long - Specifies the Type of the association (e.g. 'belongs to')
2 codeSystemEntityVersionId1 Long - Points to the first entity of the association
2 codeSystemEntityVersionId2 Long - Points to the second entity of the association
2 id Long 1..1
2 insertTimestamp java.util.Date - Point of time, when the association was inserted.
2 leftId Long - 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 status Integer - Status of the current entry. Can be taken from a domain.
2 statusDate java.util.Date - Point of time of the last change of the status.

Beispiele

SOAP

Create a new association between two concepts

<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>
            <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken>
            <codeSystemEntityVersionAssociation>
               <associationKind>1</associationKind>
               <associationType>              
                 <codeSystemEntityVersionId>4</codeSystemEntityVersionId>
               </associationType>
               <codeSystemEntityVersionByCodeSystemEntityVersionId1>
                  <versionId>1</versionId>
               </codeSystemEntityVersionByCodeSystemEntityVersionId1>
               <codeSystemEntityVersionByCodeSystemEntityVersionId2>
                  <versionId>2</versionId>
               </codeSystemEntityVersionByCodeSystemEntityVersionId2>
            </codeSystemEntityVersionAssociation>
         </parameter>
      </con:CreateConceptAssociation>
   </soapenv:Body>
</soapenv:Envelope>



zurück zur Webservice-Übersicht

Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=Terminologieserver_-_ConceptAssociation_-_CreateConceptAssociation“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge