Introduction


This document is a markdown export generated from the DataPlatform OpenAPI Specification.

Rather than using this page, you should use an Open API user interface (such as https://petstore.swagger.io/ ) and load the JSON document there. This page is mainly here for the search index and deep links (smile).

API Description

/api/explore/facets

GET

Summary:

List the properties of a class or query

Parameters
NameLocated inDescriptionRequiredSchema
contextGraphquerySingle default graphNostring
queryFragmentqueryQuery fragment for the WHERE clause (either queryFragment or classIri must be specified).Nostring
classIriqueryIRI of the class the resource is an instance of (either queryFragment or classIri must be specified).Nostring
incomingqueryDefines, if incoming or outgoing properties of are calculated. If 'true', the facets are calculated for incoming properties are returnedNoboolean
variableNamequeryUsed with query fragment: Defines the variable for which the facets are calculated.Nostring
sparqlQueryquerysparqlQueryNostring
langPrefencesqueryLanguage preferences that override the system settings. Used for both shape and dataNo[ string ]
Responses
CodeDescription
200Request was successful and query result is returned in the body.
400
403
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/resource

GET

Description:

Checks if the resource is annotated

Parameters
NameLocated inDescriptionRequiredSchema
subjectquery Yesstring
contextGraphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/statement

POST

Description:

Checks if the given statement is a annotated. HTTP POST is used, to enable safe RequestBody

Parameters
NameLocated inDescriptionRequiredSchema
contextGraphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/graphs/graphs/{id}/read

PATCH

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
graphUriquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

POST

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
graphUriquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

OPTIONS

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
graphUriquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

DELETE

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
graphUriquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

PUT

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
graphUriquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/proxy/{id}/update/manualedit

POST

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
insertsquery Nostring
deletesquery Nostring
queriesquery Nostring
shapequery Nostring
primaryResourcequery Nostring
graphquery Yesstring
commentquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

DELETE

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
resourcequery Yesstring
graphquery Yesstring
commentquery Nostring
includeAllStatementLvlMetaquery Noboolean
Responses
CodeDescription
204default response
Security
Security SchemaScopes
bearerAuth

/api/prefixes

GET

Description:

Get a plain list of all prefixes and their namespaces as used in the system. Ambiguous definitions are ignored here.

Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/connectableProperties

GET

Description:

Fetches the properties that are enabled for

Parameters
NameLocated inDescriptionRequiredSchema
resourcequery Yesstring
langPrefquery Yes[ string ]
contextGraphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/graphs/importTree

GET

Description:

The owl:import imports, determined by a breadth first graph traversal.

Parameters
NameLocated inDescriptionRequiredSchema
graphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/connectedStatementSubjectCand

POST

Parameters
NameLocated inDescriptionRequiredSchema
resourcequery Yesstring
contextGraphquery Yesstring
searchTermquery Yesstring
langPrefquery No[ string ]
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/admin/currentQueries

GET

Description:

Most recent queries.

Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/authorization/refresh

GET

Summary:

Authorization refresh

Description:

Reloads the access conditions model following the internal configuration parameters.

Responses
CodeDescription
204The access conditions were successfully reloaded.
403The user does not have permission to execute this action.
500The access conditions could not be loaded, most likely due to an inconsistency in the new access conditions model. The active access conditions model stays unmodified.
Security
Security SchemaScopes
bearerAuth

/actuator/logger/{logger}

POST

Summary:

Change the configured logging level for the specified logger.

Description:

Change the configured logging level for the specified logger.

Parameters
NameLocated inDescriptionRequiredSchema
loggerpathThe name of the logger to manageYesstring
Responses
CodeDescription
200The logging level was configured successfully.
400The logging level couldn't be changed due to a malformed request. Refer to the response body for a detailed error description.
401Access denied for the current user. The access token is invalid.
403Access denied for the current user. Only root users can use this endpoint.
415If no or a wrong Conent-Type header is given.
Security
Security SchemaScopes
bearerAuth

GET

Summary:

Application loggers by name.

Description:

Display the configured logging level for the specified logger.

Parameters
NameLocated inDescriptionRequiredSchema
loggerpathThe name of the logger to manageYesstring
Responses
CodeDescription
200Successful response
400The logging level couldn't be changed due to a malformed request. Refer to the response body for a detailed error description.
401Access denied for the current user. The access token is invalid.
403Access denied for the current user. Only root users can use this endpoint.
Security
Security SchemaScopes
bearerAuth

/api/queries/reports/performBulk

POST

Parameters
NameLocated inDescriptionRequiredSchema
queryIrisqueryThe identifier of the queryYes[ string ]
contextGraphqueryNarrows down the execution context of the query to a single graph. This sets the default & named graph of the query.Nostring
substitutionsqueryA json encoded map of placeholder substitutions. Each variable of the query needs to be set.Nostring
fileNamesqueryThe name of the downloadNo[ string ]
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

GET

Parameters
NameLocated inDescriptionRequiredSchema
queryIrisqueryThe identifier of the queryYes[ string ]
contextGraphqueryNarrows down the execution context of the query to a single graph. This sets the default & named graph of the query.Nostring
substitutionsqueryA json encoded map of placeholder substitutions. Each variable of the query needs to be set.Nostring
fileNamesqueryThe name of the downloadNo[ string ]
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/connectableStatement

POST

Parameters
NameLocated inDescriptionRequiredSchema
resourcequery Yesstring
contextGraphquery Yesstring
limitquery Nolong
offsetquery Nolong
langPrefquery No[ string ]
inferPredicateFilterqueryif set to true, in case the request body filter is empty or the predicate filter part is empty, all connectableProperties are used as the predicate filter.Noboolean
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/proxy/{id}/graph

POST

Summary:

SPARQL Graph Store HTTP POST

Description:

Stores the given tuples in the underlying endpoint. If triples are provided, they are stored in the given graph. If a quad format is used, the graph URI be set as the target graph of the unnamed graph; all other quads will be stored as is.

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
graphqueryA valid graph URI / IRI as described in SPARQL 1.1 Graph Store HTTP Protocol.Yesstring
replacequeryThis optional (non-standard) parameter can be used to trigger a delete operation before storing the data. This operation logic is then equivalent to a PUT operation, but is adequate for restrictive environments (e.g. restrictive HTTP proxies which limit the accepted HTTP operations). If none of those restrictions apply, the use of the PUT method is recommended for standard compliance.Noboolean
Responses
CodeDescription
204
400
403
404
409
415
503
Security
Security SchemaScopes
bearerAuth

GET

Summary:

SPARQL Graph Store HTTP GET

Description:

A request that uses the HTTP GET method MUST retrieve an RDF payload that is a serialization of the named graph paired with the graph IRI in the Graph Store.

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
graphqueryA valid graph URI / IRI as described in SPARQL 1.1 Graph Store HTTP Protocol.Yesstring
owlImportsResolutionqueryEnable/disable OWL imports resolution for this query.Noboolean
timeoutqueryThe maximal amount of time (in milliseconds) that a request should run until the execution is aborted. If none provided, the default timeout of the quad store applies.Nolong
etagqueryIf set to true, provide an ETag header in the response. The calculation of this value is time consuming. You should require it only if necessary.Noboolean
Responses
CodeDescription
200
204
400
403
404
503
Security
Security SchemaScopes
bearerAuth

DELETE

Summary:

SPARQL Graph Store HTTP DELETE

Description:

A request that uses the HTTP DELETE method SHOULD delete the RDF graph content identified by either the request or encoded IRI.

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
graphqueryA valid graph URI / IRI as described in SPARQL 1.1 Graph Store HTTP Protocol.Yesstring
Responses
CodeDescription
204
400
403
404
503
Security
Security SchemaScopes
bearerAuth

PUT

Summary:

SPARQL Graph Store HTTP PUT

Description:

A request that uses the HTTP PUT method MUST store the enclosed RDF payload as RDF graph content. The given RDF payload MUST be encoded as UTF-8.

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
graphqueryA valid graph URI / IRI as described in SPARQL 1.1 Graph Store HTTP Protocol.Yesstring
Responses
CodeDescription
204
400
403
404
409
415
503
Security
Security SchemaScopes
bearerAuth

/info

GET

Summary:

Shows arbitrary application.

Description:

Displays arbitrary application info, such as program version etc.

Responses
CodeDescription
200Successful response

/proxy/{id}/sparql

GET

Summary:

SPARQL query via HTTP GET

Description:

SPARQL query via HTTP GET and query parameters

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
queryqueryA valid SPARQL 1.1 Query string as described in the SPARQL 1.1 Query LanguageYesstring
default-graph-uriqueryZero or more default graph URIsNo[ string ]
named-graph-uriqueryZero or more named graph URIsNo[ string ]
owlImportsResolutionqueryEnable/disable OWL imports resolution for this queryNoboolean
base64encodedqueryIf set to true, the query parameter is expected in base64 encodingNoboolean
Responses
CodeDescription
200
503
Security
Security SchemaScopes
bearerAuth

/userinfo

GET

Summary:

UserInfo GET

Description:

Displays user information, such as user name and account URI.

Responses
CodeDescription
200The request was processed successfully.
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/resources

POST

Description:

Fetches the list of rdf:Statements resources that contain the actual reification information

Parameters
NameLocated inDescriptionRequiredSchema
contextGraphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/graphs/{id}/write

GET

Summary:

Writable graphs

Description:

A list of graph URIs the user is allowed to write.

Parameters
NameLocated inDescriptionRequiredSchema
idpathA specific SPARQL endpoint. Every endpoint is identified by an endpointId URI path parameter.Yesstring
graphUriqueryA specific graph to check write access for, will return true if write is allowed, otherwise falseNostring
Responses
CodeDescription
200The request was processed successfully.
Security
Security SchemaScopes
bearerAuth

/api/resources/shapedSave

POST

Description:

Saves a changed resource and allows adding the resource as a reified statement.

Parameters
NameLocated inDescriptionRequiredSchema
contextGraphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/proxy/{id}

GET

Summary:

Returns metadata of the endpoint.

Description:

Returns metadata of the endpoint. Currently, the list of visible graphs contained by the store, together with their write access level. JSON schema of the response is https://www.w3.org/TR/2013/REC-sparql11-results-json-20130321

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
Responses
CodeDescription
200Successful response.
Security
Security SchemaScopes
bearerAuth

/proxy/{id}/update/manualedit/analyse

GET

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
resourcequery Yesstring
graphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/connectableStatementCount

POST

Parameters
NameLocated inDescriptionRequiredSchema
resourcequery Yesstring
contextGraphquery Yesstring
limitquery Nolong
offsetquery Nolong
inferPredicateFilterqueryif set to true, in case the request body filter is empty or the predicate filter part is empty, all connectableProperties are used as the predicate filter.Noboolean
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/proxy/{id}/update

POST

Summary:

The update operation is used to send a SPARQL 1.1 update request.

Description:

The update operation must be invoked using the HTTP POST method. Client requests for this operation must include exactly one SPARQL update query string (parameter name: update) and may include zero or more default graph URIs (parameter name: using-graph-uri) and named graph URIs (parameter name: using-named-graph-uri). The response to an update request indicates success or failure of the request via HTTP response status code.SPARQL update query as the body of a POST request, the rest of parameters as query parameters. Important note: this endpoint also accepts sending all the parameters, including the SPARQL query, as application/x-www-form-urlencoded parameters in the body. In such a case, the SPARQL query must be sent in a parameter named "update".

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
using-graph-uriquerydefault graph URI, may include zero or more.No[ string ]
using-named-graph-uriqueryURL-encoded named graph URI, may include zero or more.No[ string ]
timeoutquery Nolong
base64encodedqueryIs the update param Base64-encoded?Noboolean
Responses
CodeDescription
202The update query was processed successfully, however not fully. This typically means that further tasks still have to be post-processed.
204
400Bad request. Possible causes are either a wrong query syntax or a modification attempt of the default graph (refer to the section SPARQL Default Graph & RDF Dataset of the developer manual for more information regarding this topic).
409Transaction aborted due to deadlock. Retrying should solve the problem.
503
Security
Security SchemaScopes
bearerAuth

/api/admin/backup/zip

GET

Description:

Creates a full (or partial, see the graphsRequested Parameter) backup of the knowledge graph,

Parameters
NameLocated inDescriptionRequiredSchema
graphsRequestedqueryIf present, only the list of graphs given here, is included in the backup.No[ string ]
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/graphs/list

GET

Summary:

User graphs list

Description:

A list of graph URIs the user is allowed to read.

Responses
CodeDescription
200The request was processed successfully.
403
Security
Security SchemaScopes
bearerAuth

/actions/{id}

GET

Summary:

Allowed actions

Description:

A list of action URIs the user is allowed to perform or true / false if a specific action is given as a parameter

Parameters
NameLocated inDescriptionRequiredSchema
idpathA specific SPARQL endpoint. Every endpoint is identified by an endpointId URI path parameter.Yesstring
actionUriqueryCheck for a specific action, will return true if the user is allowed to perform the action, otherwise false.Nostring
Responses
CodeDescription
200The response was successfully executed.
Security
Security SchemaScopes
bearerAuth

/api/shapes/cacheInvalidate

GET

Description:

Invalidates the shapes cache

Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/proxy/{id}/resource

POST

Summary:

Adds the given statements to the Concise Bound Description of the given resource in the supplied graph.

Description:

Adds the given statements to the Concise Bound Description of the given resource in the supplied graph.

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
resourcequeryA valid resource URIYesstring
graphqueryThe URI of the graph containing the resource.Yesstring
replacequeryThis optional parameter can be used to trigger a delete operation before storing the data. This operation logic is then equivalent to a PUT operation, but is adequate for restrictive environments (e.g. restrictive HTTP proxies which limit the accepted HTTP operations). If none of those restrictions apply, the use of the PUT method is recommended for standard compliance.Noboolean
Responses
CodeDescription
204
Security
Security SchemaScopes
bearerAuth

GET

Summary:

Returns the Concise Bound Description of the requested resource in the given graph.

Description:

Returns the Concise Bound Description of the requested resource in the given graph.

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
resourcequeryA valid resource URIYesstring
graphqueryThe URI of the graph containing the resource.Yesstring
Responses
CodeDescription
200The request was processed successfully.
204
400
403
404
503
Security
Security SchemaScopes
bearerAuth

DELETE

Summary:

Deletes the Concise Bound Description of the provided resource contained by the provided graph.

Description:

Deletes the Concise Bound Description of the provided resource contained by the provided graph.

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
resourcequeryA valid resource URIYesstring
graphqueryThe URI of the graph containing the resource.Yesstring
Responses
CodeDescription
204
Security
Security SchemaScopes
bearerAuth

PUT

Summary:

Replaces the Concise Bound Description of the given resource contained in the supplied graph.

Description:

Replaces the Concise Bound Description of the given resource contained in the supplied graph.

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
resourcequeryA valid resource URIYesstring
graphqueryThe URI of the graph containing the resource.Yesstring
Responses
CodeDescription
204
400
403
404
503
Security
Security SchemaScopes
bearerAuth

/api/resources/list

POST

Parameters
NameLocated inDescriptionRequiredSchema
contextGraphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/explore/depictions

POST

Description:

Reads foad:depiction uris for the given resources, in the following order: 1.) directly attached to the resource 2.) attached to a shape, matching is resolved exclusively on the sh:targetClass. In case of multiple shapes, the one with the highest sh:order is selected. 3.) If he default shape has a depiction, it is used as fallback

