CTS2-LE REST API: General: Unterschied zwischen den Versionen

Aus CTS2-LE
Zur Navigation springen Zur Suche springen
Zeile 3: Zeile 3:
 
;Request Body
 
;Request Body
 
-
 
-
 +
;Query Parameters
 +
-
 +
;Responses
 +
:<code>text/plain</code>
 +
::message
 +
 +
:<code>200</code>: no message
 +
:<code>500</code>: errors during update
 +
 +
== <b>GET</b> service/manage/index/update ==
 +
Updates the search index for code systems.
 +
;Request Body
 +
-
 +
;Query Parameters
 +
-
 +
;Responses
 +
:<code>text/plain</code>
 +
::message
 +
 +
:<code>200</code>: no message
 +
:<code>500</code>: errors during update
 +
 +
 +
== <b>DELETE</b> service/crud/cts2/resource ==
 +
Deletes a resource (code system or value set).
 +
;Request Body
 +
-
 +
 
;Query Parameters
 
;Query Parameters
-
+
 
 +
:<b>uri</b> (type: <code>string</code>, occurrence: <code>required</code>)
 +
::uri of the ontology. Note that the pair (<code>uri</code>, <code>version</code>) uniquely defines a code system version within CTS2-LE
 +
 
 +
:<b>version</b> (type: <code>string</code>, occurrence: <code>required</code>)
 +
::version of the ontology
 +
 
 
;Responses
 
;Responses
:<code>200</code>: ok
+
:<code>application/json</code>
 +
::message
 +
 
 +
:<code>200</code>: no message
 
:<code>500</code>: errors during update
 
:<code>500</code>: errors during update
 +
 +
<syntaxhighlight lang="JSON">
 +
{
 +
  "message": "ok",
 +
  "log": [
 +
      "resource removed",
 +
      "resource related index cleared"
 +
  ]
 +
}
 +
</syntaxhighlight>

Version vom 17. September 2019, 16:17 Uhr

GET service/manage/index/suggester/update

Updates the suggester index.

Request Body

-

Query Parameters

-

Responses
text/plain
message
200: no message
500: errors during update

GET service/manage/index/update

Updates the search index for code systems.

Request Body

-

Query Parameters

-

Responses
text/plain
message
200: no message
500: errors during update


DELETE service/crud/cts2/resource

Deletes a resource (code system or value set).

Request Body

-

Query Parameters
uri (type: string, occurrence: required)
uri of the ontology. Note that the pair (uri, version) uniquely defines a code system version within CTS2-LE
version (type: string, occurrence: required)
version of the ontology
Responses
application/json
message
200: no message
500: errors during update
{
   "message": "ok",
   "log": [
      "resource removed",
      "resource related index cleared"
   ]
}