WS-Beschreibung - Terminologieserver Authoring MaintainConcept
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Becker (Diskussion | Beiträge) (→Funktionalität) |
Becker (Diskussion | Beiträge) |
||
(7 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | + | =Functionality= | |
− | + | Creates new concepts or edit existing versions. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | = | + | =Prerequisites= |
− | + | Requires [[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. | ||
− | + | Requires fields: create new version | |
− | + | * name | |
− | + | * term | |
+ | * isPreferred | ||
− | = | + | Required fields: edit version |
− | == | + | * codeSystemEntityId |
− | + | * codeSystemEntityVersionId | |
+ | ==Request== | ||
+ | <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">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">code_system_concept</td> | ||
+ | <td>code_system_concept</td> | ||
+ | <td></td> <td id="cardinality_cell">0..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>100</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>It must not be listed, if existing version is worked on.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">isPreferred</td> | ||
+ | <td>Boolean</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>It must not be listed, if existing version is worked on.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">term</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>It must not be listed, if existing version is worked on.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">termAbbrevation</td> | ||
+ | <td>String</td> | ||
+ | <td>50</td> | ||
+ | <td id="cardinality_cell">0..1</td> | ||
+ | <td>The abbrevation of the term.</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level4">code_system_concept_translation</td> | ||
+ | <td>code_system_concept_translation</td> | ||
+ | <td></td> <td id="cardinality_cell">0..N</td> | ||
+ | <td>Translation of a term</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">id</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td>It must be listed only, if an existing translation should be worked on.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">languageId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>It must not be listed, if existing version is worked on.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">term</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>It must not be listed, if existing version is worked on.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">termAbbrevation</td> | ||
+ | <td>String</td> | ||
+ | <td>50</td> | ||
+ | <td id="cardinality_cell">0..1</td> | ||
+ | <td>Abbreviation of the translated term.</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 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></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> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level2">code_system_version_entity_membership</td> | ||
+ | <td>code_system_version_entity_membership</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td>Connects the version of a Code System to the entities.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <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ä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></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> | ||
+ | |||
+ | =Annotations= | ||
+ | ==Noteworthiness== | ||
+ | ==Hints== | ||
+ | |||
+ | =Examples= | ||
+ | ==SOAP messages== | ||
+ | Minimal SOAP message | ||
<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 60: | Zeile 329: | ||
</soapenv:Envelope> | </soapenv:Envelope> | ||
</source> | </source> | ||
− | ==Code | + | |
+ | ==Code examples== | ||
===Java=== | ===Java=== | ||
<source lang="java"> | <source lang="java"> | ||
</source> | </source> |
Aktuelle Version vom 9. August 2013, 09:10 Uhr
Inhaltsverzeichnis |
Functionality
Creates new concepts or edit existing versions.
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.
Requires fields: create new version
- name
- term
- isPreferred
Required fields: edit version
- codeSystemEntityId
- codeSystemEntityVersionId
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 | |
code_system_concept | code_system_concept | 0..1 | Displays a concept or term. Specialization of code_system_entity_version. | |
code | String | 100 | 1..1 | It must not be listed, if existing version is worked on. |
isPreferred | Boolean | 1..1 | It must not be listed, if existing version is worked on. | |
term | String | 65535 | 1..1 | It must not be listed, if existing version is worked on. |
termAbbrevation | String | 50 | 0..1 | The abbrevation of the term. |
code_system_concept_translation | code_system_concept_translation | 0..N | Translation of a term | |
id | Long | 0..1 | It must be listed only, if an existing translation should be worked on. | |
languageId | Long | 1..1 | It must not be listed, if existing version is worked on. | |
term | String | 65535 | 1..1 | It must not be listed, if existing version is worked on. |
termAbbrevation | String | 50 | 0..1 | Abbreviation of the translated term. |
property | property | 0..N | ||
id | Long | 1..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 | |
propertyKindId | Long | 0..1 | ||
status | Integer | 0..1 | ||
versionId | Long | 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 |
Annotations
Noteworthiness
Hints
Examples
SOAP messages
Minimal SOAP message
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:MaintainConcept> <parameter> <codeSystemEntity> <id>1</id> <codeSystemEntityVersions> <versionId>1</versionId> <codeSystemConcepts> <code>X</code> <term>Y</term> <isPreferred>1</isPreferred> </codeSystemConcepts> </codeSystemEntityVersions> </codeSystemEntity> <login> <sessionID>abc</sessionID> </login> <versioning> <createNewVersion>1</createNewVersion> </versioning> </parameter> </aut:MaintainConcept> </soapenv:Body> </soapenv:Envelope>