Parameters
NameLocated inDescriptionRequiredSchema
contextGraphqueryThe context/graph, in which the lookup should take placeNostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/shapes/applicable

GET

Description:

Given targets, what shapes could be applied?

Parameters
NameLocated inDescriptionRequiredSchema
targetClassquery Nostring
subjectOfPropertyquery Nostring
objectOfPropertyquery Nostring
nodeTargetIriquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/health

GET

Summary:

Shows application health information.

Description:

Shows application health information to check the status of the application. Admin users will get a detailed status description, all others will see a simple ‘status’ message.

Responses
CodeDescription
200Successful response

/api/statementmetadata/disconnect

POST

Parameters
NameLocated inDescriptionRequiredSchema
resourcequerythe resource to be connected to the statementsYesstring
contextGraphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/querycatalog/pretty

POST

Parameters
NameLocated inDescriptionRequiredSchema
queryquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/queries/reports

GET

Description:

Lists all executable queries and shows their potential parameters

Parameters
NameLocated inDescriptionRequiredSchema
vocabCatalogqueryThe uri of the query catalog, in case not all queries shall be listed.Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/custom/{slug}

POST

Description:

Executes the query and returns a JSON result by evaluating a Jinjava Template

Parameters
NameLocated inDescriptionRequiredSchema
slugpath Yesstring
contextGraphquery Nostring
substitutionsqueryA json encoded map of placeholder substitutions. Each variable of the query needs to be set.Nostring
Responses
CodeDescription
200A JSON response of the Framed Construct Result
Security
Security SchemaScopes
bearerAuth

