Terminologieserver - Search - ReturnConceptAssociationTypeDetails

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>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 
   <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Current ID of code_system_entity_version.</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>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 35: Zeile 49:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Foreign key to code system entities ID</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">effectiveDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Last change date of the entity version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point in time when entry was inserted.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">isLeaf</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. </td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">majorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">minorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Refers to the prior version, if there are more than one version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivated</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivatedDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Date when statusDeactivated changed</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusVisibility</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">3</td>
 +
  <td id="param_level3">statusVisibilityDate</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 id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflow</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>A workflow status, can be unique for each codesystem.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflowDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Date when statusWorkflow changed</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 61: Zeile 166:
 
<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 111: Zeile 223:
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Foreign key to code system entities ID</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>

Version vom 30. September 2014, 12:20 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

List all properties and association types (with details) of the given concept

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 codeSystemEntity code_system_entity 1..1 Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
2 currentVersionId Long - Current ID of code_system_entity_version.
2 id Long -
2 codeSystemEntityVersion code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
3 codeSystemEntityId Long - Foreign key to code system entities ID
3 effectiveDate java.util.Date - Last change date of the entity version.
3 insertTimestamp java.util.Date - Point in time when entry was inserted.
3 isLeaf Boolean - Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only.
3 majorRevision Integer - Major revision of this entry (composition of major and minor version e.g. 1.3).
3 minorRevision Integer - Minor revision of this entry (composition of major and minor version e.g. 1.3)
3 previousVersionId Long - Refers to the prior version, if there are more than one version.
3 statusDeactivated Integer - Defines the state. Default value is 0 (=visible). Look for available values in the according domain.
3 statusDeactivatedDate java.util.Date - Date when statusDeactivated changed
3 statusVisibility Integer - Status of the current entry. Can be taken from a domain.
3 statusVisibilityDate java.util.Date - Point of time of the last change of the status.
3 statusWorkflow Integer - A workflow status, can be unique for each codesystem.
3 statusWorkflowDate java.util.Date - Date when statusWorkflow changed
3 versionId Long 1..1 The ID of this entry.


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 codeSystemEntity code_system_entity 1..1 Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
2 currentVersionId Long 1..1 Current ID of code_system_entity_version.
2 id Long 1..1
2 codeSystemEntityVersion code_system_entity_version 0..N code_system_entity_version is the superclass of every Concept and Association.
3 codeSystemEntityId Long - 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 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
4 codeSystemEntityVersionId Long 1..1 Match to the versionId of code_system_entity_version
4 forwardName String 50 1..1 Name of association in normal reading direction (ID 1->2)
4 reverseName String 50 1..1 Name of association in reversed reading direction (ID 2->1)

Beispiele

SOAP

Association details

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ReturnConceptAssociationTypeDetails>
         <parameter>
            <codeSystemEntity>
               <codeSystemEntityVersions>
                 <versionId>4</versionId>
               </codeSystemEntityVersions>
            </codeSystemEntity>
         </parameter>
      </sear:ReturnConceptAssociationTypeDetails>
   </soapenv:Body>
</soapenv:Envelope>



zurück zur Webservice-Übersicht

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