Terminologieserver - Search - ListValueSetContents

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(3 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt)
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=
 +
Lists all concepts that are linked to the given value set version. <br>
 
=Request/Response=
 
=Request/Response=
 
==Request==
 
==Request==
Zeile 12: Zeile 14:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
−
<tr id="row_object">
+
<tr>
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">LoginType</td>
+
   <td id="param_level1">loginToken</td>
−
  <td>LoginType</td>
+
−
<td></td>  <td id="cardinality_cell">0..1</td>
+
−
  <td>Login information</td>
+
−
</tr>
+
−
<tr>
+
−
  <td id="cardinality_cell">2</td>
+
−
  <td id="param_level2">sessionID</td>
+
 
   <td>String</td>
 
   <td>String</td>
 
   <td></td>
 
   <td></td>
−
   <td id="cardinality_cell">1..1</td>
+
   <td id="cardinality_cell">0..1</td>
−
   <td>Session-ID from user (given by system)</td>
+
   <td>Login-Token that ensures the user is logged in.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 64: Zeile 59:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">SortingType</td>
+
   <td id="param_level1">sortingParameter</td>
 
   <td>SortingType</td>
 
   <td>SortingType</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Determines the assortment. If not given, the concepts are sorted asscending according to the code.</td>
+
   <td>Specifies the order deviating from the default order.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 101: Zeile 96:
 
<tr>
 
<tr>
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">readMetadata</td>
+
   <td id="param_level1">readMetadataLevel</td>
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
Zeile 120: Zeile 115:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">ReturnType</td>
+
   <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>
Zeile 187: Zeile 182:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Point in time of the last change.</td>
+
   <td>Last change date of the entity version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 194: Zeile 189:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Point in time, when entry was inserted.</td>
+
   <td>Point in time when entry was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 201: Zeile 196:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only. </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>
 
<tr>
 
<tr>
Zeile 226: Zeile 221:
 
<tr>
 
<tr>
 
   <td id="cardinality_cell">3</td>
 
   <td id="cardinality_cell">3</td>
−
   <td id="param_level3">status</td>
+
   <td id="param_level3">statusDeactivated</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivatedDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Date when statusDeactivated changed</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusVisibility</td>
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
Zeile 233: Zeile 242:
 
<tr>
 
<tr>
 
   <td id="cardinality_cell">3</td>
 
   <td id="cardinality_cell">3</td>
−
   <td id="param_level3">statusDate</td>
+
   <td id="param_level3">statusVisibilityDate</td>
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Point of time of the last change of the status.</td>
 
   <td>Point of time of the last change of the status.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflow</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>A workflow status, can be unique for each codesystem.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflowDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Date when statusWorkflow changed</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 243: Zeile 266:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Version-ID of Entity-Version</td>
+
   <td>The ID of this entry.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 250: Zeile 273:
 
   <td>association_type</td>
 
   <td>association_type</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version</td>
+
   <td>Name of an association. Specialization of code_system_entity_version. The codeSystemEntityVersionId is the same as the versionId of code_system_entity_version</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 345: Zeile 368:
 
<tr>
 
<tr>
 
   <td id="cardinality_cell">5</td>
 
   <td id="cardinality_cell">5</td>
−
   <td id="param_level5">languageId</td>
+
   <td id="param_level5">languageCd</td>
−
   <td>Long</td>
+
   <td>String</td>
−
<td></td> <td id="cardinality_cell">1..1</td>
+
  <td>30</td>
−
   <td>Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)</td>
+
  <td id="cardinality_cell">1..1</td>
 +
   <td>Language of translation. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 365: Zeile 389:
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td>Abbreviation of the translated term.</td>
 
   <td>Abbreviation of the translated term.</td>
−
</tr>
 
−
<tr id="row_object">
 
−
  <td id="cardinality_cell">3</td>
 
−
  <td id="param_level3">property</td>
 
−
  <td>property</td>
 
−
<td></td>  <td id="cardinality_cell">0..N</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">4</td>
 
−
  <td id="param_level4">currentVersionId</td>
 
−
  <td>Long</td>
 
−
<td></td>  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">4</td>
 
−
  <td id="param_level4">id</td>
 
−
  <td>Long</td>
 
−
<td></td>  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr id="row_object">
 
−
  <td id="cardinality_cell">4</td>
 
−
  <td id="param_level4">propertyVersion</td>
 
−
  <td>property_version</td>
 
−
<td></td>  <td id="cardinality_cell">1..N</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">content</td>
 
−
  <td>byte[]</td>
 
−
<td></td>  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">contentMimetype</td>
 
−
  <td>String</td>
 
−
  <td>50</td>
 
−
  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">contentName</td>
 
−
  <td>String</td>
 
−
  <td>255</td>
 
−
  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">contentSize</td>
 
−
  <td>Integer</td>
 
−
<td></td>  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">description</td>
 
−
  <td>String</td>
 
−
  <td>65535</td>
 
−
  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">insertTimestamp</td>
 
−
  <td>java.util.Date</td>
 
−
<td></td>  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">languageId</td>
 
−
  <td>Long</td>
 
−
<td></td>  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">name</td>
 
−
  <td>String</td>
 