GET

Description:

Executes the query and returns a JSON result by evaluating a Jinjava Template

Parameters
NameLocated inDescriptionRequiredSchema
slugpath Yesstring
contextGraphquery Nostring
substitutionsqueryA json encoded map of placeholder substitutions. Each variable of the query needs to be set.Nostring
Responses
CodeDescription
200A JSON response of the Framed Construct Result
Security
Security SchemaScopes
bearerAuth

/actuator/health

GET

Summary:

Shows application health information.

Description:

Shows application health information to check the status of the application. Admin users will get a detailed status description, all others will see a simple ‘status’ message.

Responses
CodeDescription
200Successful response

/api/shapes/list

GET

Description:

Lists NodeShapes, either by the given iris, or all if empty.

Parameters
NameLocated inDescriptionRequiredSchema
nodeShapesquery No[ string ]
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/querycatalog

POST

Description:

Create a new query from the provided object. For Iri, either let the backend crate a new one, by providing a valid blank node identifier, i.e. '_:1'.Alternatively, provide a IRI.Creation and modified dates will be replaced.

Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

GET

Description:

Lists all queries in the catalog

Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

DELETE

Description:

Deletes the specified query. Deletes only the data that was created with this api.

Parameters
NameLocated inDescriptionRequiredSchema
queryIriquery Yesstring
modifiedDatequery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

