WS-Beschreibung - Terminologieserver Authoring MaintainConceptAssociationType

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(Die Seite wurde neu angelegt: „<table border="0"> <tr> <td width="100px" style="font-weight: bold;">System</td> <td>Terminologieserver</td> </tr> <tr> <td style="font-weight: …“)
 
(→Request/Response)
 
(5 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt)
Zeile 1: Zeile 1:
−
<table border="0">
+
=Functionality=
−
  <tr>
+
Create a new or edit a existing association. Association type, properties and their versions can be edited or created.
−
    <td width="100px" style="font-weight: bold;">System</td>
+
−
    <td>Terminologieserver</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Webservice</td>
+
−
    <td>Authoring</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">WSDL</td>
+
−
    <td>http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Authoring?wsdl</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Methode</td>
+
−
    <td>MaintainConceptAssociationType</td>
+
−
  </tr>
+
−
</table><br>
+
  
−
=Funktionalität=
+
=Prerequisites=
−
Anlegen neuer oder verändern bestehender Assoziationen. Es können der Assoziationstyp sowie die Properties und deren Versionen geändert oder neu erstellt werden.
+
Requires [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]].
−
 
+
−
=Vorbedingungen=
+
−
Um diesen Webservice zu nutzen, müssen Sie sich zunächst am Terminologieserver anmelden ([[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]]).  
+
  
 
=Request/Response=
 
=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==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 +
    <th>Beschreibung</th>
 +
  </tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">LoginType</td>
 +
  <td>LoginType</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Login information</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">sessionID</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Session-ID from user (given by system)</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">VersioningType</td>
 +
  <td>VersioningType</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Versioning information</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">createNewVersion</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true if a new version should be created</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">majorUpdate</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>true if major version should count up</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">minorUpdate</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>true if minor version should count up</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system_entity</td>
 +
  <td>code_system_entity</td>
 +
<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 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>
 +
  <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>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Version-ID of Entity-Version</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level3">association_type</td>
 +
  <td>association_type</td>
 +
<td></td>  <td id="cardinality_cell">0..1</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>
 +
  <td id="param_level4">forwardName</td>
 +
  <td>String</td>
 +
  <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>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">name</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level4">property_version</td>
 +
  <td>property_version</td>
 +
<td></td>  <td id="cardinality_cell">1..N</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">content</td>
 +
  <td>byte[]</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">contentMimetype</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">contentName</td>
 +
  <td>String</td>
 +
  <td>255</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <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>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">languageId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">name</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Mandatory, if versionId is not listed.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">propertyKindId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
</table>
 +
==Response==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;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></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>an additional message</td>
 +
</tr>
 +
<tr>
 +
  <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="param_level2">status</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>OK, FAILURE</td>
 +
</tr>
 +
</table>
  
−
=Anmerkungen=
+
=Annotations=
−
==Besonderheiten==
+
==Noteworthiness==
−
==Hinweise==
+
==Hints==
  
−
=Beispiele=
+
=Examples=
−
==SOAP-Nachrichten==
+
==SOAP messages==
 
<source lang="xml">
 
<source lang="xml">
  
 
</source>
 
</source>
  
−
==Code-Beispiele==
+
==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

Annotations

Noteworthiness

Hints

Examples

SOAP messages

 

Code examples

Java

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