Terminologieserver - Authoring - UpdateValueSetStatus

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>A subset of terms.Every valueset has at least one valueset-version.</td>
 
   <td>A subset of terms.Every valueset has at least one valueset-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>Points to the current version of the valueset.</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">description</td>
 
  <td>String</td>
 
  <td>65535</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Description of the valueset.</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 50: Zeile 35:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>ID of the valueset.</td>
 
   <td>ID of the valueset.</td>
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">name</td>
 
  <td>String</td>
 
  <td>50</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Name of the valueset.</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 66: Zeile 43:
 
   <td>Status of the current entry. Can be found in a domain.
 
   <td>Status of the current entry. Can be found in a domain.
 
The status is changed, if he is listed.</td>
 
The status is changed, if he is listed.</td>
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">statusDate</td>
 
  <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Alteration time of the status.</td>
 
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 80: Zeile 50:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Represents  the version of an valueset.</td>
 
   <td>Represents  the version of an valueset.</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>Timestamp of the insertion of the valueset version.</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">name</td>
 
  <td>String</td>
 
  <td></td>
 
  <td id="cardinality_cell">-</td>
 
  <td></td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">oid</td>
 
  <td>String</td>
 
  <td></td>
 
  <td id="cardinality_cell">-</td>
 
  <td></td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">preferredLanguageCd</td>
 
  <td>String</td>
 
  <td>30</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</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>Points to the previous version.</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">releaseDate</td>
 
  <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Start date for the validity of the valueset version.</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 132: Zeile 57:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>The status of the current entry. Can be found in a domain.</td>
 
   <td>The status of the current entry. Can be found in a domain.</td>
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">statusDate</td>
 
  <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Alteration time of the status.</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">validityRange</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Validity range (German: Gültigkeitsbereich)</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">valueSetId</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Foreign key to the ID of the valueset.</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>

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

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Edit the status of a value set or value set 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 valueSet value_set 1..1 A subset of terms.Every valueset has at least one valueset-version.
2 id Long 1..1 ID of the valueset.
2 status Integer 0..1 Status of the current entry. Can be found in a domain. The status is changed, if he is listed.
2 valueSetVersion value_set_version 0..1 Represents the version of an valueset.
3 status Integer 1..1 The status of the current entry. Can be found in a domain.
3 versionId Long 1..1 Version ID of the value set


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 returnInfos ReturnType 1..1 Return information
2 count Integer 1..1 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

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:UpdateValueSetStatus>
         <parameter>            
            <valueSet>   
               <status>1</status>
               <id>1</id>          
               <valueSetVersions>
                  <versionId>4</versionId>  
                  <status>1</status>
               </valueSetVersions>           
            </valueSet>    
            <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken>
         </parameter>
      </aut:UpdateValueSetStatus>
   </soapenv:Body>
</soapenv:Envelope>



zurück zur Webservice-Übersicht

Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge