CTS2-LE ClaML API: Update

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 Wiki 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 as outlined in the following section

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

Example Request

POST /WebCts2LE/service/crud/claml/update?groupName=EXA&defaultLanguage=de&resourceId=Test-Codesystem-v1&isSVSOrigin=true&version=v1
with body:

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <?xml version="1.0" encoding="UTF-8"?>
 3 <ClaML version="2.0.0">
 4     <Meta name="description" value="Das ist ein Test-Codesystem!"/>
 5     <Meta name="description_eng" value="This is a test code system!"/>
 6     <Meta name="website" value="website CS test"/>
 7     <Meta name="version_description" value=""/>
 8     <Meta name="insert_ts" value="2017-05-02 09:53:20.0"/>
 9     <Meta name="status_date" value="2017-05-02 09:53:21.0"/>
10     <Meta name="expiration_date" value=""/>
11     <Meta name="last_change_date" value="2017-05-02 09:53:21.0"/>
12     <Meta name="unvollstaendig" value="false"/>
13     <Meta name="verantw_Org" value=""/>
14     <Meta name="gueltigkeitsbereich" value="empfohlen"/>
15     <Meta name="statusCode" value="0"/>
16     <Identifier uid="1.2.40.0.34.99.1212"/>
17     <Title date="2017-01-01" name="Test-Codesystem" version="">Das ist ein Test-Codesystem!</Title>
18     <RubricKinds>
19         <RubricKind inherited="false" name="note"/>
20         <RubricKind inherited="false" name="preferred"/>
21     </RubricKinds>
22     <Class code="code test">
23         <Meta name="Level" value="0"/>
24         <Meta name="Type" value="S"/>
25         <Meta name="Relationships" value="relationships CS test"/>
26         <Meta name="TS_ATTRIBUTE_HINTS" value="Hinweise CS test"/>
27         <Meta name="TS_ATTRIBUTE_MEANING" value="deutsch CS test"/>
28         <Meta name="TS_ATTRIBUTE_ISLEAF" value="true"/>
29         <Meta name="TS_ATTRIBUTE_STATUS" value="1"/>
30         <Meta name="TS_ATTRIBUTE_STATUSDATE" value="2017-05-02"/>
31         <Rubric kind="preferred">
32             <Label>displyName CS test</Label>
33         </Rubric>
34         <Rubric kind="note">
35             <Label>concept_beschreibung CS test</Label>
36         </Rubric>
37     </Class>
38 </ClaML>