CTS2-LE REST API: OWL TBOX Update: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
Billig (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „<b>PUT</b> /service/crud/owl : Updates an OWL ontology. If the ontology does not exist, it is created. The TBOX of the ontology is mapped to a code system ver…“) |
Billig (Diskussion | Beiträge) |
||
| (2 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 10: | Zeile 10: | ||
:<b>uri</b> (type: <code>string</code>, occurrence: <code>required</code>) | :<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 | + | ::uri of the ontology. Note that the pair (<code>uri</code>, <code>version</code>) uniquely identifies a code system version within CTS2-LE |
:<b>version</b> (type: <code>string</code>, occurrence: <code>required</code>) | :<b>version</b> (type: <code>string</code>, occurrence: <code>required</code>) | ||
::version of the ontology | ::version of the ontology | ||
| + | |||
| + | :<b>isDefaultVersion</b> (type: <code>boolean</code>, occurrence: <code>optional</code>, default: <code>true</code>) | ||
| + | ::this version is the default version of the ontology | ||
:<b>resourceId</b> (type: <code>string</code>, occurrence: <code>required</code>) | :<b>resourceId</b> (type: <code>string</code>, occurrence: <code>required</code>) | ||
| Zeile 23: | Zeile 26: | ||
:<b>defaultLanguage</b> (type: <code>string</code>, occurrence: <code>optional</code>, default: <code>en</code>) | :<b>defaultLanguage</b> (type: <code>string</code>, occurrence: <code>optional</code>, default: <code>en</code>) | ||
::default language of the ontology | ::default language of the ontology | ||
| + | |||
| + | :<b>note</b> (type: <code>string</code>, occurrence: <code>optional</code>) | ||
| + | ::ontology notes | ||
| + | |||
| + | :<b>inputFilePath</b> (type: <code>string</code>, occurrence: <code>optional</code>) | ||
| + | ::supersedes the request body with the remote file path (in docker/kubernetes/openshift context this must be a accessable volume path) | ||
;Responses | ;Responses | ||
| − | |||
:<code>application/json</code> | :<code>application/json</code> | ||
| − | :: | + | <syntaxhighlight lang="JavaScript"> |
| + | { | ||
| + | "message": "...", | ||
| + | "log": [ ... ] (optional) | ||
| + | } | ||
| + | </syntaxhighlight> | ||
| − | :<code>400, 500</code>: | + | :<code>200</code>: <code>"message": "ok"</code> |
| + | :<code>400, 500</code>: <code>"message": "<error message>"</code> | ||
Aktuelle Version vom 22. August 2022, 15:45 Uhr
PUT /service/crud/owl
- Updates an OWL ontology. If the ontology does not exist, it is created. The TBOX of the ontology is mapped to a code system version of the CTS2 information model.
- Request Body
text/plain- owl text stream
- Query Parameters
- uri (type:
string, occurrence:required)- uri of the ontology. Note that the pair (
uri,version) uniquely identifies a code system version within CTS2-LE
- uri of the ontology. Note that the pair (
- version (type:
string, occurrence:required)- version of the ontology
- isDefaultVersion (type:
boolean, occurrence:optional, default:true)- this version is the default version of the ontology
- resourceId (type:
string, occurrence:required)- unique CTS2-LE identifier (not an URI) of the code system version (also displayed in the navigator)
- groupName (type:
string, occurrence:required)- group corresponding to the terminology tree in the navigator
- defaultLanguage (type:
string, occurrence:optional, default:en)- default language of the ontology
- note (type:
string, occurrence:optional)- ontology notes
- inputFilePath (type:
string, occurrence:optional)- supersedes the request body with the remote file path (in docker/kubernetes/openshift context this must be a accessable volume path)
- Responses
application/json
{
"message": "...",
"log": [ ... ] (optional)
}
200:"message": "ok"400, 500:"message": "<error message>"