PUT

Description:

Update an existing query with the provided values. Modified dates are automatically set.

Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/authorization/conditions

POST

Summary:

Creates access conditions.

Description:

Store a new access condition with the properties provided in the request body. A valid input access condition must contain the eccauth:AccessCondition type, at least one grant (any property defined as a sub-property of eccauth:isAllowed) and any number of requirements (any property defined as a sub-property of eccauth:requiresAttribute). Optionally, the access condition can be annotated with the properties rdfs:label and rdfs:comment. If present, the value of the property eccauth:requiresAccount must be either an IRI or a blank node with annotated eccauth:Account type and a single label. If present, the value of the property eccauth:requiresGroup must be either an IRI or a blank node with annotated eccauth:Group type and a single label. Further annotations will be rejected. The access condition must be anonymous (blank node as subject). Identifiers (IRIs) will be created by the server for valid blank node elements (access condition, accounts, groups).

Responses
CodeDescription
201Successful access condition creation. The response body contains the newly replaced access condition.
403The user is not allowed to store the access condition or does not have permission to execute this action. This can be caused either because the user is not allowed to add new conditions or because the access condition grants access to a resource to which the user has no grant allowance.
405The access condition could not be added because the access conditions model is not modifiable.
422The access condition is not valid.
Security
Security SchemaScopes
bearerAuth

GET

Summary:

Retrieve all access conditions manageable by the user or a specific one (see the resource parameter description).

Parameters
NameLocated inDescriptionRequiredSchema
resourcequeryRetrieve only the access condition identified by the given IRI.Nostring
Responses
CodeDescription
200Successful access condition replacement. The response body contains the newly replaced access condition.
204The access condition model is empty.
403The user is not allowed to manage the access condition or does not have permission to execute this action.
404The access condition does not exist.
Security
Security SchemaScopes
bearerAuth

DELETE

Summary:

Delete an existing access condition with the given name.

Description:

Delete an existing access condition with the given name.

Parameters
NameLocated inDescriptionRequiredSchema
resourcequeryThe IRI of the access condition to be deleted.Yesstring
Responses
CodeDescription
204Removal of the access condition was successful.
403The user is not allowed to delete the access condition or does not have permission to execute this action.
404The access condition does not exist.
405The access condition could not be removed because the access conditions model is not modifiable.
Security
Security SchemaScopes
bearerAuth

PUT

Summary:

Updates access conditions.

Description:

Replaces the access condition with the properties provided in the request body. A valid input access condition must contain the eccauth:AccessCondition type, at least one grant (any property defined as a sub-property of eccauth:isAllowed) and any number of requirements (any property defined as a sub-property of eccauth:requiresAttribute). Optionally, the access condition can be annotated with the properties rdfs:label and rdfs:comment. If present, the value of the property eccauth:requiresAccount must be either an IRI or a blank node with annotated eccauth:Account type and a single label. If present, the value of the property eccauth:requiresGroup must be either an IRI or a blank node with annotated eccauth:Group type and a single label. Further annotations will be rejected. The access condition (identified by its IRI) must already exist in the store. A blank node is not allowed as the access condition resource identifier. Identifiers (IRIs) will be created by the server for valid blank node elements (accounts, groups).

