CTS2-LE ClaML API: Update: Unterschied zwischen den Versionen

Aus CTS2-LE
Zur Navigation springen Zur Suche springen
K
 
(2 dazwischenliegende Versionen von einem anderen Benutzer werden nicht angezeigt)
Zeile 7: Zeile 7:
 
;Request Body
 
;Request Body
 
:<code>application/xml</code>
 
:<code>application/xml</code>
−
:XML input stream as outlined in the following section
+
:XML input stream in ClaML format
 
;Parameters
 
;Parameters
 
:<b>resourceId</b> (type: <code>string</code>, occurence: <code>optional</code>) uniquely identifies a resource; if not defined, the XML input attribute <code>/ClaML/Title/@name</code> will be used  
 
:<b>resourceId</b> (type: <code>string</code>, occurence: <code>optional</code>) uniquely identifies a resource; if not defined, the XML input attribute <code>/ClaML/Title/@name</code> will be used  
Zeile 21: Zeile 21:
 
:<code>409</code> errors specified in XML
 
:<code>409</code> errors specified in XML
  
−
 
+
<!--
 
== Example Request ==
 
== Example Request ==
−
<b>POST</b> /WebCts2LE/service/crud/claml/update?groupName=EXA&defaultLanguage=de&resourceId=Test-Codesystem-v1&isSVSOrigin=true&version=v1<br>
+
<b>POST</b> /WebCts2LE/service/crud/claml/update?groupName=EXA&defaultLanguage=de&resourceId=Test-Codesystem&version=v1<br>
 
<b>with body:</b>
 
<b>with body:</b>
 
<syntaxhighlight lang="xml" line="GESHI_NORMAL_LINE_NUMBERS">
 
<syntaxhighlight lang="xml" line="GESHI_NORMAL_LINE_NUMBERS">
−
<?xml version="1.0" encoding="UTF-8"?>
 
−
<?xml version="1.0" encoding="UTF-8"?>
 
 
<ClaML version="2.0.0">
 
<ClaML version="2.0.0">
−
    <Meta name="description" value="Das ist ein Test-Codesystem!"/>
+
  <Identifier uid="1.2.40.0.34.99.1212" />
−
    <Meta name="description_eng" value="This is a test code system!"/>
+
  <Title version="v1" date="2017-01-01" name="Test-Codesystem" />
−
    <Meta name="website" value="website CS test"/>
+
  <RubricKinds>
−
    <Meta name="version_description" value=""/>
+
    <RubricKind inherited="false" name="note" />
−
    <Meta name="insert_ts" value="2017-05-02 09:53:20.0"/>
+
    <RubricKind inherited="false" name="preferred" />
−
    <Meta name="status_date" value="2017-05-02 09:53:21.0"/>
+
     <RubricKind inherited="false" name="text" />
−
    <Meta name="expiration_date" value=""/>
+
  </RubricKinds>
−
    <Meta name="last_change_date" value="2017-05-02 09:53:21.0"/>
+
 
−
    <Meta name="unvollstaendig" value="false"/>
+
<Class code="code test">
−
    <Meta name="verantw_Org" value=""/>
+
  <Rubric kind="preferred">
−
    <Meta name="gueltigkeitsbereich" value="empfohlen"/>
+
    <Label>display name</Label>
−
    <Meta name="statusCode" value="0"/>
+
  </Rubric>
−
    <Identifier uid="1.2.40.0.34.99.1212"/>
+
  <Rubric kind="text">
−
    <Title date="2017-01-01" name="Test-Codesystem" version="">Das ist ein Test-Codesystem!</Title>
+
    <Label>example note</Label>
−
    <RubricKinds>
+
  </Rubric>
−
        <RubricKind inherited="false" name="note"/>
+
  <Rubric kind="note">
−
        <RubricKind inherited="false" name="preferred"/>
+
    <Label>another fancy example note</Label>
−
     </RubricKinds>
+
  </Rubric>
−
    <Class code="code test">
+
</Class>
−
        <Meta name="Level" value="0"/>
+
 
−
        <Meta name="Type" value="S"/>
 
−
        <Meta name="Relationships" value="relationships CS test"/>
 
−
        <Meta name="TS_ATTRIBUTE_HINTS" value="Hinweise CS test"/>
 
−
        <Meta name="TS_ATTRIBUTE_MEANING" value="deutsch CS test"/>
 
−
        <Meta name="TS_ATTRIBUTE_ISLEAF" value="true"/>
 
−
        <Meta name="TS_ATTRIBUTE_STATUS" value="1"/>
 
−
        <Meta name="TS_ATTRIBUTE_STATUSDATE" value="2017-05-02"/>
 
−
        <Rubric kind="preferred">
 
−
            <Label>displyName CS test</Label>
 
−
        </Rubric>
 
−
        <Rubric kind="note">
 
−
            <Label>concept_beschreibung CS test</Label>
 
−
        </Rubric>
 
−
    </Class>
 
 
</ClaML>
 
</ClaML>
  
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
-->

Aktuelle Version vom 13. Januar 2021, 20:58 Uhr

CTS2-LE provides an interface for importing terminological resources that are stuctured in Classification MarkUp Language (ClaML). For further information on ClaML please visit the wikipedia page or the documentation provided by DIMDI.


Operation Syntax

POST /WebCts2LE/service/crud/claml/update

Updates a code system. If the resource does not exist, it is created.
Request Body
application/xml
XML input stream in ClaML format
Parameters
resourceId (type: string, occurence: optional) uniquely identifies a resource; if not defined, the XML input attribute /ClaML/Title/@name will be used
version (type: string, occurence: optional) the version of the resource; if not defined, the XML input attribute /ClaML/Title/@version will be used
groupName (type: string, occurence: mandatory) determines the group to which the resource will belong; this is essential for displaying the resource in the navigator
defaultLanguage (type: string, occurence: mandatory) the default language of the resource
isDefaultVersion (type: boolean, occurence: optional, default is true) label the resource as the default version
isSVSOrigin (type: boolean, occurence: optional, default is false) distinguishes a code system that has certain attributes which are specific for SVS (Sharing Value Sets) resources
Responses
application/xml
200 no errors
409 errors specified in XML


Abgerufen von „https://websites.fraunhofer.de/CTS2-LE/index.php?title=CTS2-LE_ClaML_API:_Update&oldid=1268“