−
  <td>65535</td>
 
−
  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">previousVersionId</td>
 
−
  <td>Long</td>
 
−
<td></td>  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">propertyKindId</td>
 
−
  <td>Long</td>
 
−
<td></td>  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">status</td>
 
−
  <td>Integer</td>
 
−
<td></td>  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">statusDate</td>
 
−
  <td>java.util.Date</td>
 
−
<td></td>  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
−
</tr>
 
−
<tr>
 
−
  <td id="cardinality_cell">5</td>
 
−
  <td id="param_level5">versionId</td>
 
−
  <td>Long</td>
 
−
<td></td>  <td id="cardinality_cell">1..1</td>
 
−
  <td></td>
 
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 523: Zeile 424:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>true, if the belonging entity of the entry is a root element of the code system.</td>
 
   <td>true, if the belonging entity of the entry is a root element of the code system.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">orderNr</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>If used, concepts are ordered by the given numbers.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 543: Zeile 451:
 
   </soapenv:Body>
 
   </soapenv:Body>
 
</soapenv:Envelope>
 
</soapenv:Envelope>
 +
</source>
 +
===List valueset contents with a search date===
 +
<source lang="xml">
 +
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
 +
  <soapenv:Header/>
 +
  <soapenv:Body>
 +
      <sear:ListValueSetContents>
 +
        <parameter>           
 +
            <valueSet>
 +
              <valueSetVersions>
 +
                <versionId>4</versionId>
 +
                <conceptValueSetMemberships>
 +
                  <statusDate>2013-01-01T00:00:00+01:00</statusDate>
 +
                </conceptValueSetMemberships>
 +
              </valueSetVersions>
 +
            </valueSet>
 +
            <readMetadataLevel>true</readMetadataLevel>
 +
        </parameter>
 +
      </sear:ListValueSetContents>
 +
  </soapenv:Body>
 +
  </soapenv:Envelope>
 
</source>
 
</source>
 
<br><br>
 
<br><br>
  
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]

Aktuelle Version vom 30. September 2014, 12:31 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Lists all concepts that are linked to the given value set version.

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 valueSet value_set 1..1 A subset of terms.Every valueset has at least one valueset-version.
2 valueSetVersion value_set_version 0..1 Represents the version of an valueset.
3 releaseDate java.util.Date 0..1 Start date for the validity of the valueset version.
3 versionId Long 1..1 Version ID of the value set
3 conceptValueSetMembership concept_value_set_membership 0..1 Connects a valueset to an entity.
1 sortingParameter SortingType 0..1 Specifies the order deviating from the default order.
2 sortBy String 0..1 possible values: CODE, TERM default value: CODE
2 sortDirection String 0..1 possible values: ASCENDING, DESCENDING default value: ASCENDING
2 sortType String 0..1 possible values: ALPHABETICALLY, ORDER_NR default value: ALPHABETICALLY
1 readMetadataLevel Boolean 0..1 falls true, werden alle Metadaten zu den Konzepten zurückgeliefert


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
1 codeSystemEntity code_system_entity 0..N 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 1..N code_system_entity_version is the superclass of every Concept and Association.
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 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
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)
3 codeSystemConcept code_system_concept 0..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 description String 1..1 Description of a term or concept
4 isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
4 term String 65535 1..1 The term itself
4 termAbbrevation String 50 1..1 The abbrevation of the term.
4 codeSystemConceptTranslation code_system_concept_translation 0..N Translation of a term
5 codeSystemEntityVersionId Long 1..1
5 description String 1..1 Description of the translated term.
5 id Long 1..1
5 languageCd String 30 1..1 Language of translation. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
5 term String 65535 1..1 Translated term
5 termAbbrevation String 50 1..1 Abbreviation of the translated term.
2 codeSystemVersionEntityMembership code_system_version_entity_membership 1..1 Connects the version of a Code System to the entities.
3 codeSystemEntityId Long 1..1
3 codeSystemVersionId Long 1..1
3 isAxis Boolean 1..1 true, if the belonging entity of the entry is an axis of the code system
3 isMainClass Boolean 1..1 true, if the belonging entity of the entry is a root element of the code system.
3 orderNr Long 1..1 If used, concepts are ordered by the given numbers.

Beispiele

SOAP

List valueset content with valueset version-id 6

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListValueSetContents>
         <parameter>
         <valueSet>
             <valueSetVersions>
                 <versionId>6</versionId>
               </valueSetVersions>
            </valueSet>
         </parameter>
      </sear:ListValueSetContents>
   </soapenv:Body>
</soapenv:Envelope>

List valueset contents with a search date

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListValueSetContents>
         <parameter>            
            <valueSet>
               <valueSetVersions>
                 <versionId>4</versionId>
                 <conceptValueSetMemberships>
                   <statusDate>2013-01-01T00:00:00+01:00</statusDate>
                 </conceptValueSetMemberships>
               </valueSetVersions>
            </valueSet>
            <readMetadataLevel>true</readMetadataLevel>
         </parameter>
      </sear:ListValueSetContents>
   </soapenv:Body>
  </soapenv:Envelope>



zurück zur Webservice-Übersicht

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