Parameters
NameLocated inDescriptionRequiredSchema
resourcequeryThe IRI of the access condition to replace.Yesstring
Responses
CodeDescription
200Successful access condition replacement. The response body contains the newly replaced access condition.
403The user is not allowed to replace the access condition or does not have permission to execute this action. This can be caused either because the user is not allowed to add new conditions, because the access condition grants access to a resource to which the user has no grant allowance or because the access condition with the given IRI is not modifiable by the user.
404The access condition does not exist.
405The access condition could not be replaced because the access conditions model is not modifiable.
422The access condition was not stored because it is not valid.
Security
Security SchemaScopes
bearerAuth

/api/resources/usage

GET

Parameters
NameLocated inDescriptionRequiredSchema
iriquery Yesstring
contextGraphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/graphs/imports

GET

Description:

The list of graphs, which this graph includes, resolved transitively. In case of cycles in the owl imports, the requested graph is guaranteed to not be included in the result.

Parameters
NameLocated inDescriptionRequiredSchema
owlImportsResolutionquery Noboolean
graphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/graphs/graphs/{id}/write

PATCH

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
graphUriquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

POST

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
graphUriquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

OPTIONS

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
graphUriquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

DELETE

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
graphUriquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

PUT

Parameters
NameLocated inDescriptionRequiredSchema
idpath Yesstring
graphUriquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/actuator/loggers

GET

Summary:

Displays all accepted logging levels and loggers.

Description:

Displays all accepted logging levels as well as the currently configured loggers.

Responses
CodeDescription
200Successful response
401Access denied for the current user. The access token is invalid.
403Access denied for the current user. Only root users can use this endpoint.
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/connectableStatementSubjectCand

POST

Parameters
NameLocated inDescriptionRequiredSchema
resourcequery Yesstring
contextGraphquery Yesstring
searchTermquery Yesstring
langPrefquery No[ string ]
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/querycatalog/queryType

POST

Parameters
NameLocated inDescriptionRequiredSchema
queryquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/authorization/conditions/framed

POST

Summary:

Access conditions management with JSON-LD frame support.

Description:

Retrieve manageable access conditions with a specific JSON-LD tree layout forced by the given frame.

Parameters
NameLocated inDescriptionRequiredSchema
resourcequeryRetrieve only the access condition identified by the given IRI.Nostring
Responses
CodeDescription
200Successful retrieval of the requested access condition(s).
204The access conditions model is empty.
400The given JSON-LD frame is malformed.
403The user is not allowed to manage the access condition or does not have permission to execute this action.
404The access condition does not exist.
Security
Security SchemaScopes
bearerAuth

/proxy/{id}/sparql/framed

POST

Summary:

Framed SPARQL CONSTRUCT query via HTTP POST

Description:

Framed SPARQL CONSTRUCT query via HTTP POST with URL-encoded, ampersand-separated query parameters in the body.

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
Responses
CodeDescription
200Returns the result of the SPARQL CONSTRUCT query, which will be an RDF model in JSON-LD syntax)
400
503
Security
Security SchemaScopes
bearerAuth

/graphs/{id}/read

GET

Summary:

Readable graphs

Description:

A list of graph URIs the user is allowed to read (includes writable graphs) if no graphUri is given or, if it's given, a boolean indicating whether the graph is readable by the user.

Parameters
NameLocated inDescriptionRequiredSchema
idpathA specific SPARQL endpoint. Every endpoint is identified by an endpointId URI path parameter.Yesstring
graphUriqueryA specific graph to check read access for, will return true if read is allowed, otherwise falseNostring
Responses
CodeDescription
200The request was processed successfully.
Security
Security SchemaScopes
bearerAuth

/api/admin/drop-all-graphs

POST

Description:

Drops all graphs.

Responses
CodeDescription
200Graphs successfully dropped.
Security
Security SchemaScopes
bearerAuth

/api/auth/actions

GET

Summary:

Allowed actions

Description:

A list of action URIs the user is allowed to perform

Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/queries/reports/perform

POST

Description:

Executes the query and returns a CSV result

Parameters
NameLocated inDescriptionRequiredSchema
queryIriqueryThe identifier of the queryYesstring
contextGraphqueryNarrows down the execution context of the query to a single graph. This sets the default & named graph of the query.Nostring
substitutionsqueryA json encoded map of placeholder substitutions. Each variable of the query needs to be set.Nostring
fileNamequeryThe name of the downloadNostring
Responses
CodeDescription
200A csv representation of the query result
Security
Security SchemaScopes
bearerAuth

GET

Description:

Executes the query and returns a CSV result

Parameters
NameLocated inDescriptionRequiredSchema
queryIriqueryThe identifier of the queryYesstring
contextGraphqueryNarrows down the execution context of the query to a single graph. This sets the default & named graph of the query.Nostring
substitutionsqueryA json encoded map of placeholder substitutions. Each variable of the query needs to be set.Nostring
fileNamequeryThe name of the downloadNostring
Responses
CodeDescription
200A csv representation of the query result
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/applicableshapes

GET

Description:

Fetches the list of suitable Shapes for a reification

Parameters
NameLocated inDescriptionRequiredSchema
propertyShapeIriquery Yesstring
contextGraphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/explore/titles

POST

Description:

@Beta, this api is subject to change without further notice . Finds a short-form description for a multiple IRIs.

