Terminologieserver - Authoring - MaintainValueSet

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>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>
 
<tr>
 
<tr>
Zeile 79: Zeile 86:
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td>Name of the valueset.</td>
 
   <td>Name of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Status of the current entry. Can be found in a domain.</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 86: Zeile 107:
 
<td></td>  <td id="cardinality_cell">-</td>
 
<td></td>  <td id="cardinality_cell">-</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>
 
<tr>
 
<tr>
Zeile 110: Zeile 138:
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</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>
 
<tr>
 
<tr>
Zeile 124: Zeile 159:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..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>
 
<tr>
 
<tr>
Zeile 131: Zeile 173:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Validity range (German: Gültigkeitsbereich)</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>
Zeile 157: Zeile 206:
 
<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:20 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Create a new value set version or edit an existing one.

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 versioning 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 valueSet value_set 1..1 A subset of terms.Every valueset has at least one valueset-version.
2 currentVersionId Long - Points to the current version of the valueset.
2 description String 65535 0..1 Description of the valueset.
2 id Long 1..1 ID of the valueset.
2 name String 50 1..1 Name of the valueset.
2 status Integer - Status of the current entry. Can be found in a domain.
2 statusDate java.util.Date - Alteration time of the status.
2 valueSetVersion value_set_version - Represents the version of an valueset.
3 insertTimestamp java.util.Date - Timestamp of the insertion of the valueset version.
3 name String 0..1
3 oid String 0..1
3 preferredLanguageCd String 30 0..1 Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
3 previousVersionId Long - Points to the previous version.
3 releaseDate java.util.Date 0..1 Start date for the validity of the valueset version.
3 status Integer 0..1 The status of the current entry. Can be found in a domain.
3 statusDate java.util.Date - Alteration time of the status.
3 validityRange Long 0..1 Validity range (German: Gültigkeitsbereich)
3 valueSetId Long - Foreign key to the ID of the valueset.
3 versionId Long 1..1 Only mandatory, if no new version is put on.


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:MaintainValueSet>        
         <parameter>       
            <valueSet>
		<id>1</id>		
		<valueSetVersions>
		   <versionId>1</versionId>
		   <name>Changed Versionname</name>	
		</valueSetVersions>	
            </valueSet>
            <versioning>
               <createNewVersion>1</createNewVersion>
            </versioning>
            <login>              
               <sessionID>xxx</sessionID>              
            </login>       
         </parameter>
      </aut:MaintainValueSet>
   </soapenv:Body>
   </soapenv:Envelope>



zurück zur Webservice-Übersicht

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