xOWL Triple Store API documentation version v1
https://localhost:3443/api/v1
/me
Represents the current user in its interaction with the server
Gets the data representing the currently logged user
get /me
Gets the data representing the currently logged user
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
A description of the currently logged-in user
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLUser"
}Examples:
{ "type": "org.xowl.infra.server.api.XOWLUser", "name": "user" }
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 440
The user session has expired.
Action for a user to log on the server
Tries to login on the server
post /me/login
Tries to login on the server
Query Parameters
- Login: required (string)
The login to use
Examples:
admin
Body
Media type: text/plain
Type: string
Examples:
myPassword01HTTP status code 200
The operation succeeded
Headers
- Set-Cookie: required (string)
The authentication token that can be used later to authenticate for further operations
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
The login operation failed
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Action for a user to log out of the server
Tries to logout from the server
post /me/logout
Tries to logout from the server
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The operation succeeded
Headers
- Set-Cookie: required (string)
Resets the authentication token
Examples:
__Secure-xOWL-Token-v1=; Max-Age=0
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 440
The user session has expired.
/server
Represents the server
Represents the product that describes this server
Gets the description of the product for this server
get /server/product
Gets the description of the product for this server
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The description of the product for this server
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/Product"
}Examples:
{
"type": "fr.cenotelie.commons.utils.product.Product",
"identifier": "org.xowl.infra.server.TripleStoreServer",
"name": "xOWL Triple Store Server",
"description": "Description for the product",
"version": {
"number": "2.0.0",
"scmTag": "ffffffff",
"buildUser": "jenkins",
"buildTag": "jenkins-xxx-42",
"buildTimestamp": "01/01/2010 10:10"
},
"copyright": "Copyright (c) Association Cénotélie",
"iconName": "",
"iconContent: "",
"vendor": "Association Cénotélie",
"vendorLink": "http://cenotelie.fr",
"link": "http://xowl.org",
"license": {
"name": "LGPLv3",
"fullText": "..."
}
}
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Represents the dependencies embedded by this product
Gets the dependencies embedded by this product
get /server/product/dependencies
Gets the dependencies embedded by this product
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The dependencies embedded by this product
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/EmbeddedDependencies"
}Examples:
[
{
"type": "fr.cenotelie.commons.utils.product.EmbeddedDependency",
"identifier": "fr.cenotelie.hime.redist",
"name": "Hime Runtime",
"contentType": "Java",
"version": "2.0.6",
"copyright": "Copyright (c) 2016 Laurent Wouters",
"link": "https://bitbucket.org/laurentw/hime",
"license": {
"name": "LGPLv3",
"fullText": "..."
}
}
]
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Action to shutdown the server
Attempts to shutdown the server
post /server/shutdown
Attempts to shutdown the server
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The server is shutting down
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Action to restart the server
Attempts to restart the server
post /server/restart
Attempts to restart the server
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The server is restarting
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Action to grant server administrative privileges to a user
Grants the server administration privilege to a user
post /server/grantAdmin
Grants the server administration privilege to a user
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Query Parameters
- User: required (string)
The identifier of the user to which administration privilege shall be granted
Examples:
user01
HTTP status code 200
The privilege has been granted
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Action to revoke server administrative privileges from a user
Revokes the server administration privilege from a user
post /server/revokeAdmin
Revokes the server administration privilege from a user
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Query Parameters
- User: required (string)
The identifier of the user from which the administration privilege shall be revoked
Examples:
user01
HTTP status code 200
The privilege has been revoked
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
/databases
The collection of databases on the server
Gets the list of the databases on the server that can be accessed by the currently logged-in user
get /databases
Gets the list of the databases on the server that can be accessed by the currently logged-in user
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns a list of the databases
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLDatabases"
}Examples:
[ {"type": "org.xowl.infra.server.api.XOWLDatabase", "name": "db1"}, {"type": "org.xowl.infra.server.api.XOWLDatabase", "name": "db2"} ]
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
A specific database on the server
Gets the description of the database
Creates the corresponding database
Drops (delete) this database
Uploads raw data to the database
get /databases/{dbId}
Gets the description of the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns the description of the database
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLDatabase"
}Examples:
{"type": "org.xowl.infra.server.api.XOWLDatabase", "name": "db1"}
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
put /databases/{dbId}
Creates the corresponding database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns the created database
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLDatabase"
}Examples:
{"type": "org.xowl.infra.server.api.XOWLDatabase", "name": "db1"}
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
delete /databases/{dbId}
Drops (delete) this database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The database has been dropped
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
post /databases/{dbId}
Uploads raw data to the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Body
Media type: application/n-triples
Type: object
Media type: application/n-quads
Type: object
Media type: text/turtle
Type: object
Media type: application/rdf+xml
Type: object
Media type: application/ld+json
Type: object
Media type: application/trig
Type: object
Media type: text/owl-functional
Type: object
Media type: application/owl+xml
Type: object
Media type: application/x-xowl-rdft
Type: object
Media type: application/x-xowl
Type: object
HTTP status code 200
The data has been inserted
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
The metric defition for the statistics of the database
Gets the metric definition for the statistics of the database
get /databases/{dbId}/metric
Gets the metric definition for the statistics of the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns the definition of the metric for the statistics of the database
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/Metric"
}HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
The statistics of the database
Gets the statistics of the database
get /databases/{dbId}/statistics
Gets the statistics of the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns a snapshot of the statistics of the database
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/MetricSnapshot"
}HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
The SPARQL endpoint for the database
Executes a SPARQL query on the database
Executes a SPARQL quert on the database
get /databases/{dbId}/sparql
Executes a SPARQL query on the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Query Parameters
- Query: required (string)
The SPARQL query to be executed
Examples:
SELECT ?c WHERE { GRAPH ?g { ?x a ?c } } - URIs for default graph: (array)
The URIs for the default graph
Examples:
[ "http://example.com/graph1" ] - URIs for named graph: (array)
The URIs for the named graph
Examples:
[ "http://example.com/graph1" ]
HTTP status code 200
The result for the SPARQL query
Body
Media type: application/n-triples
Type: object
Media type: application/n-quads
Type: object
Media type: text/turtle
Type: object
Media type: application/rdf+xml
Type: object
Media type: application/ld+json
Type: object
Media type: application/trig
Type: object
Media type: application/sparql-results+xml
Type: object
Media type: application/sparql-results+json
Type: object
Media type: text/csv
Type: object
Media type: text/tab-separated-values
Type: object
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 461
The SPARQL query failed
Body
Media type: text/plain
Type: object
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
post /databases/{dbId}/sparql
Executes a SPARQL quert on the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Query Parameters
- URIs for default graph: (array)
The URIs for the default graph
Examples:
[ "http://example.com/graph1" ] - URIs for named graph: (array)
The URIs for the named graph
Examples:
[ "http://example.com/graph1" ]
Body
Media type: application/sparql-query
Type: string
Examples:
SELECT ?c WHERE { GRAPH ?g { ?x a ?c } }HTTP status code 200
The result for the SPARQL query
Body
Media type: application/n-triples
Type: object
Media type: application/n-quads
Type: object
Media type: text/turtle
Type: object
Media type: application/rdf+xml
Type: object
Media type: application/ld+json
Type: object
Media type: application/trig
Type: object
Media type: application/sparql-results+xml
Type: object
Media type: application/sparql-results+json
Type: object
Media type: text/csv
Type: object
Media type: text/tab-separated-values
Type: object
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 461
The SPARQL query failed
Body
Media type: text/plain
Type: object
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
The entailment regime for the database
Gets the current entailment regime for the database
Sets the entailment regime for the database
Resets the entailment regime to 'none'
get /databases/{dbId}/entailment
Gets the current entailment regime for the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns the current entailment regime for the database, one of: "none", "simple", "RDF", "RDFS", "OWL2_RDF", "OWL2_DIRECT"
Body
Media type: text/plain
Type: string
Examples:
simpleHTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
put /databases/{dbId}/entailment
Sets the entailment regime for the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Body
Media type: text/plain
Type: string
Examples:
OWL2_RDFHTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
delete /databases/{dbId}/entailment
Resets the entailment regime to 'none'
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
The privileges assigned to users for the database
Gets the privileges assigned to users for the database
get /databases/{dbId}/privileges
Gets the privileges assigned to users for the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns the privileges assigned to users for the database
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLDatabasePrivileges"
}Examples:
{
"type": "org.xowl.infra.server.api.XOWLDatabasePrivileges",
"accesses": [
{
"user": "user1",
"isAdmin": false,
"canWrite": true,
"canRead": true
}
]
}
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Action to grant privileges to a user for the database
Grants privileges to a user for the database
post /databases/{dbId}/privileges/grant
Grants privileges to a user for the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Query Parameters
- User: required (string)
The identifier of the user to assign privilege to
Examples:
user01
- Access: required (string)
The privilege to grant (one of ADMIN, WRITE, READ)
Examples:
WRITE
HTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Action to revoke privileges from a user for the database
Revokes privileges from a user for the database
post /databases/{dbId}/privileges/revoke
Revokes privileges from a user for the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Query Parameters
- User: required (string)
The identifier of the user to revoke privilege from
Examples:
user01
- Access: required (string)
The privilege to revoke (one of ADMIN, WRITE, READ)
Examples:
WRITE
HTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
The collection of rules for the database
Gets the list of the rules for the database
Inserts a new rule in the database
get /databases/{dbId}/rules
Gets the list of the rules for the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns the list of rules for the database
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLRules"
}Examples:
[
{
"type": "org.xowl.infra.server.api.XOWLRule",
"name": "http://xowl.org/rules/rule1",
"definition": "...",
"isActive": false
}
]
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
put /databases/{dbId}/rules
Inserts a new rule in the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Query Parameters
- Is Active: required (boolean)
Whether the new rule shall be immediately active
Examples:
false
Body
Media type: application/x-xowl-rdft
Type: string
HTTP status code 200
Returns the new rule for the database
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLRule"
}Examples:
{
"type": "org.xowl.infra.server.api.XOWLRule",
"name": "http://xowl.org/rules/rule1",
"definition": "...",
"isActive": false
}
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
A specific rule for the database
Gets the description of the rule
Deletes the rule from the database
get /databases/{dbId}/rules/{ruleId}
Gets the description of the rule
URI Parameters
- dbId: required (string)
- ruleId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns the description of the rule
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLRule"
}Examples:
{
"type": "org.xowl.infra.server.api.XOWLRule",
"name": "http://xowl.org/rules/rule1",
"definition": "...",
"isActive": false
}
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
delete /databases/{dbId}/rules/{ruleId}
Deletes the rule from the database
URI Parameters
- dbId: required (string)
- ruleId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
The status of the rule
Gets the current status of the rule
get /databases/{dbId}/rules/{ruleId}/status
Gets the current status of the rule
URI Parameters
- dbId: required (string)
- ruleId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns the matching status of the rule
Body
Media type: application/json
Type: object
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Action to activate the rule
Activates the rule for the database
post /databases/{dbId}/rules/{ruleId}/activate
Activates the rule for the database
URI Parameters
- dbId: required (string)
- ruleId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Action to de-activate the rule
De-activates the rule for the database
post /databases/{dbId}/rules/{ruleId}/deactivate
De-activates the rule for the database
URI Parameters
- dbId: required (string)
- ruleId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
The collection of stored procedures for the database
Gets the list of the stored procedures for the database
get /databases/{dbId}/procedures
Gets the list of the stored procedures for the database
URI Parameters
- dbId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns the list of the stored procedures for the database
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLStoredProcedures"
}Examples:
[
{
"type": "org.xowl.infra.server.api.XOWLStoredProcedure",
"name": "http://xowl.org/procedures/proc1",
"definition": "...",
"parameters": [ "x", "y" ]
}
]
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
A specific stored procedure
Gets the definition of the stored procedure
Deletes the stored procedure from the database
Creates the stored procedure
Executes the stored procedure
get /databases/{dbId}/procedures/{procedureId}
Gets the definition of the stored procedure
URI Parameters
- dbId: required (string)
- procedureId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns the definition of the stored procedure
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLStoredProcedure"
}Examples:
{
"type": "org.xowl.infra.server.api.XOWLStoredProcedure",
"name": "http://xowl.org/procedures/proc1",
"definition": "...",
"parameters": [ "x", "y" ]
}
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
delete /databases/{dbId}/procedures/{procedureId}
Deletes the stored procedure from the database
URI Parameters
- dbId: required (string)
- procedureId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
put /databases/{dbId}/procedures/{procedureId}
Creates the stored procedure
URI Parameters
- dbId: required (string)
- procedureId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLStoredProcedure"
}Examples:
{
"type": "org.xowl.infra.server.api.XOWLStoredProcedure",
"name": "http://xowl.org/procedures/proc1",
"definition": "...",
"parameters": [ "x", "y" ]
}
HTTP status code 200
The procedure has been created
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLStoredProcedure"
}Examples:
{
"type": "org.xowl.infra.server.api.XOWLStoredProcedure",
"name": "http://xowl.org/procedures/proc1",
"definition": "...",
"parameters": [ "x", "y" ]
}
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
post /databases/{dbId}/procedures/{procedureId}
Executes the stored procedure
URI Parameters
- dbId: required (string)
- procedureId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLStoredProcedureContext"
}Examples:
{
"type": "org.xowl.infra.server.api.XOWLStoredProcedureContext",
"defaultIRIs": [],
"namedIRIs": [],
"parameters": [
{
"x": {
"type": "uri",
"value": "http://xowl.org/myLittleURI"
},
"y": {
"type": "literal",
"value": "A sample value",
"datatype": "http://www.w3.org/2001/XMLSchema#string",
"xml:lang": "en"
}
}
]
}
HTTP status code 200
The result for the SPARQL query
Body
Media type: application/n-triples
Type: object
Media type: application/n-quads
Type: object
Media type: text/turtle
Type: object
Media type: application/rdf+xml
Type: object
Media type: application/ld+json
Type: object
Media type: application/trig
Type: object
Media type: application/sparql-results+xml
Type: object
Media type: application/sparql-results+json
Type: object
Media type: text/csv
Type: object
Media type: text/tab-separated-values
Type: object
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 461
The SPARQL query failed
Body
Media type: text/plain
Type: object
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
/users
The collection of users on the server
Gets a list of the users on the server
get /users
Gets a list of the users on the server
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns a list of the users
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLUsers"
}Examples:
[ {"type": "org.xowl.infra.server.api.XOWLUser", "name": "user1"}, {"type": "org.xowl.infra.server.api.XOWLUser", "name": "user2"} ]
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 440
The user session has expired.
A specific user on the server
Gets a description of the user
Deletes the user from the server
Creates the associated user
get /users/{userId}
Gets a description of the user
URI Parameters
- userId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns a description of the requested user
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLUser"
}Examples:
{"type": "org.xowl.infra.server.api.XOWLUser", "name": "user1"}
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
delete /users/{userId}
Deletes the user from the server
URI Parameters
- userId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
put /users/{userId}
Creates the associated user
URI Parameters
- userId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Body
Media type: text/plain
Type: string
HTTP status code 200
Returns the created user
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLUser"
}Examples:
{"type": "org.xowl.infra.server.api.XOWLUser", "name": "{userId}"}
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
The password for the user
Updates the password for the user
post /users/{userId}/password
Updates the password for the user
URI Parameters
- userId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Body
Media type: text/plain
Type: string
HTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
The privileges assigned to the user for databases
Gets the privileges assigned to the user for databases
get /users/{userId}/privileges
Gets the privileges assigned to the user for databases
URI Parameters
- userId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
HTTP status code 200
Returns the privileges assigned to the user for databases
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaServerAPI.json#/definitions/XOWLUserPrivileges"
}Examples:
{
"type": "org.xowl.infra.server.api.XOWLUserPrivileges",
"isServerAdmin": false,
"accesses": [
{
"database": "db01",
"isAdmin": false,
"canWrite": true,
"canRead": true
}
]
}
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Action to grant privileges to the user for a database
Grants privileges to the user for a database
post /users/{userId}/privileges/grant
Grants privileges to the user for a database
URI Parameters
- userId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Query Parameters
- Database: required (string)
The identifier of the database to grant for
Examples:
db01
- Access: required (string)
The privilege to grant (one of ADMIN, WRITE, READ)
Examples:
WRITE
HTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string
Action to revoke privileges from the user for a database
Revokes privileges from the user for a database
post /users/{userId}/privileges/revoke
Revokes privileges from the user for a database
URI Parameters
- userId: required (string)
Headers
- Cookie: required (string)
Authentication token provided by the server
Examples:
__Secure-xOWL-Token-v1=AAAAA
Query Parameters
- Database: required (string)
The identifier of the database to grant for
Examples:
db01
- Access: required (string)
The privilege to grant (one of ADMIN, WRITE, READ)
Examples:
WRITE
HTTP status code 200
The operation succeeded
HTTP status code 400
The request is malformed in some way
Body
Media type: application/json
Type: json
Content:
{
"$ref": "schemaUtils.json#/definitions/ApiError"
}Examples:
{
"type": "fr.cenotelie.commons.utils.ApiError",
"code": 1,
"message": "The main description of this error",
"helpLink": "http://xowl.org/supports/errors/001.html",
"content": "Supplementary information about the error"
}
HTTP status code 401
No user is logged-in, or the authentication token is invalid.
HTTP status code 403
The logged-in user is not authorized to perform this operation.
HTTP status code 404
The requested resource cannot be found.
HTTP status code 440
The user session has expired.
HTTP status code 500
An unexpected error occurred on the server
HTTP status code 501
The requested operation is not supported
HTTP status code 560
An unknown error error occurred on the server
Body
Media type: text/plain
Type: string