Parameters
NameLocated inDescriptionRequiredSchema
langPrefsqueryAn ordered List of language preferencesNo[ string ]
contextGraphqueryThe context/graph, in which the lookup should take placeNostring
Responses
CodeDescription
defaultA Mapping of the IRIs to a detailed resolution report.Uses POST instead of GET to circumvent too large requests.
Security
Security SchemaScopes
bearerAuth

/api/prefixesDetails

GET

Description:

A detailed view on the prefixes and how they are defined. Also overridden and ambiguous definitions are given here.

Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/vocabs

GET

Summary:

List vocabularies

Description:

Lists all Vocabularies of the default endpoint.

Parameters
NameLocated inDescriptionRequiredSchema
vocabGraphqueryThe Vocabulary Catalog to queryNostring
searchTermqueryA full text search termNostring
limitqueryMax number of resultsNolong
offsetqueryskip the first resultsNolong
order-byqueryEither ASC ord DESCNostring
langPrefencesquery No[ string ]
Responses
CodeDescription
200The request was processed successfully.
Security
Security SchemaScopes
bearerAuth

/api/explore/title

GET

Description:

This api is subject to change without further notice . Finds a short-form description for a single IRI.

Parameters
NameLocated inDescriptionRequiredSchema
resourcequeryThe iri to resolveYesstring
langPrefsqueryAn ordered List of language preferencesNo[ string ]
contextGraphqueryThe context/graph, in which the lookup should take placeNostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/graphs/detailed

GET

Summary:

User graph with details

Description:

Graph URIs the user is allowed to read, with details (classes counts, instances counts, etc.).

Parameters
NameLocated inDescriptionRequiredSchema
owlImportsResolutionqueryEnable/disable OWL imports resolution.Noboolean
graphIriqueryThe details fo the graph to fetchYesstring
Responses
CodeDescription
200The request was processed successfully.
403
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/connect

POST

Parameters
NameLocated inDescriptionRequiredSchema
resourcequerythe resource to be connected to the statementsYesstring
contextGraphquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/actuator/info

GET

Summary:

Shows arbitrary application.

Description:

Displays arbitrary application info, such as program version etc.

Responses
CodeDescription
200Successful response

/api/admin/showcase

POST

Description:

Insert the showcase data

Parameters
NameLocated inDescriptionRequiredSchema
scaleFactorquery Nointeger
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/proxy/{id}/resource/framed

POST

Summary:

Returns the Concise Bound Description of the requested resource in the given graph.

Description:

Returns the Concise Bound Description of the requested resource in the given graph. Provides Concise Bound Description read access of RDF resources in JSON-LD format. An optional JSON-LD frame can be provided to force a specific tree layout to the JSON-LD results.

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
Responses
CodeDescription
200The request was processed successfully.
204
400
403
404
503
Security
Security SchemaScopes
bearerAuth

/api/admin/bootstrap

POST

Description:

Replaces the bootstrap data with the most current one.Overwrites all data in the dataset, shape, vocabulary, thesaurus, query and other catalogues.This operation overwrites data. Use with care

Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/connectedStatement

POST

Parameters
NameLocated inDescriptionRequiredSchema
resourcequery Yesstring
contextGraphquery Yesstring
limitquery Nolong
offsetquery Nolong
langPrefquery No[ string ]
inferPredicateFilterqueryif set to true, in case the request body filter is empty or the predicate filter part is empty, all connectableProperties are used as the predicate filter.Noboolean
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/statementmetadata/connectedStatementCount

POST

Parameters
NameLocated inDescriptionRequiredSchema
resourcequery Yesstring
contextGraphquery Yesstring
inferPredicateFilterqueryif set to true, in case the request body filter is empty or the predicate filter part is empty, all connectableProperties are used as the predicate filter.Noboolean
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/proxy/{id}/vowl

GET

Summary:

Visualization data for OWL data.

Description:

This endpoint provides WebVOWL visualization data for OWL data in a specific graph.

Parameters
NameLocated inDescriptionRequiredSchema
idpathEndpoint IDYesstring
graphqueryA valid graph URI / IRI as described in SPARQL 1.1 Graph Store HTTP Protocol.Yesstring
Responses
CodeDescription
200The request was processed successfully.
400
403
404
503
Security
Security SchemaScopes
bearerAuth

/api/queries/jsonld/perform

POST

Description:

Executes the query and returns a CSV result

Parameters
NameLocated inDescriptionRequiredSchema
queryIriquery Yesstring
contextGraphquery Nostring
substitutionsqueryA json encoded map of placeholder substitutions. Each variable of the query needs to be set.Nostring
Responses
CodeDescription
200A JSON response of the Framed Construct Result
Security
Security SchemaScopes
bearerAuth

GET

Description:

Executes the query and returns a CSV result

Parameters
NameLocated inDescriptionRequiredSchema
queryIriquery Yesstring
contextGraphquery Nostring
substitutionsqueryA json encoded map of placeholder substitutions. Each variable of the query needs to be set.Nostring
Responses
CodeDescription
200A JSON response of the Framed Construct Result
Security
Security SchemaScopes
bearerAuth

/api/querycatalog/logicalPlan

POST

Parameters
NameLocated inDescriptionRequiredSchema
queryquery Yesstring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

/api/resources/shaped

POST

Description:

Provides a shaped view on resources. If no shapes and just resources are provided, applicable shapes are searched from the shape catalogIf only shapes and no resources are provided, an empty shape is returned.In case no resource or shape is provided, a default shape is presented

