WS-Beschreibung - Terminologieserver Authoring MaintainConceptAssociationType
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Becker (Diskussion | Beiträge) (→Request/Response) |
Becker (Diskussion | Beiträge) (→Request/Response) |
||
(4 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | + | =Functionality= | |
− | + | Create a new or edit a existing association. Association type, properties and their versions can be edited or created. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | = | + | =Prerequisites= |
− | + | Requires [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]]. | |
− | = | + | =Request/Response= |
− | + | The required request parameters differs for creating a new version and editing an existing one. The request and response table below refers to the creation of a new version only. | |
+ | |||
+ | Required fields: new version | ||
+ | * | ||
+ | |||
+ | Required fields: edit version | ||
+ | * | ||
− | |||
==Request== | ==Request== | ||
<table border="1" cellpadding="1" class="ws_table"> | <table border="1" cellpadding="1" class="ws_table"> | ||
Zeile 36: | Zeile 25: | ||
<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>Login | + | <td>Login information</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 59: | Zeile 34: | ||
<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">VersioningType</td> | <td id="param_level1">VersioningType</td> | ||
− | <td></td> | + | <td>VersioningType</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Versioning information</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 78: | Zeile 46: | ||
<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>true | + | <td>true if a new version should be created</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 84: | Zeile 52: | ||
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td>true | + | <td>true if major version should count up</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 90: | Zeile 58: | ||
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td>true | + | <td>true if minor version should count up</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system_entity</td> | <td id="param_level1">code_system_entity</td> | ||
− | <td></td> | + | <td>code_system_entity</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</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="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">code_system_entity_version</td> | <td id="param_level2">code_system_entity_version</td> | ||
− | <td></td> | + | <td>code_system_entity_version</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>code_system_entity_version is the superclass of every Concept and Association. </td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 144: | Zeile 76: | ||
<td>Integer</td> | <td>Integer</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 150: | Zeile 82: | ||
<td>Integer</td> | <td>Integer</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 174: | Zeile 88: | ||
<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> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level3">association_type</td> | <td id="param_level3">association_type</td> | ||
− | <td></td> | + | <td>association_type</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</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> | <tr> | ||
Zeile 193: | Zeile 101: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td>Name | + | <td>Name of association in normal reading direction (ID 1->2)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 200: | Zeile 108: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td>Name | + | <td>Name of association in reversed reading direction (ID 2->1)</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level3">property</td> | <td id="param_level3">property</td> | ||
− | <td></td> | + | <td>property</td> |
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
Zeile 229: | Zeile 131: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level4">property_version</td> | <td id="param_level4">property_version</td> | ||
− | <td></td> | + | <td>property_version</td> |
<td></td> <td id="cardinality_cell">1..N</td> | <td></td> <td id="cardinality_cell">1..N</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
Zeile 270: | Zeile 166: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
Zeile 289: | Zeile 179: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Mandatory, if versionId is not listed.</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 313: | Zeile 191: | ||
<td>Integer</td> | <td>Integer</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
Zeile 339: | Zeile 211: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">ReturnType</td> | <td id="param_level1">ReturnType</td> | ||
− | <td></td> | + | <td>ReturnType</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Return information</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 354: | Zeile 220: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>an additional message</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 370: | Zeile 236: | ||
</table> | </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, 09:09 Uhr
Inhaltsverzeichnis |
Functionality
Create a new or edit a existing association. Association type, properties and their versions can be edited or created.
Prerequisites
Requires Login.
Request/Response
The required request parameters differs for creating a new version and editing an existing one. The request and response table below refers to the creation of a new version only.
Required fields: new version
Required fields: edit version
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) | |
VersioningType | VersioningType | 1..1 | Versioning information | |
createNewVersion | Boolean | 1..1 | true if a new version should be created | |
majorUpdate | Boolean | 0..1 | true if major version should count up | |
minorUpdate | Boolean | 0..1 | true if minor version should count up | |
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) | |
versionId | Long | 1..1 | Version-ID of Entity-Version | |
association_type | association_type | 0..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 | ||
id | Long | 1..1 | ||
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 | 0..1 | Mandatory, if versionId is not listed. |
propertyKindId | Long | 0..1 | ||
status | Integer | 0..1 | ||
versionId | Long | 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 |