Terminologieserver - Authoring - MaintainConcept

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
Zeile 56: Zeile 56:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 
   <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Current ID of code_system_entity_version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 63: Zeile 77:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Foreign key to code system entities ID</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">effectiveDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Last change date of the entity version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point in time when entry was inserted.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">isLeaf</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 77: Zeile 119:
 
<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 id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Refers to the prior version, if there are more than one version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivated</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivatedDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Date when statusDeactivated changed</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusVisibility</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Status of the current entry. Can be taken from a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusVisibilityDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point of time of the last change of the status.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 84: Zeile 161:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>A workflow status, can be unique for each codesystem.</td>
 
   <td>A workflow status, can be unique for each codesystem.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflowDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Date when statusWorkflow changed</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 106: Zeile 190:
 
   <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 id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 144: Zeile 235:
 
<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 id="gray">
 +
  <td id="cardinality_cell">5</td>
 +
  <td id="param_level5">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 190: Zeile 288:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Connects the version of a Code System to the entities.</td>
 
   <td>Connects the version of a Code System to the entities.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 230: Zeile 342:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Return information</td>
 
   <td>Return information</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">count</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>number of results</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>

Version vom 30. September 2014, 12:19 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 currentVersionId Long - Current ID of code_system_entity_version.
2 id Long -
2 codeSystemEntityVersion code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
3 codeSystemEntityId Long - Foreign key to code system entities ID
3 effectiveDate java.util.Date - Last change date of the entity version.
3 insertTimestamp java.util.Date - Point in time when entry was inserted.
3 isLeaf Boolean - Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only.
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 previousVersionId Long - Refers to the prior version, if there are more than one version.
3 statusDeactivated Integer - Defines the state. Default value is 0 (=visible). Look for available values in the according domain.
3 statusDeactivatedDate java.util.Date - Date when statusDeactivated changed
3 statusVisibility Integer - Status of the current entry. Can be taken from a domain.
3 statusVisibilityDate java.util.Date - Point of time of the last change of the status.
3 statusWorkflow Integer 0..1 A workflow status, can be unique for each codesystem.
3 statusWorkflowDate java.util.Date - Date when statusWorkflow changed
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 codeSystemEntityVersionId Long -
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 codeSystemEntityVersionId Long -
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 codeSystemEntityId Long -
3 codeSystemVersionId Long -
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 count Integer - number of results
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>



zurück zur Webservice-Übersicht

Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=Terminologieserver_-_Authoring_-_MaintainConcept“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge