Terminologieserver - Search - ReturnConceptDetails
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
| 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= | ||
| + | List all details of the given concept.<br> | ||
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
| Zeile 12: | Zeile 14: | ||
<th>Beschreibung</th> | <th>Beschreibung</th> | ||
</tr> | </tr> | ||
| − | <tr | + | <tr> |
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
| − | <td id="param_level1"> | + | <td id="param_level1">loginToken</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
<td>String</td> | <td>String</td> | ||
<td></td> | <td></td> | ||
| − | <td id="cardinality_cell"> | + | <td id="cardinality_cell">0..1</td> |
| − | <td> | + | <td>Login-Token that ensures the user is logged in.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
| Zeile 46: | Zeile 41: | ||
<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> | + | <td>The ID of this entry.</td> |
</tr> | </tr> | ||
</table> | </table> | ||
| Zeile 62: | Zeile 57: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
| − | <td id="param_level1"> | + | <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 122: | Zeile 117: | ||
<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> | + | <td>Last change date of the entity version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 129: | Zeile 124: | ||
<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 | + | <td>Point in time when entry was inserted.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 136: | Zeile 131: | ||
<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 | + | <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 161: | Zeile 156: | ||
<tr> | <tr> | ||
<td id="cardinality_cell">3</td> | <td id="cardinality_cell">3</td> | ||
| − | <td id="param_level3"> | + | <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 168: | Zeile 177: | ||
<tr> | <tr> | ||
<td id="cardinality_cell">3</td> | <td id="cardinality_cell">3</td> | ||
| − | <td id="param_level3"> | + | <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 178: | Zeile 201: | ||
<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> | + | <td>The ID of this entry.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
| Zeile 257: | Zeile 280: | ||
<tr> | <tr> | ||
<td id="cardinality_cell">5</td> | <td id="cardinality_cell">5</td> | ||
| − | <td id="param_level5"> | + | <td id="param_level5">languageCd</td> |
| − | <td> | + | <td>String</td> |
| − | <td></td> | + | <td>30</td> |
| − | <td>Language of | + | <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 312: | Zeile 336: | ||
<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></td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="cardinality_cell">5</td> | ||
| + | <td id="param_level5">languageCd</td> | ||
| + | <td>String</td> | ||
| + | <td>30</td> | ||
| + | <td id="cardinality_cell">1..1</td> | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| Zeile 337: | Zeile 369: | ||
<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> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
| Zeile 496: | Zeile 397: | ||
<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> | ||
Version vom 22. Juli 2014, 08:54 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
List all 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 | codeSystemEntityVersion | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
| 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 | 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 | 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 | 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 | 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. |
| 3 | codeSystemMetadataValue | code_system_metadata_value | 0..N | Values of metadata | |
| 4 | id | Long | 1..1 | ||
| 4 | parameterValue | String | 65535 | 1..1 | Values of metadata. |
| 4 | metadataParameter | metadata_parameter | 1..1 | Contains an accumulation of meta data. (List of the available descriptions) | |
| 5 | id | Long | 1..1 | ||
| 5 | languageCd | String | 30 | 1..1 | |
| 5 | metadataParameterType | String | 30 | 1..1 | Type of the meta data. A possible list of values is contained in the domain table. |
| 5 | paramDatatype | String | 65535 | 1..1 | Data type of the value in code_system_metadata_value. |
| 5 | paramName | String | 65535 | 1..1 | Description of meta data (e.g. measurement unit) |
| 2 | codeSystemVersionEntityMembership | code_system_version_entity_membership | 1..N | Connects the version of a Code System to the entities. | |
| 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
Show details for a given concept
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ReturnConceptDetails> <parameter> <codeSystemEntity> <codeSystemEntityVersions> <versionId>205458</versionId> </codeSystemEntityVersions> </codeSystemEntity> </parameter> </sear:ReturnConceptDetails> </soapenv:Body> </soapenv:Envelope>
