WS-Beschreibung - Terminologieserver Authoring CreateConcept

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Request/Response)
 
(4 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
<table border="0">
+
=Functionality=
−
  <tr>
+
Adds new concepts to the specified and existing code system version.
−
    <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>CreateConcept</td>
+
−
  </tr>
+
−
</table><br>
+
−
=Funktionalität=
+
−
Anlegen neuer Kontepte innerhalb einer bestimmten Vokabular-Version.
+
  
−
=Vorbedingungen=
+
=Prerequisites=
−
Um diesen Webservice zu nutzen, müssen Sie sich zunächst am Terminologieserver anmelden ([[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]]).
+
Requires [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]].  
−
Es müssen ein Vokabular und eine Vokabular-Version vorhanden sein.
+
  
 
=Request/Response=
 
=Request/Response=
Zeile 36: Zeile 17:
 
<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>
+
   <td>Login information</td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level2">ip</td>
+
   <td id="param_level2">sessionID</td>
 
   <td>String</td>
 
   <td>String</td>
 
   <td></td>
 
   <td></td>
−
   <td id="cardinality_cell">-</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">code_system</td>
 +
  <td>code_system</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Name of codesystem. Each codesystem requires at least one version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Internal ID = Primary Key of Code System</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_version</td>
 +
  <td>code_system_version</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Version of a Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr id="row_object">
−
   <td id="param_level2">password</td>
+
  <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 id="row_object">
 +
  <td id="param_level3">code_system_concept</td>
 +
  <td>code_system_concept</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Displays a concept or term. Specialization of code_system_entity_version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">code</td>
 
   <td>String</td>
 
   <td>String</td>
−
   <td></td>
+
   <td>100</td>
−
   <td id="cardinality_cell">-</td>
+
   <td id="cardinality_cell">1..1</td>
−
   <td></td>
+
   <td>Code of a concept or term.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
   <td id="param_level2">sessionID</td>
+
   <td id="param_level4">isPreferred</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Specifies, if a term or concept is preferred or not.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">term</td>
 
   <td>String</td>
 
   <td>String</td>
−
   <td></td>
+
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td></td>
+
   <td>The term itself</td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level2">username</td>
+
   <td id="param_level4">termAbbrevation</td>
 
   <td>String</td>
 
   <td>String</td>
−
   <td></td>
+
   <td>50</td>
−
   <td id="cardinality_cell">-</td>
+
   <td id="cardinality_cell">0..1</td>
−
   <td></td>
+
   <td>The abbrevation of the term.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
−
   <td id="param_level1">code_system</td>
+
   <td id="param_level4">code_system_concept_translation</td>
−
   <td></td>
+
   <td>code_system_concept_translation</td>
−
<td></td>  <td id="cardinality_cell">1..1</td>
+
<td></td>  <td id="cardinality_cell">0..N</td>
−
   <td></td>
+
   <td>Translation of a term</td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level2">currentVersionId</td>
+
   <td id="param_level5">languageId</td>
 
   <td>Long</td>
 
   <td>Long</td>
−
<td></td>  <td id="cardinality_cell">-</td>
+
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td></td>
+
   <td>Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)</td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level2">description</td>
+
   <td id="param_level5">term</td>
 
   <td>String</td>
 
   <td>String</td>
 
   <td>65535</td>
 
   <td>65535</td>
−
   <td id="cardinality_cell">-</td>
+
   <td id="cardinality_cell">1..1</td>
−
   <td></td>
+
   <td>Translated term</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
   <td id="param_level2">id</td>
+
   <td id="param_level5">termAbbrevation</td>
−
   <td>Long</td>
+
   <td>String</td>
−
<td></td> <td id="cardinality_cell">1..1</td>
+
  <td>50</td>
−
   <td></td>
+
  <td id="cardinality_cell">0..1</td>
 +
   <td>Abbreviation of the translated term.</td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr id="row_object">
−
   <td id="param_level2">insertTimestamp</td>
+
   <td id="param_level3">property</td>
−
   <td>java.util.Date</td>
+
   <td>property</td>
−
<td></td>  <td id="cardinality_cell">-</td>
+
<td></td>  <td id="cardinality_cell">0..N</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level2">name</td>
+
   <td id="param_level4">name</td>
 
   <td>String</td>
 
   <td>String</td>
−
   <td>100</td>
+
   <td>65535</td>
−
   <td id="cardinality_cell">-</td>
+
   <td id="cardinality_cell">0..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
−
   <td id="param_level2">code_system_version</td>
+
   <td id="param_level4">property_version</td>
−
   <td></td>
+
   <td>property_version</td>
−
<td></td>  <td id="cardinality_cell">1..1</td>
+
<td></td>  <td id="cardinality_cell">1..N</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">codeSystemId</td>
+
   <td id="param_level5">content</td>
−
   <td>Long</td>
+
   <td>byte[]</td>
−
<td></td>  <td id="cardinality_cell">-</td>
+
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">description</td>
+
   <td id="param_level5">contentMimetype</td>
 
   <td>String</td>
 
   <td>String</td>
−
   <td>65535</td>
+
   <td>50</td>
−
   <td id="cardinality_cell">-</td>
+
   <td id="cardinality_cell">0..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">expirationDate</td>
+
   <td id="param_level5">contentName</td>
−
   <td>java.util.Date</td>
+
   <td>String</td>
