Terminologieserver - Authoring - UpdateConceptStatus

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
Zeile 28: Zeile 28:
 
<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 49: Zeile 35:
 
<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 id="gray">
 
−
  <td id="cardinality_cell">3</td>
 
−
  <td id="param_level3">majorRevision</td>
 
−
  <td>Integer</td>
 
−
<td></td>  <td id="cardinality_cell">-</td>
 
−
  <td>Major 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">minorRevision</td>
 
−
  <td>Integer</td>
 
−
<td></td>  <td id="cardinality_cell">-</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>
 
<tr>
 
<tr>
Zeile 105: Zeile 42:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</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>
 
<tr>
 
<tr>
Zeile 119: Zeile 49:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Status of the current entry. Can be taken from a domain.</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 133: Zeile 56:
 
<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 166: Zeile 82:
 
<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>

Aktuelle Version vom 30. September 2014, 12:31 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Update the status of a concept (code system entity version).

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 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 statusDeactivated Integer 0..1 Defines the state. Default value is 0 (=visible). Look for available values in the according domain.
3 statusVisibility Integer 0..1 Status of the current entry. Can be taken from a domain.
3 statusWorkflow Integer 0..1 A workflow status, can be unique for each codesystem.
3 versionId Long 1..1 The ID of this entry.


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 returnInfos 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

Beispiele

SOAP

Update status

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <aut:UpdateConceptStatus>
         <parameter>            
            <codeSystemEntity>             
               <codeSystemEntityVersions>
                  <versionId>4</versionId>  
                  <statusVisibility>1</statusVisibility>
                  <statusWorkflow>3</statusWorkflow>
               </codeSystemEntityVersions>              
            </codeSystemEntity>    
            <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken>
         </parameter>
      </aut:UpdateConceptStatus>
   </soapenv:Body>
</soapenv:Envelope>



zurück zur Webservice-Übersicht

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