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

Aus CTS2-LE
Zur Navigation springen Zur Suche springen
(→‎DELETE service/crud/cts2/resource)
 
Zeile 24: Zeile 24:
 
:<code>200</code>: no message
 
:<code>200</code>: no message
 
:<code>500</code>: error message during update
 
:<code>500</code>: error message during update
 +
 +
 +
== <b>GET</b> service/crud/cts2/resources ==
 +
List all resources.
 +
;Request Body
 +
-
 +
 +
;Query Parameters
 +
-
 +
 +
;Responses
 +
:<code>application/json</code>
 +
<syntaxhighlight lang="JavaScript">
 +
{
 +
  "resources": [
 +
      {
 +
        "type": <one of (CodeSystemVersionCatalogEntry, ValueSetDefinition, MapVersion[MultiGroup])>,
 +
        "groupName": <group name (used in grouping.json)>,
 +
        "resourceId": <unique internal resource identifier, e.g. 'Snomed-20220331'>,
 +
        "resourceUris": [
 +
            <resource uris, e.g. 'http://snomed.info/sct', 'urn:oid:2.16.840.1.113883.6.96'>
 +
        ],
 +
        "versionId": <version identifier, e.g. '20220331'>,
 +
        "defaultVersion": <true iff this is the default version>,
 +
        "graphName": <graph name, internal>
 +
      },
 +
      ...
 +
  ]
 +
}
 +
</syntaxhighlight>
 +
 +
:<code>200</code>: <code>"message": "ok"</code>
 +
:<code>500</code>: <code>"message": "<error message>"</code>
  
  

Aktuelle Version vom 14. Juni 2022, 13:25 Uhr

GET service/manage/index/suggester/update

Updates the suggester index.

Request Body

-

Query Parameters

-

Responses
text/plain
message
200: no message
500: error message 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: error message during update


GET service/crud/cts2/resources

List all resources.

Request Body

-

Query Parameters

-

Responses
application/json
{
   "resources": [
      {
         "type": <one of (CodeSystemVersionCatalogEntry, ValueSetDefinition, MapVersion[MultiGroup])>,
         "groupName": <group name (used in grouping.json)>,
         "resourceId": <unique internal resource identifier, e.g. 'Snomed-20220331'>,
         "resourceUris": [ 
            <resource uris, e.g. 'http://snomed.info/sct', 'urn:oid:2.16.840.1.113883.6.96'>
         ],
         "versionId": <version identifier, e.g. '20220331'>,
         "defaultVersion": <true iff this is the default version>,
         "graphName": <graph name, internal>
      },
      ...
   ]
}
200: "message": "ok"
500: "message": "<error message>"


DELETE service/crud/cts2/resource

Deletes a resource (code system or value set). Afterwards a suggester update (see above) has to be called.

Request Body

-

Query Parameters
uri (type: string, occurrence: required)
uri of the resource. Note that the pair (uri, version) uniquely identifies a resource within CTS2-LE
version (type: string, occurrence: required)
version of the resource
Responses
application/json
{
   "message": "..."
}
200: "message": "ok"
500: "message": "<error message>"
Abgerufen von „https://websites.fraunhofer.de/CTS2-LE/index.php?title=CTS2-LE_REST_API:_General&oldid=1326“