WS-Beschreibung - Terminologieserver Authoring MaintainConcept
Aus Termserver-CTS2
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>
