Terminologieserver - Authoring - CreateConcept
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Muetzner (Diskussion | Beiträge)
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
Zum nächsten Versionsunterschied →
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
Zum nächsten Versionsunterschied →
Version vom 22. Juli 2014, 07:27 Uhr
zurück zur Webservice-Übersicht
Request/Response
Request
Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|---|
1 | LoginType | LoginType | 0..1 | Login information | |
2 | sessionID | String | 1..1 | Session-ID from user (given by system) | |
1 | codeSystem | code_system | 1..1 | Name of codesystem. Each codesystem requires at least one version. | |
2 | id | Long | 1..1 | Internal ID = Primary Key of Code System | |
2 | codeSystemVersion | code_system_version | 1..1 | Version of a Code System | |
3 | versionId | Long | 1..1 | ||
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 | codeSystemConcept | code_system_concept | 1..1 | Displays a concept or term. Specialization of code_system_entity_version. | |
4 | code | String | 100 | 1..1 | Code of a concept or term. |
4 | isPreferred | Boolean | 1..1 | Specifies, if a term or concept is preferred or not. | |
4 | term | String | 65535 | 1..1 | The term itself |
4 | termAbbrevation | String | 50 | 0..1 | The abbrevation of the term. |
4 | codeSystemConceptTranslation | code_system_concept_translation | 0..N | Translation of a term | |
5 | languageId | Long | 1..1 | Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes) | |
5 | term | String | 65535 | 1..1 | Translated term |
5 | termAbbrevation | String | 50 | 0..1 | Abbreviation of the translated term. |
3 | property | property | 0..N | ||
4 | name | String | 65535 | 0..1 | |
4 | propertyVersion | property_version | 1..N | ||
5 | content | byte[] | 0..1 | ||
5 | contentMimetype | String | 50 | 0..1 | |
5 | contentName | String | 255 | 0..1 | |
5 | contentSize | Integer | 0..1 | ||
5 | description | String | 65535 | 0..1 | |
5 | languageId | Long | 0..1 | ||
5 | name | String | 65535 | 1..1 | |
5 | propertyKindId | Long | 0..1 | ||
5 | status | Integer | 0..1 | ||
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. |
Response
Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|---|
1 | ReturnType | 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 | ||
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 | currentVersionId | Long | 1..1 | Current ID of code_system_entity_version. | |
2 | id | Long | 1..1 | ||
2 | codeSystemEntityVersion | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
3 | versionId | Long | 1..1 | Version-ID of Entity-Version |