Parameters
NameLocated inDescriptionRequiredSchema
resourcesqueryThe list of resources to be shaped.No[ string ]
nodeShapeIrisqueryIf present, shapes are not detected, but the provided are applied. Can be used for form generation on new resources.No[ string ]
langPrefencesqueryLanguage preferences that override the system settings. Used for both shape and dataNo[ string ]
contextGraphquery Nostring
Responses
CodeDescription
200default response
Security
Security SchemaScopes
bearerAuth

Models

SparqlQueryFramedSchema

NameTypeDescriptionRequired
named-graph-uri[ string ]May include zero or more named graph URIsNo
owlImportsResolutionbooleanEnable/disable OWL imports resolution for this queryNo
base64encodedbooleanIf set to true; the query parameter is expected in base64 encodingNo
default-graph-uri[ string ]May include zero or more default graph URIsNo
querystringA valid SPARQL 1.1 CONSTRUCT Query string as described in the SPARQL 1.1 Query LanguageYes
framestring No

ReadableGraph

NameTypeDescriptionRequired
iristring Yes
graphProperies[ string ] Yes
diProjectGraphboolean Yes
assignedClasses[ string ] Yes
projectInternalboolean Yes
labelTitleResolve Yes
writeableboolean Yes
systemResourceboolean Yes

GraphCount

NameTypeDescriptionRequired
graphLabelstring No
graphIristring No
triplesCountinteger No
writableboolean No

Provenance

NameTypeDescriptionRequired
graphReadableGraph No
writableboolean No

PropertyShape

NameTypeDescriptionRequired
inversePathboolean No
uiQueryShuiSparqlQuery No
flagsstring No
patternstring No
valueQueryHideHeaderboolean No
propertyClass[ string ] No
maxCountinteger No
enableStatementLevelMetadataboolean No
descriptions[ Literal ] No
pathstring No
uriTemeplatestring No
uniqueLangboolean No
valueQueryShuiSparqlQuery No
denyNewResourcesboolean No
onInsertQueries[ ShuiSparqlQuery ] No
ignoreOnCopyboolean No
depictionUristring No
nodeKindstring No
nodeShapes[ string ] No
orderlong No
groupShaclGroupResolvable No
iristring Yes
comments[ Literal ] No
shClass[ string ] No
langIn[ Literal ] No
dataTypestring No
targetGraphTemplateTargetGraphTemplate No
readOnlyboolean No
showAlwaysboolean No
valueQueryHideFooterboolean No
labels[ Literal ] Yes
names[ Literal ] No
minCountinteger No
onDeleteQueries[ ShuiSparqlQuery ] No
metadataPreferredNodeShapes[ string ] No
textAreaboolean No

FacetDetail

NameTypeDescriptionRequired
iristring Yes
countinteger Yes
descriptionTitleResolve No
labelTitleResolve Yes

QueryTypeAnalysis

NameTypeDescriptionRequired
typestring No
messagestring No

TargetGraphTemplate

NameTypeDescriptionRequired
iristring No
resourceOwnshipMethodstring No
templateStringstring No

ConnectableProperties

NameTypeDescriptionRequired
preferredAnnotableProperties[ BaseResource ] No
allAnnotateableProperties[ BaseResource ] No

ListOptions

NameTypeDescriptionRequired
searchTermstring No
offsetinteger No
limitinteger No
focusVarstring No

ShaclGroupResolvable

NameTypeDescriptionRequired
iristring Yes
comments[ Literal ] No
depictionUristring No
labels[ Literal ] Yes
orderinteger No

ResourceChangeSet

NameTypeDescriptionRequired
annotationFor[ Statement ] No
changes[ ChangeSet ] No
commentstring No
mainResourcestring Yes

ResourceView

NameTypeDescriptionRequired
iristring Yes
shapedByNodeShapeobject No
shapedBy[ string ] No
shapedByNodeShapeCommentobject No
commentTitleResolve No
labelTitleResolve Yes
poViews[ PropertyValueView ] No
writableboolean No
listQuery[ string ] No

CatalogQuery

NameTypeDescriptionRequired
iristring Yes
comments[ Literal ] No
createdLiteral Yes
jsonLdFramestring No
labelTitleResolve Yes
typestring Yes
descriptions[ Literal ] No
labels[ Literal ] Yes
tags[ string ] No
queryTextstring Yes
modifiedLiteral Yes
commentTitleResolve Yes
depictionUristring Yes

QueryExecutionStats

NameTypeDescriptionRequired
executionTimelong No
executionFinishedlong No
idstring Yes
queryStringstring Yes
executionStartedlong Yes

RichStatement

NameTypeDescriptionRequired
predicateValueView Yes
subjectValueView Yes
objectValueView Yes

Literal

NameTypeDescriptionRequired
datatypestring No
langstring No
valuestring Yes

DepictionResolve

NameTypeDescriptionRequired
nodeShapeIristring No
resourceIristring No
directboolean No
depictionstring No

NodeShape

NameTypeDescriptionRequired
severitystring No
iristring Yes
targetClasses[ string ] No
comments[ Literal ] No
isApplicableAsStatementLevelMetadataboolean No
displayNames[ Literal ] No
targetGraphTemplateTargetGraphTemplate No
onUpdateUpdates[ ShuiSparqlQuery ] No
enableStatementLevelMetadataboolean No
targetNodes[ string ] No
labels[ Literal ] Yes
deactivedboolean No
listQueryShuiSparqlQuery No
templateStringstring No
subjectsOfPred[ string ] No
objectsOfPred[ string ] No
closedboolean No
messages[ Literal ] No
depictionUristring No
metadataPreferredNodeShapes[ string ] No
properties[ PropertyShape ] No
orderinteger No

