CTS2-LE REST API: OWL Update: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
Billig (Diskussion | Beiträge) (→Operation Syntax) |
Billig (Diskussion | Beiträge) |
||
| Zeile 1: | Zeile 1: | ||
== Operation Syntax == | == Operation Syntax == | ||
| + | |||
| + | Updates an OWL ontology. If the ontology does not exist, it is created. The ontology is mapped to a code system version of the CTS2 information model. | ||
;Signature | ;Signature | ||
:Response webCts2Le.service.crud.OwlResource.update( | :Response webCts2Le.service.crud.OwlResource.update( | ||
| − | ::@QueryParam(value="uri") String uri, | + | ::@QueryParam(value="uri") String uri, |
| − | ::@QueryParam(value="version") String version, | + | ::@QueryParam(value="version") String version, |
| − | ::@QueryParam(value="isDefaultVersion") @DefaultValue(value="true") boolean isDefaultVersion, | + | ::@QueryParam(value="isDefaultVersion") @DefaultValue(value="true") boolean isDefaultVersion, |
| − | ::@QueryParam(value="resourceId") String resourceId, | + | ::@QueryParam(value="resourceId") String resourceId, |
| − | ::@QueryParam(value="groupName") String groupName, | + | ::@QueryParam(value="groupName") String groupName, |
| − | ::@QueryParam(value="defaultLanguage") @DefaultValue(value="en") String defaultLanguage, | + | ::@QueryParam(value="defaultLanguage") @DefaultValue(value="en") String defaultLanguage, |
::@QueryParam(value="mappingSpec") String mappingSpec) | ::@QueryParam(value="mappingSpec") String mappingSpec) | ||
:@POST | :@POST | ||
| Zeile 15: | Zeile 17: | ||
:@Consumes(value={"application/xml"}) | :@Consumes(value={"application/xml"}) | ||
:@Produces(value={"application/xml"}) | :@Produces(value={"application/xml"}) | ||
| + | |||
| + | |||
;Parameters | ;Parameters | ||
:<code>uri</code> | :<code>uri</code> | ||
| − | ::uri of the ontology. Note that the pair ( | + | ::uri of the ontology. Note that the pair (<code>uri</code>, <code>version</code>) uniquely defines a code system version within CTS2-LE |
| − | ::Cardinality: 1..1 | + | ::<code>Cardinality: 1..1</code> |
:<code>version</code> | :<code>version</code> | ||
| − | ::version of the ontology | + | ::version of the ontology |
| − | ::Cardinality: 1..1 | + | ::<code>Cardinality: 1..1</code> |
| − | :<code>isDefaultVersion </code> | + | :<code>isDefaultVersion</code> |
| − | :: | + | ::store as default version |
| + | ::<code>Cardinality: 0..1</code> | ||
:<code>resourceId</code> | :<code>resourceId</code> | ||
| − | ::unique CTS2-LE identifier (not an URI) of the | + | ::unique CTS2-LE identifier (not an URI) of the code system version (also displayed in the navigator) |
| − | ::Cardinality: 1..1 | + | ::<code>Cardinality: 1..1</code> |
:<code>groupName</code> | :<code>groupName</code> | ||
| − | ::group corresponding to the terminology tree in the navigator | + | ::group corresponding to the terminology tree in the navigator |
| + | ::<code>Cardinality: 0..1</code> | ||
:<code>defaultLanguage</code> | :<code>defaultLanguage</code> | ||
| − | ::default language of the | + | ::default language of the code system version |
| + | ::<code>Cardinality: 0..1</code> | ||
:<code>mappingSpec</code> | :<code>mappingSpec</code> | ||
| − | ::TODO | + | ::TODO |
| + | ::<code>Cardinality: 0..1</code> | ||
;Consumed POST Body | ;Consumed POST Body | ||
Version vom 12. Oktober 2016, 15:46 Uhr
Operation Syntax
Updates an OWL ontology. If the ontology does not exist, it is created. The ontology is mapped to a code system version of the CTS2 information model.
- Signature
- Response webCts2Le.service.crud.OwlResource.update(
- @QueryParam(value="uri") String uri,
- @QueryParam(value="version") String version,
- @QueryParam(value="isDefaultVersion") @DefaultValue(value="true") boolean isDefaultVersion,
- @QueryParam(value="resourceId") String resourceId,
- @QueryParam(value="groupName") String groupName,
- @QueryParam(value="defaultLanguage") @DefaultValue(value="en") String defaultLanguage,
- @QueryParam(value="mappingSpec") String mappingSpec)
- @POST
- @Path(value="/service/crud/owl/update")
- @Consumes(value={"application/xml"})
- @Produces(value={"application/xml"})
- Parameters
uri- uri of the ontology. Note that the pair (
uri,version) uniquely defines a code system version within CTS2-LE Cardinality: 1..1
- uri of the ontology. Note that the pair (
version- version of the ontology
Cardinality: 1..1
isDefaultVersion- store as default version
Cardinality: 0..1
resourceId- unique CTS2-LE identifier (not an URI) of the code system version (also displayed in the navigator)
Cardinality: 1..1
groupName- group corresponding to the terminology tree in the navigator
Cardinality: 0..1
defaultLanguage- default language of the code system version
Cardinality: 0..1
mappingSpec- TODO
Cardinality: 0..1
- Consumed POST Body
OWL stream.
- Cardinality: 1..1
- Result
- empty response if no error occurs otherwise an error XML.
