WS-Beschreibung - Terminologieserver Authoring MaintainConceptAssociationType
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Create a new or edit a existing association. Association type, properties and their versions can be edited or created.
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.
Required fields: new version
Required fields: edit version
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 | |
| association_type | association_type | 0..1 | Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version | |
| forwardName | String | 50 | 1..1 | Name of association in normal reading direction (ID 1->2) |
| reverseName | String | 50 | 1..1 | Name of association in reversed reading direction (ID 2->1) |
| property | property | 0..N | ||
| id | Long | 1..1 | ||
| 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 | 0..1 | Mandatory, if versionId is not listed. |
| propertyKindId | Long | 0..1 | ||
| status | Integer | 0..1 | ||
| versionId | Long | 0..1 |
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 |