−
<td></td> <td id="cardinality_cell">-</td>
+
  <td>255</td>
 +
  <td id="cardinality_cell">0..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">insertTimestamp</td>
+
   <td id="param_level5">contentSize</td>
−
   <td>java.util.Date</td>
+
   <td>Integer</td>
−
<td></td>  <td id="cardinality_cell">-</td>
+
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">licenceHolder</td>
+
   <td id="param_level5">description</td>
 
   <td>String</td>
 
   <td>String</td>
 
   <td>65535</td>
 
   <td>65535</td>
−
   <td id="cardinality_cell">-</td>
+
   <td id="cardinality_cell">0..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">name</td>
+
   <td id="param_level5">languageId</td>
−
   <td>String</td>
+
   <td>Long</td>
−
  <td>100</td>
+
<td></td> <td id="cardinality_cell">0..1</td>
−
  <td id="cardinality_cell">-</td>
+
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">oid</td>
+
   <td id="param_level5">name</td>
 
   <td>String</td>
 
   <td>String</td>
−
   <td>100</td>
+
   <td>65535</td>
−
   <td id="cardinality_cell">-</td>
+
   <td id="cardinality_cell">1..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">preferredLanguageId</td>
+
   <td id="param_level5">propertyKindId</td>
 
   <td>Long</td>
 
   <td>Long</td>
−
<td></td>  <td id="cardinality_cell">-</td>
+
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">previousVersionID</td>
+
   <td id="param_level5">status</td>
−
   <td>Long</td>
+
   <td>Integer</td>
−
<td></td>  <td id="cardinality_cell">-</td>
+
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr id="row_object">
−
   <td id="param_level3">releaseDate</td>
+
   <td id="param_level2">code_system_version_entity_membership</td>
−
   <td>java.util.Date</td>
+
   <td>code_system_version_entity_membership</td>
−
<td></td>  <td id="cardinality_cell">-</td>
+
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td></td>
+
   <td>Connects the version of a Code System to the entities.</td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">source</td>
+
  <td id="param_level3">isAxis</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true, if the belonging entity of the entry is an axis of the code system</td>
 +
</tr>
 +
<tr>
 +
   <td id="param_level3">isMainClass</td>
 +
  <td>Boolean</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>
 +
</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>String</td>
−
  <td>65535</td>
 
−
  <td id="cardinality_cell">-</td>
 
 
   <td></td>
 
   <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>an additional message</td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">status</td>
+
   <td id="param_level2">overallErrorCategory</td>
−
  <td>Integer</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
 
   <td></td>
 
   <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>INFO, WARN, ERROR</td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">statusDate</td>
+
   <td id="param_level2">status</td>
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
 
   <td></td>
 
   <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>OK, FAILURE</td>
 
</tr>
 
</tr>
−
<tr id="gray">
+
<tr id="row_object">
−
   <td id="param_level3">underLicence</td>
+
   <td id="param_level1">code_system_entity</td>
−
   <td>Boolean</td>
+
   <td>code_system_entity</td>
−
<td></td>  <td id="cardinality_cell">-</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>
 +
  <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 293:
 
   <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>
  
−
=Anmerkungen=
+
=Annotations=
−
==Besonderheiten==
+
==Noteworthiness==
−
==Hinweise==
+
==Hints==
  
−
=Beispiele=
+
=Examples=
−
==SOAP-Nachrichten==
+
==SOAP messages==
 
<source lang="xml">
 
<source lang="xml">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/">
Zeile 244: Zeile 333:
 
</source>
 
</source>
  
−
==Code-Beispiele==
+
==Code examples==
 
===Java===
 
===Java===
 
<source lang="java">
 
<source lang="java">
 
</source>
 
</source>

Aktuelle Version vom 9. August 2013, 08:49 Uhr

Inhaltsverzeichnis

Functionality

Adds new concepts to the specified and existing code system version.

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 1..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)
code_system_concept code_system_concept 1..1 Displays a concept or term. Specialization of code_system_entity_version.
code String 100 1..1 Code of a concept or term.
isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
term String 65535 1..1 The term itself
termAbbrevation String 50 0..1 The abbrevation of the term.
code_system_concept_translation code_system_concept_translation 0..N Translation of a term
languageId Long 1..1 Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)
term String 65535 1..1 Translated term
termAbbrevation String 50 0..1 Abbreviation of the translated term.
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
code_system_version_entity_membership code_system_version_entity_membership 0..1 Connects the version of a Code System to the entities.
isAxis Boolean 1..1 true, if the belonging entity of the entry is an axis of the code system
isMainClass Boolean 1..1 true, if the belonging entity of the entry is a root element of the code system.

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

Annotations

Noteworthiness

Hints

Examples

SOAP messages

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <aut:CreateConcept>
         <parameter>
            <codeSystem>   
               <id>1</id>
               <codeSystemVersions>
 		    <versionId>1</versionId>
               </codeSystemVersions>              
	    </codeSystem>
            <codeSystemEntity>
		<codeSystemEntityVersions>
			<codeSystemConcepts>
				<code> x </code>
				<term> y </term>
 				<isPreferred>true</isPreferred>
			</codeSystemConcepts>
                </codeSystemEntityVersions>
	    </codeSystemEntity>
            <login>               
               <sessionID> xxx </sessionID>  
            </login>            
         </parameter>
      </aut:CreateConcept>
   </soapenv:Body>
</soapenv:Envelope

Code examples

Java

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