Terminologieserver - ConceptAssociation - ReturnConceptAssociationDetails

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
Zeile 28: 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 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 35: Zeile 66:
 
<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>
Zeile 71: Zeile 131:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Specifies the Type of the association (e.g. 'belongs to')</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>
 
<tr>
 
<tr>
Zeile 541: Zeile 608:
 
<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>

Version vom 30. September 2014, 12:20 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Return all details about a association including the related concepts.

Request/Response

Request

Level Parameter Typ Länge Kardinalität Beschreibung
1 loginToken String 0..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 = 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.


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 codeSystemEntityVersionAssociation code_system_entity_version_association 0..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 1..1 Specifies the Type of the association (e.g. 'belongs to')
2 codeSystemEntityVersionId1 Long - Points to the first entity of the association
2 codeSystemEntityVersionId2 Long 1..1 Points to the second entity of the association
2 id Long 1..1
2 insertTimestamp java.util.Date 1..1 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 1..1 Status of the current entry. Can be taken from a domain.
2 statusDate java.util.Date 1..1 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 1..1 Name of association in normal reading direction (ID 1->2)
3 reverseName String 50 1..1 Name of association in reversed reading direction (ID 2->1)
2 codeSystemEntityVersionByCodeSystemEntityVersionId1 code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
3 codeSystemEntityId Long 1..1 Foreign key to code system entities ID
3 effectiveDate java.util.Date 1..1 Last change date of the entity version.
3 insertTimestamp java.util.Date 1..1 Point in time when entry was inserted.
3 isLeaf Boolean 1..1 Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only.
3 majorRevision Integer 1..1 Major revision of this entry (composition of major and minor version e.g. 1.3).
3 minorRevision Integer 1..1 Minor revision of this entry (composition of major and minor version e.g. 1.3)
3 previousVersionId Long 1..1 Refers to the prior version, if there are more than one version.
3 statusDeactivated Integer 1..1 Defines the state. Default value is 0 (=visible). Look for available values in the according domain.
3 statusDeactivatedDate java.util.Date 1..1 Date when statusDeactivated changed
3 statusVisibility Integer 1..1 Status of the current entry. Can be taken from a domain.
3 statusVisibilityDate java.util.Date 1..1 Point of time of the last change of the status.
3 statusWorkflow Integer 1..1 A workflow status, can be unique for each codesystem.
3 statusWorkflowDate java.util.Date 1..1 Date when statusWorkflow changed
3 versionId Long 1..1 The ID of this entry.
3 codeSystemConcept code_system_concept 1..1 Displays a concept or term. Specialization of code_system_entity_version.
4 code String 100 1..1 Code of a concept or term.
4 codeSystemEntityVersionId Long 1..1
4 description String 1..1 Description of a term or concept
4 hints String 65535 1..1
4 isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
4 meaning String 65535 1..1
4 term String 65535 1..1 The term itself
4 termAbbrevation String 50 1..1 The abbrevation of the term.
3 codeSystemEntity code_system_entity 1..1 Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
4 currentVersionId Long 1..1 Current ID of code_system_entity_version.
4 id Long 1..1
2 codeSystemEntityVersionByCodeSystemEntityVersionId2 code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
3 codeSystemEntityId Long 1..1 Foreign key to code system entities ID
3 effectiveDate java.util.Date 1..1 Last change date of the entity version.
3 insertTimestamp java.util.Date 1..1 Point in time when entry was inserted.
3 isLeaf Boolean 1..1 Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only.
3 majorRevision Integer 1..1 Major revision of this entry (composition of major and minor version e.g. 1.3).
3 minorRevision Integer 1..1 Minor revision of this entry (composition of major and minor version e.g. 1.3)
3 previousVersionId Long 1..1 Refers to the prior version, if there are more than one version.
3 statusDeactivated Integer 1..1 Defines the state. Default value is 0 (=visible). Look for available values in the according domain.
3 statusDeactivatedDate java.util.Date 1..1 Date when statusDeactivated changed
3 statusVisibility Integer 1..1 Status of the current entry. Can be taken from a domain.
3 statusVisibilityDate java.util.Date 1..1 Point of time of the last change of the status.
3 statusWorkflow Integer 1..1 A workflow status, can be unique for each codesystem.
3 statusWorkflowDate java.util.Date 1..1 Date when statusWorkflow changed
3 versionId Long 1..1 The ID of this entry.
3 codeSystemConcept code_system_concept 1..1 Displays a concept or term. Specialization of code_system_entity_version.
4 code String 100 1..1 Code of a concept or term.
4 codeSystemEntityVersionId Long 1..1
4 description String 1..1 Description of a term or concept
4 hints String 65535 1..1
4 isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
4 meaning String 65535 1..1
4 term String 65535 1..1 The term itself
4 termAbbrevation String 50 1..1 The abbrevation of the term.
3 codeSystemEntity code_system_entity 1..1 Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
4 currentVersionId Long 1..1 Current ID of code_system_entity_version.
4 id Long 1..1
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

Beispiele

SOAP

Return details

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <con:ReturnConceptAssociationDetails>
         <parameter>
           <codeSystemEntityVersionAssociation>
		   <id>1555</id>
           </codeSystemEntityVersionAssociation>
         </parameter>
      </con:ReturnConceptAssociationDetails>
   </soapenv:Body>
</soapenv:Envelope>



zurück zur Webservice-Übersicht

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