Terminologieserver - Authoring - MaintainConcept
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
Zeile 1: | Zeile 1: | ||
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br> | [[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br> | ||
+ | =Beschreibung= | ||
+ | Creates new concepts or edit existing versions.<br> | ||
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
Zeile 75: | Zeile 77: | ||
<td></td> <td id="cardinality_cell">0..1</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> | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">statusWorkflow</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td>A workflow status, can be unique for each codesystem.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 97: | Zeile 106: | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
<td>It must not be listed, if existing version is worked on.</td> | <td>It must not be listed, if existing version is worked on.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">description</td> | ||
+ | <td>String</td> | ||
+ | <td></td> | ||
+ | <td id="cardinality_cell">0..1</td> | ||
+ | <td>Description of a term or concept</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 127: | Zeile 144: | ||
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
<td>Translation of a term</td> | <td>Translation of a term</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">5</td> | ||
+ | <td id="param_level5">description</td> | ||
+ | <td>String</td> | ||
+ | <td></td> | ||
+ | <td id="cardinality_cell">0..1</td> | ||
+ | <td>Description of the translated term.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 179: | Zeile 204: | ||
<td></td> <td id="cardinality_cell">1..1</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> | <td>true, if the belonging entity of the entry is a root element of the code system.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">orderNr</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td>If used, concepts are ordered by the given numbers.</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
Zeile 194: | Zeile 226: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
− | <td id="param_level1"> | + | <td id="param_level1">returnInfos</td> |
<td>ReturnType</td> | <td>ReturnType</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
Zeile 222: | Zeile 254: | ||
</tr> | </tr> | ||
</table> | </table> | ||
+ | =Beispiele= | ||
+ | ==SOAP== | ||
+ | ===Simple sample=== | ||
+ | <source lang="xml"> | ||
+ | <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> | ||
+ | <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> | ||
+ | <versioning> | ||
+ | <createNewVersion>0</createNewVersion> | ||
+ | </versioning> | ||
+ | </parameter> | ||
+ | </aut:MaintainConcept> | ||
+ | </soapenv:Body> | ||
+ | </soapenv:Envelope> | ||
+ | </source> | ||
<br><br> | <br><br> | ||
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]] | [[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]] |
Version vom 23. Juli 2014, 10:09 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Creates new concepts or edit existing versions.
Request/Response
Request
Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|---|
1 | loginToken | String | 1..1 | Login-Token that ensures the user is logged in. | |
1 | VersioningType | VersioningType | 1..1 | Versioning information | |
2 | createNewVersion | Boolean | 1..1 | true if a new version should be created | |
2 | majorUpdate | Boolean | 0..1 | true if major version should count up | |
2 | minorUpdate | Boolean | 0..1 | true if minor version should count up | |
1 | codeSystemEntity | code_system_entity | 1..1 | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
2 | codeSystemEntityVersion | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
3 | majorRevision | Integer | 0..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
3 | minorRevision | Integer | 0..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
3 | statusWorkflow | Integer | 0..1 | A workflow status, can be unique for each codesystem. | |
3 | versionId | Long | 1..1 | The ID of this entry. | |
3 | codeSystemConcept | code_system_concept | 0..1 | Displays a concept or term. Specialization of code_system_entity_version. | |
4 | code | String | 100 | 1..1 | It must not be listed, if existing version is worked on. |
4 | description | String | 0..1 | Description of a term or concept | |
4 | isPreferred | Boolean | 1..1 | It must not be listed, if existing version is worked on. | |
4 | term | String | 65535 | 1..1 | It must not be listed, if existing version is worked on. |
4 | termAbbrevation | String | 50 | 0..1 | The abbrevation of the term. |
4 | codeSystemConceptTranslation | code_system_concept_translation | 0..N | Translation of a term | |
5 | description | String | 0..1 | Description of the translated term. | |
5 | id | Long | 0..1 | It must be listed only, if an existing translation should be worked on. | |
5 | languageCd | String | 30 | 1..1 | It must not be listed, if existing version is worked on. |
5 | term | String | 65535 | 1..1 | It must not be listed, if existing version is worked on. |
5 | termAbbrevation | String | 50 | 0..1 | Abbreviation of the translated term. |
2 | codeSystemVersionEntityMembership | code_system_version_entity_membership | 0..1 | Connects the version of a Code System to the entities. | |
3 | isAxis | Boolean | 1..1 | true, if the belonging entity of the entry is an axis of the code system | |
3 | isMainClass | Boolean | 1..1 | true, if the belonging entity of the entry is a root element of the code system. | |
3 | orderNr | Long | 0..1 | If used, concepts are ordered by the given numbers. |
Response
Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|---|
1 | returnInfos | ReturnType | 1..1 | Return information | |
2 | message | String | 1..1 | an additional message | |
2 | overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
2 | status | 1..1 | OK, FAILURE |
Beispiele
SOAP
Simple sample
<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> <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> <versioning> <createNewVersion>0</createNewVersion> </versioning> </parameter> </aut:MaintainConcept> </soapenv:Body> </soapenv:Envelope>