Terminologieserver - Search - ListMetadataParameter
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
Zeile 40: | Zeile 40: | ||
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
<td>Contains an accumulation of meta data. (List of the available descriptions)</td> | <td>Contains an accumulation of meta data. (List of the available descriptions)</td> | ||
+ | </tr> | ||
+ | <tr id="gray"> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">codeSystemId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">-</td> | ||
+ | <td>If set, this entry belongs to a code system.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 79: | Zeile 86: | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
<td>Description of meta data (e.g. measurement unit)</td> | <td>Description of meta data (e.g. measurement unit)</td> | ||
+ | </tr> | ||
+ | <tr id="gray"> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">valueSetId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">-</td> | ||
+ | <td>If set, this entry belongs to a value set.</td> | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> |
Version vom 30. September 2014, 12:20 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 | codeSystemId | Long | - | If set, this entry belongs to a code system. | |
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 | valueSetId | Long | - | If set, this entry belongs to a value set. | |
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). Possible values are available in domain table with id 6 |
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 | English description of code system |
3 | id | Long | 1..1 | Internal ID = Primary Key of Code System | |
3 | insertTimestamp | java.util.Date | 1..1 | Timestamp, when 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 | url to the code system if available |
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>