ShuiSparqlQuery

NameTypeDescriptionRequired
iristring No
queryTextstring No
queryTypestring No

ValueView

NameTypeDescriptionRequired
provenanceProvenance No
valueRDFTerm Yes
titleResolveTitleResolve No
annotatedboolean No

RdfTermNode

NameTypeDescriptionRequired
datatypestring No
languagestring No
typestring No
valuestring No

ChangeSet

NameTypeDescriptionRequired
resourcestring No
valueChanges[ ValueChange ] No
nodeShapeIris[ string ] No
newResourceboolean No

ValueChange

NameTypeDescriptionRequired
propertyIristring No
deletes[ RDFTerm ] No
inserts[ RDFTerm ] No
propertyShapeIristring No

TitleResolve

NameTypeDescriptionRequired
iristring Yes
fromIriboolean No
titlestring Yes
langstring No
whenstring No
graphstring No

UserInfoSchema

NameTypeDescriptionRequired
accountNamestring No
uristring No

Report

NameTypeDescriptionRequired
iristring No
descriptionstring No
labelstring No
queryParameter[ string ] No

Statement

NameTypeDescriptionRequired
predicatestring Yes
subjectstring Yes
graphstring No
objectRDFTerm Yes

ResourceUsage

NameTypeDescriptionRequired
iristring No
asObjectInGraph[ ReadableGraph ] No
resolveTitleResolve No
asAnnotationValueHasMoreboolean No
asSubjectInGraph[ ReadableGraph ] No
asAnnotationValue[ ValueView ] No
asStatementValue[ Statement ] No

BaseResource

NameTypeDescriptionRequired
iristring No
commentTitleResolve No
depictionUristring No
labelTitleResolve No

PropertyValueView

NameTypeDescriptionRequired
propShapeIristring No
inversePathboolean No
uiQueryShuiSparqlQuery No
patternstring No
flagsstring No
valueQueryHideHeaderboolean No
maxCountinteger No
listQuerystring No
uniqueLangboolean No
valueQuerystring No
denyNewResourcesboolean No
propLabelTitleResolve Yes
ignoreOnCopyboolean No
nestedResourceViews[ ResourceView ] No
propShapeNamestring Yes
nodeKindstring No
groupShaclGroup No
orderlong No
propertyIristring Yes
propShapeDescriptionstring No
valueAddableboolean Yes
shClass[ string ] No
uriTemplatestring No
langIn[ string ] No
dataTypestring No
nodeShapeIris[ string ] Yes
readOnlyboolean No
showAlwaysboolean No
propCommentTitleResolve No
valueQueryHideFooterboolean No
annotateAbleboolean Yes
minCountinteger No
valueViews[ ValueView ] No
textAreaboolean No

StatementLevelMetadata

NameTypeDescriptionRequired
predicatestring Yes
metadataIristring Yes
subjectstring Yes
multiAnnotationValueCountlong Yes
objectRDFTerm Yes

RDFTerm

NameTypeDescriptionRequired
resourcestring No
termTypestring Yes
literalLiteral No

ShaclGroup

NameTypeDescriptionRequired
iristring No
depictionUristring No
commentTitleResolve No
labelTitleResolve No
orderinteger No

Prefixes

NameTypeDescriptionRequired
diPrefixesWithMultipleNamespaces[ string ] No
catalogPrefixesobject No
catalogPrefixesWithMultipleNamespaces[ string ] No
installedPrefixesobject No
installedPrefixesWithMultipleNamespaces[ string ] No
userPrefixesobject No
diNamespacesWithMultiplePrefixes[ string ] No
userPrefixesWithMultipleNamespaces[ string ] No
diPrefixesobject No
catalogNamespacesWithMultiplePrefixes[ string ] No
userNamespacesWithMultiplePrefixes[ string ] No
installedNamespacesWithMultiplePrefixes[ string ] No

StatementFilter

NameTypeDescriptionRequired
subjectFilterFilter No
objectFilterFilter No
predicateFilterFilter No

GraphResourcePattern

NameTypeDescriptionRequired
paths[ Statement ] No
classFiltersOnVariableobject No

Filter

NameTypeDescriptionRequired
functionstring No
variablestring No
parameters[ RdfTermNode ] No

ListResourceParams

NameTypeDescriptionRequired
listOptionsListOptions No
patternGraphResourcePattern No

ResourceStoreFramedSchema

NameTypeDescriptionRequired
resourcestringA valid resource URIYes
graphstringThe URI of the graph containing the resource.Yes
framestringAn optional JSON-LD frame used to force a specific JSON-LD tree layout.No

ImportTree

NameTypeDescriptionRequired
ignoredobject No
treeobject No

SaveReport

NameTypeDescriptionRequired
durationlong No
versioningCountinteger No
resourcestring No
deletedCountinteger No
startlong No
endlong No
insertedCountinteger No
metadataCountinteger No

ReportList

NameTypeDescriptionRequired
queries[ Report ] No

NodeShapeListEntry

NameTypeDescriptionRequired
iristring No
commentTitleResolve No
propertyCountinteger No
labelTitleResolve No

ReadableGraphDetailed

NameTypeDescriptionRequired
iristring Yes
wellDefinedClassesCountinteger No
triplesCountinteger No
classesCountinteger No
instancesCountinteger No
labelTitleResolve Yes