WS-Beschreibung - Terminologieserver Search ReturnConceptAssociationTypeDetails
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Lists all properties and association type (with details) of the given concept. See request/response section for a list of details returned.
Prerequisites
Request/Response
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) | |
| 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. | |
| versionId | Long | 1..1 | Version-ID of Entity-Version |
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 | ||
| 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. | |
| currentVersionId | Long | 1..1 | Current ID of code_system_entity_version. | |
| id | Long | 1..1 | ||
| code_system_entity_version | code_system_entity_version | 0..N | code_system_entity_version is the superclass of every Concept and Association. | |
| effectiveDate | java.util.Date | 1..1 | Point in time of the last change. | |
| insertTimestamp | java.util.Date | 1..1 | Point in time, when entry was inserted. | |
| isLeaf | Boolean | 1..1 | Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only. | |
| majorRevision | Integer | 1..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
| minorRevision | Integer | 1..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
| previousVersionId | Long | 1..1 | Refers to the prior version, if there are more than one version. | |
| status | Integer | 1..1 | Status of the current entry. Can be taken from a domain. | |
| statusDate | java.util.Date | 1..1 | Point of time of the last change of the status. | |
| versionId | Long | 1..1 | Version-ID of Entity-Version | |
| association_type | association_type | 1..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 | ||
| currentVersionId | Long | 1..1 | ||
| id | Long | 1..1 | ||
| property_version | property_version | 1..N | ||
| content | byte[] | 1..1 | ||
| contentMimetype | String | 50 | 1..1 | |
| contentName | String | 255 | 1..1 | |
| contentSize | Integer | 1..1 | ||
| description | String | 65535 | 1..1 | |
| insertTimestamp | java.util.Date | 1..1 | ||
| languageId | Long | 1..1 | ||
| name | String | 65535 | 1..1 | |
| previousVersionId | Long | 1..1 | ||
| propertyKindId | Long | 1..1 | ||
| status | Integer | 1..1 | ||
| statusDate | java.util.Date | 1..1 | ||
| versionId | Long | 1..1 |
Annotations
Noteworthiness
Hints
Typically the result set is small.
Examples
SOAP messages
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ReturnConceptAssociationTypeDetails> <parameter> <codeSystemEntity> <codeSystemEntityVersion> <versionId>17</versionId> </codeSystemEntityVersion> </codeSystemEntity> </parameter> </sear:ReturnConceptAssociationTypeDetails> </soapenv:Body> </soapenv:Envelope>
