Terminologieserver - Search - ListMetadataParameter

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
Zeile 2: Zeile 2:
  
 
=Beschreibung=
 
=Beschreibung=
−
LIst all available metadata<br>
+
List all available metadata<br>
 
=Request/Response=
 
=Request/Response=
 
==Request==
 
==Request==
Zeile 14: Zeile 14:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
 +
<tr>
 +
  <td id="cardinality_cell">1</td>
 +
  <td id="param_level1">loginToken</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Login-Token that ensures the user is logged in.</td>
 +
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
Zeile 26: Zeile 34:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">1</td>
 +
  <td id="param_level1">metadataParameter</td>
 +
  <td>metadata_parameter</td>
 +
<td></td>  <td id="cardinality_cell">0..N</td>
 +
  <td>Contains an accumulation of meta data. (List of the available descriptions)</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">languageCd</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">metadataParameterType</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Type of the meta data. A possible list of values is contained in the domain table.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">paramDatatype</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Data type of the value in code_system_metadata_value.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">paramName</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of meta data (e.g. measurement unit)</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">codeSystem</td>
 +
  <td>code_system</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Name of codesystem. Each codesystem requires at least one version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemType</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Type of Code System (Taxonomy, Ontology). A possible value set is available in domain table</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Version of the Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Narrative description of Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">descriptionEng</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Internal ID = Primary Key of Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Timestamp, wenn the Code System was inserted</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Name of the Code System. The precise name should be specified in the Code System Version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">website</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">valueSet</td>
 +
  <td>value_set</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Points to the current version of the valueset.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of the valueset.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">descriptionEng</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>ID of the valueset.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Name of the valueset.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Alteration time of the status.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">website</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">1</td>
 +
  <td id="param_level1">returnInfos</td>
 +
  <td>ReturnType</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Return information</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">count</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>number of results</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">message</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>an additional message</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">overallErrorCategory</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>INFO, WARN, ERROR</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">status</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>OK, FAILURE</td>
 +
</tr>
 
</table>
 
</table>
 
=Beispiele=
 
=Beispiele=

Version vom 22. Juli 2014, 08:54 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

List all available metadata

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.


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 metadataParameter metadata_parameter 0..N Contains an accumulation of meta data. (List of the available descriptions)
2 id Long 1..1
2 languageCd String 30 1..1
2 metadataParameterType String 30 1..1 Type of the meta data. A possible list of values is contained in the domain table.
2 paramDatatype String 65535 1..1 Data type of the value in code_system_metadata_value.
2 paramName String 65535 1..1 Description of meta data (e.g. measurement unit)
2 codeSystem code_system 0..1 Name of codesystem. Each codesystem requires at least one version.
3 codeSystemType String 30 1..1 Type of Code System (Taxonomy, Ontology). A possible value set is available in domain table
3 currentVersionId Long 1..1 Version of the Code System
3 description String 65535 1..1 Narrative description of Code System
3 descriptionEng String 65535 1..1
3 id Long 1..1 Internal ID = Primary Key of Code System
3 insertTimestamp java.util.Date 1..1 Timestamp, wenn the Code System was inserted
3 name String 100 1..1 Name of the Code System. The precise name should be specified in the Code System Version.
3 website String 65535 1..1
2 valueSet value_set 0..1 A subset of terms.Every valueset has at least one valueset-version.
3 currentVersionId Long 1..1 Points to the current version of the valueset.
3 description String 65535 1..1 Description of the valueset.
3 descriptionEng String 65535 1..1
3 id Long 1..1 ID of the valueset.
3 name String 50 1..1 Name of the valueset.
3 status Integer 1..1 Status of the current entry. Can be found in a domain.
3 statusDate java.util.Date 1..1 Alteration time of the status.
3 website String 65535 1..1
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

LIst all available metadata

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



zurück zur Webservice-Übersicht

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