WS-Beschreibung - Terminologieserver Authoring CreateConceptAssociationType
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Becker (Diskussion | Beiträge) (→Request) |
Becker (Diskussion | Beiträge) |
||
(7 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | + | =Functionality= | |
− | + | Creates a new association type. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
+ | If a code system is specified, the new association type will be available in that code system only. Otherwise it will be available in all code systems . | ||
− | = | + | =Prerequisites= |
− | + | Requires [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]]. | |
=Request/Response= | =Request/Response= | ||
− | + | ==Request== | |
− | + | ||
<table border="1" cellpadding="1" class="ws_table"> | <table border="1" cellpadding="1" class="ws_table"> | ||
<tr class="ws_table_head"> | <tr class="ws_table_head"> | ||
Zeile 36: | Zeile 19: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">LoginType</td> | <td id="param_level1">LoginType</td> | ||
− | <td></td> | + | <td>LoginType</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Login information</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 59: | Zeile 28: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Session-ID from user (given by system)</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system</td> | <td id="param_level1">code_system</td> | ||
− | <td></td> | + | <td>code_system</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td></td> | + | <td>Name of codesystem. Each codesystem requires at least one version.</td> |
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id="param_level2"> | + | <td id="param_level2">id</td> |
<td>Long</td> | <td>Long</td> | ||
− | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">1..1</td> |
− | <td></td> | + | <td>Internal ID = Primary Key of Code System</td> |
</tr> | </tr> | ||
− | <tr id=" | + | <tr id="row_object"> |
− | <td id="param_level2"> | + | <td id="param_level2">code_system_version</td> |
− | <td> | + | <td>code_system_version</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Version of a Code System</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">versionId</td> |
<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> | <td></td> | ||
</tr> | </tr> | ||
− | <tr id=" | + | <tr id="row_object"> |
− | <td id=" | + | <td id="param_level1">code_system_entity</td> |
− | <td> | + | <td>code_system_entity</td> |
− | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">1..1</td> |
− | <td></td> | + | <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td> |
</tr> | </tr> | ||
− | <tr id=" | + | <tr id="row_object"> |
− | <td id="param_level2"> | + | <td id="param_level2">code_system_entity_version</td> |
− | <td> | + | <td>code_system_entity_version</td> |
− | <td> | + | <td></td> <td id="cardinality_cell">1..1</td> |
− | <td id="cardinality_cell"> | + | <td>code_system_entity_version is the superclass of every Concept and Association. </td> |
− | <td></td> | + | </tr> |
+ | <tr> | ||
+ | <td id="param_level3">majorRevision</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level3">minorRevision</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
− | <td id=" | + | <td id="param_level3">association_type</td> |
− | <td></td> | + | <td>association_type</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td></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> |
</tr> | </tr> | ||
− | <tr id=" | + | <tr> |
− | <td id="param_level3"> | + | <td id="param_level4">forwardName</td> |
− | <td> | + | <td>String</td> |
− | <td></td> <td id="cardinality_cell"> | + | <td>50</td> |
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Name of association in normal reading direction (ID 1->2)</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">reverseName</td> | ||
+ | <td>String</td> | ||
+ | <td>50</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Name of association in reversed reading direction (ID 2->1)</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level3">property</td> | ||
+ | <td>property</td> | ||
+ | <td></td> <td id="cardinality_cell">0..N</td> | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level4">name</td> |
<td>String</td> | <td>String</td> | ||
<td>65535</td> | <td>65535</td> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">0..1</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr id=" | + | <tr id="row_object"> |
− | <td id=" | + | <td id="param_level4">property_version</td> |
− | <td> | + | <td>property_version</td> |
− | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">1..N</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level5">content</td> |
− | <td> | + | <td>byte[]</td> |
− | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">0..1</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level5">contentMimetype</td> |
<td>String</td> | <td>String</td> | ||
− | <td> | + | <td>50</td> |
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">0..1</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level5">contentName</td> |
<td>String</td> | <td>String</td> | ||
− | <td> | + | <td>255</td> |
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">0..1</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr id=" | + | <tr> |
− | <td id=" | + | <td id="param_level5">contentSize</td> |
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">description</td> | ||
<td>String</td> | <td>String</td> | ||
− | <td> | + | <td>65535</td> |
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">0..1</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level5">languageId</td> |
<td>Long</td> | <td>Long</td> | ||
− | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">0..1</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr id=" | + | <tr> |
− | <td id=" | + | <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="param_level5">propertyKindId</td> | ||
<td>Long</td> | <td>Long</td> | ||
− | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">0..1</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level5">status</td> |
− | <td> | + | <td>Integer</td> |
− | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">0..1</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr id=" | + | </table> |
− | <td id=" | + | ==Response== |
+ | <table border="1" cellpadding="1" class="ws_table"> | ||
+ | <tr class="ws_table_head"> | ||
+ | <th>Parameter</th> | ||
+ | <th>Typ</th> | ||
+ | <th>Länge</th> | ||
+ | <th id="cardinality_cell">Kardinalität</th> | ||
+ | <th>Beschreibung</th> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level1">ReturnType</td> | ||
+ | <td>ReturnType</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Return information</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level2">message</td> | ||
<td>String</td> | <td>String</td> | ||
− | |||
− | |||
<td></td> | <td></td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>an additional message</td> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level2">overallErrorCategory</td> |
− | + | ||
− | + | ||
<td></td> | <td></td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>INFO, WARN, ERROR</td> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level2">status</td> |
− | + | ||
− | + | ||
<td></td> | <td></td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>OK, FAILURE</td> | ||
</tr> | </tr> | ||
− | <tr id=" | + | <tr id="row_object"> |
− | <td id=" | + | <td id="param_level1">code_system_entity</td> |
− | <td> | + | <td>code_system_entity</td> |
− | <td></td> <td id="cardinality_cell"> | + | <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> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level2">currentVersionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Current ID of code_system_entity_version.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level2">id</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td></td> | <td></td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level2">code_system_entity_version</td> | ||
+ | <td>code_system_entity_version</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>code_system_entity_version is the superclass of every Concept and Association. </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 205: | Zeile 238: | ||
<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> | + | <td>Version-ID of Entity-Version</td> |
</tr> | </tr> | ||
+ | </table> | ||
− | = | + | =Annotations= |
− | == | + | ==Noteworthiness== |
− | == | + | ==Hints== |
− | = | + | =Examples= |
− | ==SOAP | + | ==SOAP messages== |
<source lang="xml"> | <source lang="xml"> | ||
</source> | </source> | ||
− | ==Code | + | ==Code examples== |
===Java=== | ===Java=== | ||
<source lang="java"> | <source lang="java"> | ||
</source> | </source> |
Aktuelle Version vom 9. August 2013, 08:52 Uhr
Inhaltsverzeichnis |
Functionality
Creates a new association type.
If a code system is specified, the new association type will be available in that code system only. Otherwise it will be available in all code systems .
Prerequisites
Requires Login.
Request/Response
Request
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
LoginType | LoginType | 0..1 | Login information | |
sessionID | String | 1..1 | Session-ID from user (given by system) | |
code_system | code_system | 0..1 | Name of codesystem. Each codesystem requires at least one version. | |
id | Long | 1..1 | Internal ID = Primary Key of Code System | |
code_system_version | code_system_version | 1..1 | Version of a Code System | |
versionId | Long | 1..1 | ||
code_system_entity | code_system_entity | 1..1 | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
code_system_entity_version | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
majorRevision | Integer | 0..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
minorRevision | Integer | 0..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
association_type | association_type | 1..1 | Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version | |
forwardName | String | 50 | 1..1 | Name of association in normal reading direction (ID 1->2) |
reverseName | String | 50 | 1..1 | Name of association in reversed reading direction (ID 2->1) |
property | property | 0..N | ||
name | String | 65535 | 0..1 | |
property_version | property_version | 1..N | ||
content | byte[] | 0..1 | ||
contentMimetype | String | 50 | 0..1 | |
contentName | String | 255 | 0..1 | |
contentSize | Integer | 0..1 | ||
description | String | 65535 | 0..1 | |
languageId | Long | 0..1 | ||
name | String | 65535 | 1..1 | |
propertyKindId | Long | 0..1 | ||
status | Integer | 0..1 |
Response
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
ReturnType | ReturnType | 1..1 | Return information | |
message | String | 1..1 | an additional message | |
overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
status | 1..1 | OK, FAILURE | ||
code_system_entity | code_system_entity | 1..1 | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
currentVersionId | Long | 1..1 | Current ID of code_system_entity_version. | |
id | Long | 1..1 | ||
code_system_entity_version | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
versionId | Long | 1..1 | Version-ID of Entity-Version |