{ "openapi": "3.0.1", "info": { "title": "eccenca DataPlatform API", "description": "eccenca DataPlatform Linked Data API", "contact": { "url": "https://eccenca.com/", "email": "info@eccenca.com" }, "version": "v23.3.0" }, "servers": [ { "url": "http://localhost:9091", "description": "Generated server url" } ], "tags": [ { "name": "Data Endpoints / Resource store", "description": "Provides read and write operations for [Concise Bound Description](https://www.w3.org/Submission/CBD/#definition) of RDF resources." }, { "name": "Named Queries", "description": "Allows the listing and execution of SELECT queries via their identifiers.Provides information about the required parameters" }, { "name": "Statement-Level Metadata", "description": "Provides methods for listing, exploring and managing statement-level metadata." }, { "name": "Authorization Management API 2", "description": "API for authorization management. Access conditions can be managed using the provided methods. The requesting user must have the urn:elds-backend-actions-auth-access-control action granted to be able to use this API. Root users can manage any access condition." }, { "name": "Relations", "description": "Get relations between resources" }, { "name": "Sparql Catalog", "description": "Manages the query Catalog" }, { "name": "graphmanagement", "description": "Manages the synchronization with a configured git repository." }, { "name": "Shapes", "description": "Manages shapes and controls the interaction of shapes with the data" }, { "name": "UserInfo API", "description": "Returns user information" }, { "name": "Prefixes", "description": "Manages prefixes for shortening Resource-IRIs." }, { "name": "Vocabulary Management", "description": "Beta - This api is subject to change in the next releases without further notice.\n\n Lists all Vocabularies of the default endpoint." }, { "name": "Resources", "description": "Provides Access to the data in the Knowledge Graph. This is the primary access point for getting application data out of the platform." }, { "name": "Vocabulary usage", "description": "Detailed information about how the Knowledge graph uses vocabularies and shapes" }, { "name": "Admin QueryMonitor", "description": "Allows monitoring of currently running \u0026 recently finished queries" }, { "name": "Application Health \u0026 Info", "description": "Provides application runtime information." }, { "name": "Facets", "description": "Facets query" }, { "name": "Authorization Management API", "description": "API for authorization management. Access conditions can be managed using the provided methods. The requesting user must have the urn:elds-backend-actions-auth-access-control action granted to be able to use this API. Root users can manage any access condition." }, { "name": "Accessible graphs", "description": "Get a list of graph URIs the requesting user is allowed to read or write." }, { "name": "navlist", "description": "Navigates the Knowledgegraph and by searching and listing resources and relations" }, { "name": "Admin Backup/Restore/Bootstrap", "description": "@Beta. All operations are subject to change without further notice. \n Allows administrative backup/restore and bootstrap operations.\nHandle with care!" }, { "name": "Workspace Config Controller", "description": "Provides access to workspace configurations. There are three types of configurations. A system workspace configuration is read only and provides a full set of properties which are fixed by CMEM. They are the very default. A project / base config default is a change set to the system workspace configuration and only contains the changed properties. The id of the default workspace is the fixed value \u0027default\u0027. A custom workspace is a change set to the project / base config default." }, { "name": "Data Endpoints / SPARQL Graph Store", "description": "This protocol specifies the semantics of HTTP operations for managing a Graph Store.\n In particular, it provides operations for removing, creating, and replacing RDF graph content as well as for adding RDF statements to existing RDF graph content." }, { "name": "Data Endpoints", "description": "A collection of provided semantic data endpoints. Each endpoint is equipped with a set of APIs." }, { "name": "Label Resolution", "description": "Resolves a iri to a short form label. If none can be found in the data, the iri itself is used to create one." }, { "name": "Application Loggers", "description": "Allows the management of the application\u0027s logging levels.\n This endpoint is only accessible by root users (see section *Root access* of the System Manual)." }, { "name": "Data Endpoints / SPARQL Query", "description": "The query operation is used to send a [SPARQL 1.1 Query](https://www.w3.org/TR/sparql11-query/) and receive its results. The query operation MUST be invoked with either the HTTP GET or HTTP POST method. Client requests for this operation must include exactly one SPARQL query string (parameter name: `query`) and may include zero or more default graph URIs (parameter name: `default-graph-uri`) and named graph URIs (parameter name: `named-graph-uri`). The response to a query request is either the [SPARQL XML Results Format](https://www.w3.org/TR/rdf-sparql-XMLres/), the [SPARQL JSON Results Format](https://www.w3.org/TR/sparql11-results-json/), the [SPARQL CSV/TSV Results Format](https://www.w3.org/TR/sparql11-results-csv-tsv/), or an RDF serialization, depending on the [query form](https://www.w3.org/TR/sparql11-query/#QueryForms) and [content negotiation](https://www.w3.org/Protocols/rfc2616/rfc2616-sec12.html)." }, { "name": "Charts Config Controller", "description": "Provides access to charts configurations. " }, { "name": "Actions", "description": "Get a list of action URIs the requesting user is allowed to perform." }, { "name": "Application Health \u0026 Info (Legacy)", "description": "Provides application runtime information." }, { "name": "gitsync", "description": "Manages the synchronization with a configured git repository." }, { "name": "Search", "description": "Search related operations" } ], "paths": { "/health": { "get": { "tags": [ "Application Health \u0026 Info (Legacy)" ], "summary": "Shows application health information.", "description": "Shows application health information to check the status of the application.\n Admin users will get a detailed status description,\n all others will see a simple ‘status’ message.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "UP", "DOWN" ] } } }, "example": "{\"status\": \"UP\"}" } } } } } }, "/info": { "get": { "tags": [ "Application Health \u0026 Info (Legacy)" ], "summary": "Shows arbitrary application.", "description": "Displays arbitrary application info, such as program version etc.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "string" }, "example": "{\n \"name\": \"eccenca DataPlatform\",\n \"version\": \"v22.1.1\"\n}" } } } } } }, "/actuator/health": { "get": { "tags": [ "Application Health \u0026 Info" ], "summary": "Shows application health information.", "description": "Shows application health information to check the status of the application.\n Admin users will get a detailed status description,\n all others will see a simple ‘status’ message.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "UP", "DOWN" ] } } }, "example": "{\"status\": \"UP\"}" } } } } } }, "/actuator/info": { "get": { "tags": [ "Application Health \u0026 Info" ], "summary": "Shows arbitrary application.", "description": "Displays arbitrary application info, such as program version etc.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "string" }, "example": "{\n \"name\": \"eccenca DataPlatform\",\n \"version\": \"v22.1.1\"\n}" } } } } } }, "/actuator/loggers": { "get": { "tags": [ "Application Loggers" ], "summary": "Displays all accepted logging levels and loggers.", "description": "Displays all accepted logging levels as well as the currently configured loggers.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "string" }, "example": "{\n \"levels\":[\"OFF\",\"ERROR\",\"WARN\",\"INFO\",\"DEBUG\",\"TRACE\"],\n \"loggers\":{\n \"ROOT\":{\"configuredLevel\":\"DEBUG\",\"effectiveLevel\":\"DEBUG\"},\n \"Jena\":{\"configuredLevel\":null,\"effectiveLevel\":\"DEBUG\"},\n \"SPARQL\":{\"configuredLevel\":\"ERROR\",\"effectiveLevel\":\"ERROR\"},\n \"audit\":{\"configuredLevel\":\"INFO\",\"effectiveLevel\":\"INFO\"},\n \"com\":{\"configuredLevel\":null,\"effectiveLevel\":\"DEBUG\"},\n \"com.eccenca\":{\"configuredLevel\":null,\"effectiveLevel\":\"DEBUG\"},\n \"com.eccenca.elds\":{\"configuredLevel\":null,\"effectiveLevel\":\"DEBUG\"},\n \"com.eccenca.elds.backend\":\n {\"configuredLevel\":\"DEBUG\",\"effectiveLevel\":\"DEBUG\"},\n \"com.eccenca.elds.backend.cache\":\n {\"configuredLevel\":null,\"effectiveLevel\":\"DEBUG\"}\n }\n}" } } }, "401": { "description": "Access denied for the current user. The access token is invalid." }, "403": { "description": "Access denied for the current user. Only root users can use this endpoint." } }, "security": [ { "bearerAuth": [] } ] } }, "/actuator/logger/{logger}": { "get": { "tags": [ "Application Loggers" ], "summary": "Application loggers by name.", "description": "Display the configured logging level for the specified logger.", "parameters": [ { "name": "logger", "in": "path", "description": "The name of the logger to manage", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "Example": { "schema": { "type": "string" }, "example": "{\"configuredLevel\":\"DEBUG\",\"effectiveLevel\":\"DEBUG\"}" } } }, "400": { "description": "The logging level couldn\u0027t be changed due to a malformed request.\n Refer to the response body for a detailed error description." }, "401": { "description": "Access denied for the current user. The access token is invalid." }, "403": { "description": "Access denied for the current user. Only root users can use this endpoint." } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Application Loggers" ], "summary": "Change the configured logging level for the specified logger.", "description": "Change the configured logging level for the specified logger.", "parameters": [ { "name": "logger", "in": "path", "description": "The name of the logger to manage", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Example": { "value": "{\"configuredLevel\":\"TRACE\"}" } } } }, "required": true }, "responses": { "200": { "description": "The logging level was configured successfully." }, "400": { "description": "The logging level couldn\u0027t be changed due to a malformed request.\n Refer to the response body for a detailed error description." }, "401": { "description": "Access denied for the current user. The access token is invalid." }, "403": { "description": "Access denied for the current user. Only root users can use this endpoint." }, "415": { "description": "If no or a wrong `Conent-Type` header is given." } }, "security": [ { "bearerAuth": [] } ] } }, "/graphs/graphs/{id}/read": { "put": { "tags": [ "Accessible graphs" ], "operationId": "graphsReadDeprecated_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "graphUri", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Accessible graphs" ], "operationId": "graphsReadDeprecated_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "graphUri", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Accessible graphs" ], "operationId": "graphsReadDeprecated_4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "graphUri", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] }, "options": { "tags": [ "Accessible graphs" ], "operationId": "graphsReadDeprecated_5", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "graphUri", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] }, "head": { "tags": [ "Accessible graphs" ], "operationId": "graphsReadDeprecated", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "graphUri", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Accessible graphs" ], "operationId": "graphsReadDeprecated_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "graphUri", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/proxy/{id}/resource": { "get": { "tags": [ "Data Endpoints / Resource store" ], "summary": "Returns the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the requested resource in the given graph.", "description": "Returns the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the requested resource in the given graph.", "operationId": "resourceStoreGet", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } }, { "name": "resource", "in": "query", "description": "A valid resource URI", "required": true, "schema": { "type": "string" }, "example": "http://example.org/person/Mark_Twain" }, { "name": "graph", "in": "query", "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "required": true, "schema": { "type": "string" }, "example": "http://example.org/graph" } ], "responses": { "403": { "$ref": "#/components/responses/g403" }, "204": { "$ref": "#/components/responses/g204" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "503": { "$ref": "#/components/responses/g503" }, "200": { "description": "The request was processed successfully.", "content": { "text/turtle": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" }, "example": "N/A" }, "application/rdf+xml": { "schema": { "type": "string" }, "example": "N/A" }, "application/ld+json": { "schema": { "type": "string" }, "example": "N/A" } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Data Endpoints / Resource store" ], "summary": "Replaces the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the given resource contained in the supplied graph.", "description": "Replaces the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the given resource contained in the supplied graph.", "operationId": "resourceStorePut", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } }, { "name": "resource", "in": "query", "description": "A valid resource URI", "required": true, "schema": { "type": "string" }, "example": "http://example.org/person/Mark_Twain" }, { "name": "graph", "in": "query", "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "required": true, "schema": { "type": "string" }, "example": "http://example.org/graph" } ], "requestBody": { "content": { "text/turtle": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" }, "example": "\u003curn:Mark_Twain\u003e \u003curn:author\u003e \u003curn:Huckleberry_Finn\u003e ." }, "application/rdf+xml": { "schema": { "type": "string" } }, "application/ld+json": { "schema": { "type": "string" } } } }, "responses": { "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "503": { "$ref": "#/components/responses/g503" }, "204": { "$ref": "#/components/responses/g204NC" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Data Endpoints / Resource store" ], "summary": "Adds the given statements to the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the given resource in the supplied graph.", "description": "Adds the given statements to the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the given resource in the supplied graph.", "operationId": "resourceStorePost", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } }, { "name": "resource", "in": "query", "description": "A valid resource URI", "required": true, "schema": { "type": "string" }, "example": "http://example.org/person/Mark_Twain" }, { "name": "graph", "in": "query", "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "required": true, "schema": { "type": "string" }, "example": "http://example.org/graph" }, { "name": "replace", "in": "query", "description": "This optional parameter can be used to trigger a delete operation before storing the data.\n 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).\n If none of those restrictions apply, the use of the PUT method is recommended for standard compliance.", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "204": { "$ref": "#/components/responses/g204NC" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Data Endpoints / Resource store" ], "summary": "Deletes the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the provided resource contained by the provided graph.", "description": "Deletes the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the provided resource contained by the provided graph.", "operationId": "resourceStoreDelete", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } }, { "name": "resource", "in": "query", "description": "A valid resource URI", "required": true, "schema": { "type": "string" }, "example": "http://example.org/person/Mark_Twain" }, { "name": "graph", "in": "query", "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "required": true, "schema": { "type": "string" }, "example": "http://example.org/graph" }, { "name": "symmetric", "in": "query", "description": "If set to true the symmetric CBD of the resource will be deleted, otherwise the right-bounded CBD (resource in subject)", "required": false, "schema": { "type": "boolean", "default": true }, "example": true }, { "name": "customizedDelete", "in": "query", "description": "If set to true the customized delete queries in applicable node shapes are being executed in node shape order", "required": false, "schema": { "type": "boolean", "default": true }, "example": true } ], "responses": { "204": { "$ref": "#/components/responses/g204" } }, "security": [ { "bearerAuth": [] } ] }, "head": { "tags": [ "Data Endpoints / Resource store" ], "summary": "Equivalent to a GET request, but without a response body.", "description": "Equivalent to a GET request, but without a response body.", "operationId": "resourceStoreHead", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } }, { "name": "resource", "in": "query", "description": "A valid resource URI", "required": true, "schema": { "type": "string" }, "example": "http://example.org/person/Mark_Twain" }, { "name": "graph", "in": "query", "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "required": true, "schema": { "type": "string" }, "example": "http://example.org/graph" } ], "responses": { "403": { "$ref": "#/components/responses/g403" }, "200": { "description": "The request was processed successfully." }, "204": { "$ref": "#/components/responses/g204" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "503": { "$ref": "#/components/responses/g503" } }, "security": [ { "bearerAuth": [] } ] } }, "/proxy/{id}/graph": { "get": { "tags": [ "SPARQL Graph Store", "Data Endpoints / SPARQL Graph Store" ], "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.", "operationId": "sparqlGraphStoreGet", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } }, { "name": "graph", "in": "query", "description": "A valid graph URI / IRI as described in [SPARQL 1.1 Graph Store HTTP Protocol](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification).", "required": true, "schema": { "type": "string" }, "example": "http://example.org" }, { "name": "owlImportsResolution", "in": "query", "description": "Enable/disable OWL imports resolution for this query.", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "204": { "$ref": "#/components/responses/sgs204" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "406": { "$ref": "#/components/responses/g406" }, "503": { "$ref": "#/components/responses/g503" }, "200": { "$ref": "#/components/responses/sgs200Get" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Data Endpoints / SPARQL Graph Store" ], "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.", "operationId": "sparqlGraphStorePut", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } }, { "name": "graph", "in": "query", "description": "A valid graph URI / IRI as described in [SPARQL 1.1 Graph Store HTTP Protocol](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification).", "required": true, "schema": { "type": "string" }, "example": "http://example.org" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "The uploaded Turtle (`.ttl`), NTriples (`.nt`), RDF/XML (`.rdf` or `.owl`), JSON-LD (`.jsonld`), N-Quads (`.nq`) or TriG (`.trig`) file content. Max filesize is set to 1024MB which can be adjusted in the config.", "format": "binary" } } } } }, "required": true }, "responses": { "415": { "$ref": "#/components/responses/sgs415" }, "503": { "$ref": "#/components/responses/sgs503" }, "403": { "$ref": "#/components/responses/g403" }, "409": { "$ref": "#/components/responses/sgs409" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "204": { "$ref": "#/components/responses/g204NC" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Data Endpoints / SPARQL Graph Store" ], "summary": "SPARQL Graph Store HTTP POST", "description": "Stores the given tuples in the underlying endpoint.\n If triples are provided, they are stored in the given graph.\n 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.", "operationId": "sparqlGraphStorePostMultipartFormData", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } }, { "name": "graph", "in": "query", "description": "A valid graph URI / IRI as described in [SPARQL 1.1 Graph Store HTTP Protocol](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification).", "required": true, "schema": { "type": "string" }, "example": "http://example.org" }, { "name": "replace", "in": "query", "description": "This optional (non-standard) parameter can be used to trigger a delete operation before storing the data.\n 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).\n If none of those restrictions apply, the use of the PUT method is recommended for standard compliance.", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "The uploaded Turtle (`.ttl`), NTriples (`.nt`), RDF/XML (`.rdf` or `.owl`), JSON-LD (`.jsonld`), N-Quads (`.nq`) or TriG (`.trig`) file content. Max filesize is set to 1024MB which can be adjusted in the config.", "format": "binary" } } } } }, "required": true }, "responses": { "415": { "$ref": "#/components/responses/sgs415" }, "503": { "$ref": "#/components/responses/sgs503" }, "403": { "$ref": "#/components/responses/g403" }, "409": { "$ref": "#/components/responses/sgs409" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "204": { "$ref": "#/components/responses/g204NC" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "SPARQL Graph Store", "Data Endpoints / SPARQL Graph Store" ], "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.", "operationId": "sparqlGraphStoreDelete", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } }, { "name": "graph", "in": "query", "description": "A valid graph URI / IRI as described in [SPARQL 1.1 Graph Store HTTP Protocol](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification).", "required": true, "schema": { "type": "string" }, "example": "http://example.org" } ], "responses": { "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "503": { "$ref": "#/components/responses/g503" }, "204": { "$ref": "#/components/responses/g204NC" } }, "security": [ { "bearerAuth": [] } ] }, "head": { "tags": [ "SPARQL Graph Store", "Data Endpoints / SPARQL Graph Store" ], "summary": "SPARQL Graph Store HTTP HEAD", "description": "This method is identical to GET except that the server MUST NOT return a message-body in the response.\n It is meant to be used for testing dereferenceable IRIs for validity, accessibility, and recent modification.", "operationId": "sparqlGraphStoreHead", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } }, { "name": "graph", "in": "query", "description": "A valid graph URI / IRI as described in [SPARQL 1.1 Graph Store HTTP Protocol](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification).", "required": true, "schema": { "type": "string" }, "example": "http://example.org" }, { "name": "owlImportsResolution", "in": "query", "description": "Enable/disable OWL imports resolution for this query.", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "204": { "$ref": "#/components/responses/sgs204" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "503": { "$ref": "#/components/responses/g503" }, "200": { "$ref": "#/components/responses/sgs200Head" } }, "security": [ { "bearerAuth": [] } ] } }, "/authorization/conditions": { "get": { "tags": [ "Authorization Management API" ], "summary": "Retrieve all access conditions manageable by the user or a specific one (see the `resource` parameter description).", "operationId": "getAccessConditions", "parameters": [ { "name": "resource", "in": "query", "description": "Retrieve only the access condition identified by the given IRI.", "required": false, "schema": { "type": "string" }, "example": "http://eccenca.com/PublicAccessCondition" } ], "responses": { "200": { "description": "Successful access condition replacement. The response body contains the newly replaced access condition.", "content": { "text/turtle": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" }, "example": "N/A" }, "application/rdf+xml": { "schema": { "type": "string" }, "example": "N/A" }, "application/ld+json": { "schema": { "type": "string" }, "example": "N/A" } } }, "204": { "description": "The access condition model is empty." }, "404": { "description": "The access condition does not exist." }, "403": { "description": "The user is not allowed to manage the access condition or does not have permission to execute this action." } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Authorization Management API" ], "summary": "Updates access conditions.", "description": "Replaces the access condition with the properties provided in the request body.\n 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`).\n Optionally, the access condition can be annotated with the properties `rdfs:label` and `rdfs:comment`.\n 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.\n 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.\n Further annotations will be rejected.\n The access condition (identified by its IRI) must already exist in the store.\n A blank node is not allowed as the access condition resource identifier.\n Identifiers (IRIs) will be created by the server for valid blank node elements (accounts, groups).", "operationId": "putAccessCondition", "parameters": [ { "name": "resource", "in": "query", "description": "The IRI of the access condition to replace.", "required": true, "schema": { "type": "string" }, "example": "http://eccenca.com/PublicAccessCondition" } ], "requestBody": { "description": "The new access condition.", "content": { "text/turtle": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" }, "example": "N/A" }, "application/rdf+xml": { "schema": { "type": "string" }, "example": "N/A" }, "application/ld+json": { "schema": { "type": "string" }, "example": "N/A" } }, "required": true }, "responses": { "200": { "description": "Successful access condition replacement. The response body contains the newly replaced access condition.", "content": { "text/turtle": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" }, "example": "N/A" }, "application/rdf+xml": { "schema": { "type": "string" }, "example": "N/A" }, "application/ld+json": { "schema": { "type": "string" }, "example": "N/A" } } }, "403": { "description": "The 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." }, "422": { "description": "The access condition was not stored because it is not valid." }, "404": { "description": "The access condition does not exist." }, "405": { "description": "The access condition could not be replaced because the access conditions model is not modifiable." } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Authorization Management API" ], "summary": "Creates access conditions.", "description": "Store a new access condition with the properties provided in the request body.\n 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`).\n Optionally, the access condition can be annotated with the properties `rdfs:label` and `rdfs:comment`.\n 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.\n 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.\n Further annotations will be rejected.\n The access condition must be anonymous (blank node as subject).\n Identifiers (IRIs) will be created by the server for valid blank node elements (access condition, accounts, groups).", "operationId": "postAccessCondition", "requestBody": { "description": "Access condition to store.", "content": { "text/turtle": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" }, "example": "N/A" }, "application/rdf+xml": { "schema": { "type": "string" }, "example": "N/A" }, "application/ld+json": { "schema": { "type": "string" }, "example": "N/A" } }, "required": true }, "responses": { "405": { "description": "The access condition could not be added because the access conditions model is not modifiable." }, "422": { "description": "The access condition is not valid." }, "201": { "description": "Successful access condition creation. The response body contains the newly replaced access condition.", "content": { "text/turtle": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" }, "example": "N/A" }, "application/rdf+xml": { "schema": { "type": "string" }, "example": "N/A" }, "application/ld+json": { "schema": { "type": "string" }, "example": "N/A" } } }, "403": { "description": "The 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." } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Authorization Management API" ], "summary": "Delete an existing access condition with the given name.", "description": "Delete an existing access condition with the given name.", "operationId": "deleteAccessCondition", "parameters": [ { "name": "resource", "in": "query", "description": "The IRI of the access condition to be deleted.", "required": true, "schema": { "type": "string" }, "example": "http://eccenca.com/PublicAccessCondition" } ], "responses": { "204": { "description": "Removal of the access condition was successful." }, "404": { "description": "The access condition does not exist." }, "405": { "description": "The access condition could not be removed because the access conditions model is not modifiable." }, "403": { "description": "The user is not allowed to delete the access condition or does not have permission to execute this action." } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/api/querycatalog": { "get": { "tags": [ "Sparql Catalog" ], "description": "Lists all queries in the catalog", "operationId": "listQueries", "parameters": [ { "name": "langPref", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "default": [] } }, { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string", "default": "https://ns.eccenca.com/data/queries/" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListResponseCatalogQuery" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Sparql Catalog" ], "description": "Update an existing query with the provided values. Modified dates are automatically set.", "operationId": "updateQuery", "parameters": [ { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string", "default": "https://ns.eccenca.com/data/queries/" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogQuery" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CatalogQuery" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Sparql Catalog" ], "description": "Create a new query from the provided object. For Iri, either let the backend create a new one, by providing a valid blank node identifier, i.e. \u0027_:1\u0027.Alternatively, provide a IRI.Creation and modified dates will be replaced.", "operationId": "createQuery", "parameters": [ { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string", "default": "https://ns.eccenca.com/data/queries/" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogQuery" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CatalogQuery" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Sparql Catalog" ], "description": "Deletes the specified query. Deletes only the data that was created with this api.", "operationId": "deleteQuery", "parameters": [ { "name": "queryIri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "modifiedDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string", "default": "https://ns.eccenca.com/data/queries/" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/navigate/viz": { "get": { "tags": [ "navlist" ], "description": "Get a specific visualisation, with node positions", "operationId": "getVisualization", "parameters": [ { "name": "langPref", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "vizIri", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vizualization" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "navlist" ], "description": "Updates an existing visualisation", "operationId": "writeVisualization", "parameters": [ { "name": "vizIri", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vizualization" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "navlist" ], "description": "Creates a new visualisation", "operationId": "createVisualization", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vizualization" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CreateResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "navlist" ], "description": "Delete a specific visualisation", "operationId": "deleteVisualization", "parameters": [ { "name": "vizIri", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/gitsync/setgraphtorevision": { "put": { "tags": [ "gitsync" ], "operationId": "setGraphToRevision", "parameters": [ { "name": "graphIri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "commitId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/gitsync/gitSyncEnabled": { "get": { "tags": [ "gitsync" ], "operationId": "getGitSyncEnable", "parameters": [ { "name": "graphIri", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "gitsync" ], "operationId": "setGitSyncEnable", "parameters": [ { "name": "graphIri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "gitSyncEnable", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/conf/workspaces/projectDefault": { "get": { "tags": [ "Workspace Config Controller" ], "summary": "Returns project workspace diff to system default workspace", "operationId": "getProjectDefaultDiff", "responses": { "200": { "description": "Workspace configuration retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Workspace Config Controller" ], "summary": "Updates the project default workspace", "operationId": "updateProjectWorkspaceDefault", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } }, "required": true }, "responses": { "400": { "description": "The request is formally not valid" }, "204": { "description": "Project default workspace is updated" }, "403": { "description": "The user is not allowed to store workspace configurations" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/conf/workspaces/customWorkspaces/{id}": { "get": { "tags": [ "Workspace Config Controller" ], "summary": "Returns a custom workspace diff to project default workspace", "operationId": "getCustomWorkspace", "parameters": [ { "name": "id", "in": "path", "description": "ID of custom workspace", "required": true, "schema": { "type": "string" }, "example": "workspace1" } ], "responses": { "403": { "description": "The user is not allowed to read workspace configurations", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } }, "404": { "description": "Workspace configuration not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } }, "200": { "description": "Workspace configuration retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Workspace Config Controller" ], "summary": "Updates a custom workspace or creates a new one if it does not exist", "operationId": "updateCustomWorkspace", "parameters": [ { "name": "id", "in": "path", "description": "ID of custom workspace", "required": true, "schema": { "type": "string" }, "example": "workspace1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } }, "required": true }, "responses": { "400": { "description": "The request is formally not valid" }, "200": { "description": "Custom workspace is updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } }, "403": { "description": "The user is not allowed to store workspace configurations" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Workspace Config Controller" ], "summary": "Deletes a custom workspace configuration", "operationId": "deleteCustomWorkspace", "parameters": [ { "name": "id", "in": "path", "description": "ID of custom workspace", "required": true, "schema": { "type": "string" }, "example": "workspace1" } ], "responses": { "404": { "description": "Workspace configuration not found" }, "403": { "description": "The user is not allowed to store workspace configurations" }, "204": { "description": "Workspace configuration deleted" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/conf/charts/iri": { "get": { "tags": [ "Charts Config Controller" ], "summary": "Returns the chart configuration with given id", "operationId": "getChartConfiguration", "parameters": [ { "name": "iri", "in": "query", "description": "IRI of configuration", "required": true, "schema": { "type": "string" }, "example": "urn:chart1" }, { "name": "contextGraph", "in": "query", "description": "Context graph from which to read configurations", "required": false, "schema": { "type": "string", "default": "Optional[https://ns.eccenca.com/data/queries/]" }, "example": "https://ns.eccenca.com/data/queries/" } ], "responses": { "403": { "description": "The user is not allowed to read workspace configurations", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } }, "404": { "description": "Workspace configuration not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } }, "200": { "description": "Workspace configuration retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Charts Config Controller" ], "summary": "Updates a chart configuration if it does not exist", "operationId": "updateChartConfiguration", "parameters": [ { "name": "contextGraph", "in": "query", "description": "Context graph to write configurations to", "required": false, "schema": { "type": "string", "default": "Optional[https://ns.eccenca.com/data/queries/]" }, "example": "https://ns.eccenca.com/data/queries/" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } }, "required": true }, "responses": { "400": { "description": "The request is formally not valid", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } }, "200": { "description": "Chart configuration is updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } }, "403": { "description": "The user is not allowed to store chart configurations", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Charts Config Controller" ], "summary": "Deletes a chart configuration", "operationId": "deleteChartConfiguration", "parameters": [ { "name": "iri", "in": "query", "description": "IRI of chart configuration", "required": true, "schema": { "type": "string" }, "example": "urn:chart1" }, { "name": "contextGraph", "in": "query", "description": "Context graph to write configurations to", "required": false, "schema": { "type": "string", "default": "Optional[https://ns.eccenca.com/data/queries/]" }, "example": "https://ns.eccenca.com/data/queries/" } ], "responses": { "204": { "description": "Chart configuration deleted" }, "404": { "description": "Chart configuration not found" }, "403": { "description": "The user is not allowed to store chart configurations" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/authorization": { "get": { "tags": [ "Authorization Management API 2" ], "summary": "Returns the list of all access conditions sorted/filtered based on the query parameters", "operationId": "accessConditionList", "parameters": [ { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Access conditions retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAccessConditionView" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Authorization Management API 2" ], "summary": "Updates an existing access condition", "description": "Updates the access condition with the properties provided in the request body. All relevant fields must be explicitly set", "operationId": "accessConditionUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccessConditionRequest" } } }, "required": true }, "responses": { "404": { "description": "The access condition does not exist.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } }, "200": { "description": "Successful access condition replacement. The response body contains the newly replaced access condition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } }, "400": { "description": "The request is formally not valid", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } }, "403": { "description": "The 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.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Authorization Management API 2" ], "summary": "Create a new access condition", "operationId": "accessConditionCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccessConditionRequest" } } }, "required": true }, "responses": { "400": { "description": "The request is formally not valid", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } }, "403": { "description": "The 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.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } }, "201": { "description": "Access condition is created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Authorization Management API 2" ], "summary": "Delete an existing access condition with the given IRI.", "description": "Delete an existing access condition with the given iri.", "operationId": "accessConditionDelete", "parameters": [ { "name": "resource", "in": "query", "description": "The IRI of the access condition to be deleted.", "required": true, "schema": { "type": "string" }, "example": "http://eccenca.com/PublicAccessCondition" } ], "responses": { "404": { "description": "The access condition does not exist.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } }, "403": { "description": "The user is not allowed to delete the access condition or does not have permission to execute this action.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } }, "200": { "description": "Removal of the access condition was successful. The body contains the deleted access condition.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/proxy/{id}/update": { "post": { "tags": [ "Data Endpoints" ], "summary": "The update operation is used to send a [SPARQL 1.1 update](https://www.w3.org/TR/sparql11-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. \nImportant 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\".", "operationId": "sparqlUpdatePost", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "using-graph-uri", "in": "query", "description": "default graph URI, may include zero or more.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "using-named-graph-uri", "in": "query", "description": "URL-encoded named graph URI, may include zero or more.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "base64encoded", "in": "query", "description": "Is the update param Base64-encoded?", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/sparql-update": { "schema": { "type": "string", "description": "SPARQL update query" } } }, "required": true }, "responses": { "400": { "description": "Bad request. Possible causes are either a wrong query syntax or a modification attempt of the default graph (refer to the section *SPARQL Default Graph \u0026 RDF Dataset* of the developer manual for more information regarding this topic)." }, "202": { "description": "The update query was processed successfully, however not fully. This typically means that further tasks still have to be post-processed." }, "503": { "$ref": "#/components/responses/g503" }, "409": { "description": "Transaction aborted due to deadlock. Retrying should solve the problem." }, "204": { "$ref": "#/components/responses/g204NC" } }, "security": [ { "bearerAuth": [] } ] } }, "/proxy/{id}/update/manualedit": { "post": { "tags": [ "Manual Edit" ], "operationId": "updateUrlEncodedPost", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "inserts", "in": "query", "required": false, "schema": { "maxLength": 1000000, "minLength": 0, "type": "string", "default": "" } }, { "name": "deletes", "in": "query", "required": false, "schema": { "maxLength": 1000000, "minLength": 0, "type": "string", "default": "" } }, { "name": "queries", "in": "query", "required": false, "schema": { "maxLength": 1000000, "minLength": 0, "type": "string", "default": "" } }, { "name": "shape", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "primaryResource", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "graph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "comment", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/proxy/{id}/sparql/framed": { "post": { "tags": [ "Data Endpoints / SPARQL Query" ], "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.", "operationId": "sparqlQueryPostFramed", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SparqlQueryFramedSchema" } } }, "required": true }, "responses": { "400": { "$ref": "#/components/responses/g400" }, "503": { "$ref": "#/components/responses/g503" }, "200": { "description": "Returns the result of the SPARQL CONSTRUCT query, which will be an RDF model in JSON-LD syntax)", "content": { "application/ld+json": { "schema": { "type": "string" } } } }, "409": { "description": "Query has been cancelled by another user/client.", "content": {} } }, "security": [ { "bearerAuth": [] } ] } }, "/proxy/{id}/resource/framed": { "post": { "tags": [ "Data Endpoints / Resource store" ], "summary": "Returns the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the requested resource in the given graph.", "description": "Returns the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the requested resource in the given graph. Provides [Concise Bound Description](https://www.w3.org/Submission/CBD/#definition) read access of RDF resources in JSON-LD format.\n An optional [JSON-LD frame](https://json-ld.org/spec/latest/json-ld-framing/) can be provided to force a specific tree layout to the JSON-LD results.", "operationId": "resourceStorePostFramed", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ResourceStoreFramedSchema" } } } }, "responses": { "403": { "$ref": "#/components/responses/g403" }, "204": { "$ref": "#/components/responses/g204" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "503": { "$ref": "#/components/responses/g503" }, "200": { "description": "The request was processed successfully.", "content": { "application/ld+json": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/graphs/api/graphs/writeCheck": { "post": { "tags": [ "Accessible graphs" ], "summary": "Writable graphs", "description": "Check, wether a user can write to the graphs", "operationId": "validateGraphsWritable", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The List of Graphs to be checked", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "The request was processed successfully.", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "type": "boolean" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/authorization/conditions/framed": { "post": { "tags": [ "Authorization Management API" ], "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](http://json-ld.org/spec/latest/json-ld-framing/).", "operationId": "authorizationConditionsFramedPost", "parameters": [ { "name": "resource", "in": "query", "description": "Retrieve only the access condition identified by the given IRI.", "required": false, "schema": { "type": "string" }, "example": "http://eccenca.com/PublicAccessCondition" } ], "requestBody": { "content": { "application/ld-frame+json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "The access condition does not exist." }, "403": { "description": "The user is not allowed to manage the access condition or does not have permission to execute this action." }, "204": { "description": "The access conditions model is empty." }, "400": { "description": "The given JSON-LD frame is malformed." }, "200": { "description": "Successful retrieval of the requested access condition(s).", "content": { "application/ld+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/api/vocabusage/propertyUsageSampling": { "post": { "tags": [ "property usage analytics", "Vocabulary usage" ], "description": "For the given properties, a set of statements in the context graph with the property, limited in size to *samplingDepth* is examined for(i) explicit classes of subject resources (ii) explicit classes of object resource(íii) datatype of object literals", "operationId": "getUsageSampling", "parameters": [ { "name": "propertyIris", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "samplingDepth", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyUsage" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/vocabusage/propertyUsageAnalytics": { "post": { "tags": [ "property usage analytics", "Vocabulary usage" ], "description": "For a given properties, all statements in the context graph with the property are examined for(i) explicit classes of subject resources (ii) explicit classes of object resource(íii) datatype of object literals", "operationId": "getPropertyUsage", "parameters": [ { "name": "propertyIris", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyUsage" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/upload/transfer": { "post": { "tags": [ "upload-controller" ], "description": "Uploads previously analyzed files of one given analysis. Immediately returns id for transfer.", "operationId": "uploadStoredFile", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadRequest" } } }, "required": true }, "responses": { "404": { "description": "Requested analysis id not found OR Requested file id for upload not found.", "content": { "*/*": { "schema": { "type": "string" } } } }, "400": { "description": "Requested file ids do not match analysis results", "content": { "*/*": { "schema": { "type": "string" } } } }, "200": { "description": "Upload is queued and transfer id given", "content": { "*/*": { "schema": { "type": "string" } } } }, "403": { "description": "The current user is not authorized to write the requested graphs ", "content": { "*/*": { "schema": { "type": "string" } } } }, "500": { "description": "File could not be stored due to technical reasons - please contact administrator", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/upload/": { "post": { "tags": [ "upload-controller" ], "description": "Stores a file temporarily for later analysis. Returns id for upload", "operationId": "storeFile", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "Archive in format Zip (`.zip`) containing / or single file in format Turtle (`.ttl`), NTriples (`.nt`), RDF/XML (`.rdf` or `.owl`), JSON-LD (`.jsonld`), N-Quads (`.nq`) or TriG (`.trig`) file content. Max filesize is set to 1024MB which can be adjusted in the config.", "format": "binary" } } } } } }, "responses": { "415": { "description": "Unsupported media type - file format not valid", "content": { "*/*": { "schema": { "type": "string" } } } }, "500": { "description": "File could not be stored due to technical reasons - please contact administrator", "content": { "*/*": { "schema": { "type": "string" } } } }, "200": { "description": "File successfully stored and uploadId returned", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/statement": { "post": { "tags": [ "Statement-Level Metadata" ], "description": "Checks if the given statement is a annotated. HTTP POST is used, to enable safe RequestBody ", "operationId": "isStatementAnnotated", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statement to be searched for", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/resources": { "post": { "tags": [ "Statement-Level Metadata" ], "description": "Fetches the list of rdf:Statements resources that contain the actual reification information", "operationId": "getReificationResources", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statement to be searched for", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatementLevelMetadata" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/disconnect": { "post": { "tags": [ "Statement-Level Metadata" ], "operationId": "disconnect", "parameters": [ { "name": "resource", "in": "query", "description": "the resource to be connected to the statements", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statements to be disconnected from the resource", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/connectedStatement": { "post": { "tags": [ "Statement-Level Metadata" ], "operationId": "getConnectedStatements", "parameters": [ { "name": "resource", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "default": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "langPref", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "inferPredicateFilter", "in": "query", "description": "if 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. ", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RichStatement" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/connectedStatementSubjectCand": { "post": { "tags": [ "Statement-Level Metadata" ], "operationId": "getConnectedSubjectCandidate", "parameters": [ { "name": "resource", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "searchTerm", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "langPref", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResource" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/connectedStatementCount": { "post": { "tags": [ "Statement-Level Metadata" ], "operationId": "getConnectedStatementsCount", "parameters": [ { "name": "resource", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "inferPredicateFilter", "in": "query", "description": "if 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. ", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "integer", "format": "int64" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/connectableStatement": { "post": { "tags": [ "Statement-Level Metadata" ], "operationId": "getConnectableStatements", "parameters": [ { "name": "resource", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "langPref", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "inferPredicateFilter", "in": "query", "description": "if 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. ", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RichStatement" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/connectableStatementSubjectCand": { "post": { "tags": [ "Statement-Level Metadata" ], "operationId": "getConnectableSubjectCandidate", "parameters": [ { "name": "resource", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "searchTerm", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "langPref", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResource" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/connectableStatementCount": { "post": { "tags": [ "Statement-Level Metadata" ], "operationId": "getConnectableStatementsCount", "parameters": [ { "name": "resource", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "inferPredicateFilter", "in": "query", "description": "if 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. ", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "integer", "format": "int64" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/connect": { "post": { "tags": [ "Statement-Level Metadata" ], "operationId": "connect", "parameters": [ { "name": "resource", "in": "query", "description": "the resource to be connected to the statements", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statements to be connected to the resource", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/search": { "post": { "tags": [ "Search" ], "operationId": "listResource", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceListParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListResourceResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/search/indexed": { "post": { "tags": [ "Search", "Properties" ], "description": "Checks if an path has full text search", "operationId": "validateIsIndexed", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Path" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/search/generateResourceListQuery": { "post": { "tags": [ "Search" ], "operationId": "generateResourceListQuery", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceListParseResult" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/search/generateQuery": { "post": { "tags": [ "Search" ], "operationId": "generateQuery", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceListParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceListQuery" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/search/generateQueryBody": { "post": { "tags": [ "Search" ], "operationId": "generateQueryBody", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceListParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceListQuery" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/search/generateGraphResourcePattern": { "post": { "tags": [ "Search" ], "operationId": "generateGraphResourcePattern", "parameters": [ { "name": "queryBody", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GraphPatternParseResult" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/search/count": { "post": { "tags": [ "Search" ], "operationId": "listResourcesCount", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceListParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "integer", "format": "int64" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/resources/shaped": { "post": { "tags": [ "Resources" ], "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", "operationId": "shapeResource", "parameters": [ { "name": "resources", "in": "query", "description": "The list of resources to be shaped.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "nodeShapeIris", "in": "query", "description": "If present, shapes are not detected, but the provided are applied. Can be used for form generation on new resources.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "langPref", "in": "query", "description": "Language preferences that override the system settings. Used for both shape and data", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeNonShapedProperties", "in": "query", "description": "Should the response include additionally all directly attached properties of the resource, that are not included in the shape?", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceView" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/resources/shapedSave": { "post": { "tags": [ "Resources" ], "description": "Saves a changed resource and allows adding the resource as a reified statement.", "operationId": "saveShapedResource", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceChangeSet" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SaveReport" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/resource/relations": { "post": { "tags": [ "Relations" ], "operationId": "getRelation", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceRelationParam" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceRelationResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/querycatalog/queryType": { "post": { "tags": [ "Sparql Catalog" ], "operationId": "queryType", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/QueryTypeAnalysis" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/querycatalog/pretty": { "post": { "tags": [ "Sparql Catalog" ], "operationId": "prettyPrint", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FormatResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/querycatalog/logicalPlan": { "post": { "tags": [ "Sparql Catalog" ], "operationId": "logicalPlan", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LogicalPlanResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/queries/reports/perform": { "get": { "tags": [ "Named Queries" ], "description": "Executes the query and returns a CSV result", "operationId": "getCsvGet", "parameters": [ { "name": "queryIri", "in": "query", "description": "The identifier of the query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "description": "Narrows down the execution context of the query to a single graph. This sets the default \u0026 named graph of the query.", "required": false, "schema": { "type": "string" } }, { "name": "substitutions", "in": "query", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "schema": { "type": "string" }, "example": { "placeholder": "substitution value", "placeholder2": "...." } }, { "name": "fileName", "in": "query", "description": "The name of the download", "required": false, "schema": { "type": "string", "default": "report" } } ], "responses": { "200": { "description": "A csv representation of the query result", "content": { "text/csv": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Named Queries" ], "operationId": "getCsvPost", "parameters": [ { "name": "queryIri", "in": "query", "description": "The identifier of the query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "description": "Narrows down the execution context of the query to a single graph. This sets the default \u0026 named graph of the query.", "required": false, "schema": { "type": "string" } }, { "name": "substitutions", "in": "query", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "schema": { "type": "string" }, "example": { "placeholder": "substitution value", "placeholder2": "...." } }, { "name": "fileName", "in": "query", "description": "The name of the download", "required": false, "schema": { "type": "string", "default": "report" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/queries/reports/performBulk": { "get": { "tags": [ "Named Queries" ], "operationId": "getBulkCsvGet", "parameters": [ { "name": "queryIris", "in": "query", "description": "The identifier of the query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contextGraph", "in": "query", "description": "Narrows down the execution context of the query to a single graph. This sets the default \u0026 named graph of the query.", "required": false, "schema": { "type": "string" } }, { "name": "substitutions", "in": "query", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "schema": { "type": "string" }, "example": { "placeholder": "substitution value", "placeholder2": "...." } }, { "name": "fileNames", "in": "query", "description": "The name of the download", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Named Queries" ], "operationId": "getBulkCsvPost", "parameters": [ { "name": "queryIris", "in": "query", "description": "The identifier of the query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contextGraph", "in": "query", "description": "Narrows down the execution context of the query to a single graph. This sets the default \u0026 named graph of the query.", "required": false, "schema": { "type": "string" } }, { "name": "substitutions", "in": "query", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "schema": { "type": "string" }, "example": { "placeholder": "substitution value", "placeholder2": "...." } }, { "name": "fileNames", "in": "query", "description": "The name of the download", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/queries/jsonld/perform": { "get": { "tags": [ "Named Queries" ], "description": "Executes the query and returns a CSV result", "operationId": "generateJsonLdGet", "parameters": [ { "name": "queryIri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "substitutions", "in": "query", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "schema": { "type": "string" }, "example": { "placeholder": "substitution value", "placeholder2": "...." } } ], "responses": { "200": { "description": "A JSON response of the Framed Construct Result", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Named Queries" ], "description": "Executes the query and returns a CSV result", "operationId": "generateJsonLdPost", "parameters": [ { "name": "queryIri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "substitutions", "in": "query", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "schema": { "type": "string" }, "example": { "placeholder": "substitution value", "placeholder2": "...." } } ], "responses": { "200": { "description": "A JSON response of the Framed Construct Result", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/explore/titles": { "post": { "tags": [ "Label Resolution" ], "description": "@Beta, this api is subject to change without further notice \n. Finds a short-form description for a multiple IRIs.", "operationId": "getTitle1", "parameters": [ { "name": "langPrefs", "in": "query", "description": "An ordered List of language preferences", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contextGraph", "in": "query", "description": "The context/graph, in which the lookup should take place", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The list of iris to resolve", "items": { "type": "string" } } } }, "required": true }, "responses": { "default": { "description": "A Mapping of the IRIs to a detailed resolution report.Uses POST instead of GET to circumvent too large requests.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TitleResolve" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/explore/facets/pathfacets": { "post": { "tags": [ "Facets" ], "description": "Look-up the properties available for the given GraphResourcePattern", "operationId": "pathFacets", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "var", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "incoming", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "langPrefs", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "allowStale", "in": "query", "description": "Allow returning stale (possibly not current) values from cache", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphResourcePattern" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FacetListEntry" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/explore/depictions": { "post": { "tags": [ "Label Resolution" ], "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 ", "operationId": "getDepictions", "parameters": [ { "name": "contextGraph", "in": "query", "description": "The context/graph, in which the lookup should take place", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DepictionResolve" } } } } }, "400": { "description": "List of given resources must not be empty", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DepictionResolve" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/custom/{slug}": { "get": { "tags": [ "Named Queries" ], "description": "Executes the query and returns a JSON result by evaluating a Jinjava Template", "operationId": "executePythonConversionGet", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "substitutions", "in": "query", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "schema": { "type": "string" }, "example": { "placeholder": "substitution value", "placeholder2": "...." } } ], "responses": { "200": { "description": "A JSON response of the Framed Construct Result", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Named Queries" ], "operationId": "executePythonConversionGetPost", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "substitutions", "in": "query", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "schema": { "type": "string" }, "example": { "placeholder": "substitution value", "placeholder2": "...." } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/conf/workspaces/customWorkspaces": { "get": { "tags": [ "Workspace Config Controller" ], "summary": "Returns custom workspaces diff to project default workspace", "operationId": "getCustomWorkspaces", "responses": { "200": { "description": "Workspace configuration retrieved", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Workspace Config Controller" ], "summary": "Creates a new custom workspace", "operationId": "createCustomWorkspace", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } }, "required": true }, "responses": { "400": { "description": "The request is formally not valid" }, "409": { "description": "A workspace with the given id already exists" }, "403": { "description": "The user is not allowed to store workspace configurations" }, "201": { "description": "Custom workspace is created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/conf/charts": { "get": { "tags": [ "Charts Config Controller" ], "summary": "Returns a list of chart configurations", "operationId": "listChartConfigurations", "parameters": [ { "name": "contextGraph", "in": "query", "description": "Context graph from which to read configurations", "required": false, "schema": { "type": "string", "default": "Optional[https://ns.eccenca.com/data/queries/]" }, "example": "https://ns.eccenca.com/data/queries/" } ], "responses": { "200": { "description": "Chart configuration retrieved", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChartConfiguration" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Charts Config Controller" ], "summary": "Creates a new chart configuration", "operationId": "createChartConfiguration", "parameters": [ { "name": "contextGraph", "in": "query", "description": "Context graph to write configurations to", "required": false, "schema": { "type": "string", "default": "Optional[https://ns.eccenca.com/data/queries/]" }, "example": "https://ns.eccenca.com/data/queries/" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } }, "required": true }, "responses": { "400": { "description": "The request is formally not valid", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } }, "201": { "description": "Chart configuration is created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } }, "409": { "description": "A chart configuration with the given id already exists", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } }, "403": { "description": "The user is not allowed to store chart configurations", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/assist/index": { "post": { "tags": [ "assist-controller" ], "description": "PREVIEW: Index the installed vocabularies.", "operationId": "indexVocabEmbeddings", "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/assist/bootstrapOntology": { "post": { "tags": [ "assist-controller" ], "description": "PREVIEW: Create a new Ontology via chat", "operationId": "boostrapOntology", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UiChatMessage" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BootstrapOntologyResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/assist/assist": { "post": { "tags": [ "assist-controller" ], "description": "PREVIEW: Analyze a user input an map it to an action.", "operationId": "assist", "parameters": [ { "name": "input", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssistResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/admin/showcase": { "post": { "tags": [ "Admin Backup/Restore/Bootstrap" ], "description": "Insert the showcase data", "operationId": "showcase", "parameters": [ { "name": "scaleFactor", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "503": { "description": "Another administrative operation is ongoing at the moment. Please check with /admin/status", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/admin/restore/zip": { "post": { "tags": [ "Admin Backup/Restore/Bootstrap" ], "description": "Restores a compressed backup and replaces the graphs contained in this backup file.", "operationId": "restoreBackup", "parameters": [ { "name": "blocking", "in": "query", "description": "If request should be blocking or return upon successful reception of file (default true)", "required": false, "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "ZIP-file which needs to be restored", "format": "binary" } } } } } }, "responses": { "403": { "description": "The current user is not authorized to use this endpoint " }, "503": { "description": "Another administrative operation is ongoing at the moment. Please check with /admin/status" }, "400": { "description": "The restore-file is broken or not suitable for the task." } }, "security": [ { "bearerAuth": [] } ] } }, "/api/admin/flushCache": { "post": { "tags": [ "Admin QueryMonitor" ], "description": "Flushes all existing caches", "operationId": "flushCaches", "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/admin/drop-all-graphs": { "post": { "tags": [ "Admin Backup/Restore/Bootstrap" ], "description": "Drops all graphs.", "operationId": "dropAllGraphs", "responses": { "200": { "description": "Graphs successfully dropped." }, "503": { "description": "Another administrative operation is ongoing at the moment. Please check with /admin/status" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/admin/bootstrap": { "post": { "tags": [ "Admin Backup/Restore/Bootstrap" ], "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", "operationId": "bootstrap", "responses": { "503": { "description": "Another administrative operation is ongoing at the moment. Please check with /admin/status", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Admin Backup/Restore/Bootstrap" ], "description": "Removes the present bootstrap data (all system resources). This operation deletes data. Use with care", "operationId": "bootstrapDelete", "responses": { "503": { "description": "Another administrative operation is ongoing at the moment. Please check with /admin/status", "content": { "*/*": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/userinfo": { "get": { "tags": [ "UserInfo", "UserInfo API" ], "summary": "UserInfo GET", "description": "Displays user information, such as user name and account URI.", "operationId": "userInfoGet", "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInfoSchema" }, "example": { "accountName": "USERNAME", "uri": "http://eccenca.com/USERNAME" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/proxy/{id}": { "get": { "tags": [ "Data Endpoints" ], "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](https://www.w3.org/TR/2013/REC-sparql11-results-json-20130321)", "operationId": "sparqlEndpointGet", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointDescription" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/proxy/{id}/update/manualedit/analyse": { "get": { "tags": [ "Manual Edit" ], "operationId": "deleteRequestAnalysis", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resource", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "graph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GraphCount" } } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/proxy/{id}/sparql": { "get": { "tags": [ "Data Endpoints / SPARQL Query" ], "summary": "SPARQL query via HTTP GET", "description": "SPARQL query via HTTP GET and query parameters", "operationId": "sparqlQueryGet", "parameters": [ { "name": "id", "in": "path", "description": "Endpoint ID", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "A valid SPARQL 1.1 Query string as described in the [SPARQL 1.1 Query Language](https://www.w3.org/TR/2013/REC-sparql11-query-20130321/)", "required": true, "schema": { "type": "string" }, "example": "CONSTRUCT ?class WHERE {?s a ?class}" }, { "name": "default-graph-uri", "in": "query", "description": "Zero or more default graph URIs", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "named-graph-uri", "in": "query", "description": "Zero or more named graph URIs", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "owlImportsResolution", "in": "query", "description": "Enable/disable OWL imports resolution for this query", "required": false, "schema": { "type": "boolean" } }, { "name": "base64encoded", "in": "query", "description": "If set to true, the query parameter is expected in base64 encoding", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "$ref": "#/components/responses/sq200" }, "503": { "$ref": "#/components/responses/g503" }, "409": { "description": "Query has been cancelled by another user/client.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/QueryResult" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/login_success_page": { "get": { "tags": [ "login-success-controller" ], "operationId": "getLoginSuccessPage", "responses": { "200": { "description": "OK", "content": { "text/html": { "schema": { "type": "string" } } } } } } }, "/loginSingle": { "get": { "tags": [ "login-controller" ], "operationId": "loginSingle", "parameters": [ { "name": "state", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RedirectView" } } } } } } }, "/graphs/{id}/write": { "get": { "tags": [ "Accessible graphs" ], "summary": "Writable graphs", "description": "A list of graph URIs the user is allowed to write.", "operationId": "graphsWriteGet", "parameters": [ { "name": "id", "in": "path", "description": "A specific SPARQL endpoint. Every endpoint is identified by an `endpointId` URI path parameter.", "required": true, "schema": { "type": "string" }, "example": "default" }, { "name": "graphUri", "in": "query", "description": "A specific graph to check write access for, will return *true* if write is allowed, otherwise *false*", "required": false, "schema": { "type": "string" }, "example": "http://example.org/graphA" } ], "responses": { "200": { "description": "The request was processed successfully.", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/graphs/{id}/read": { "get": { "tags": [ "Accessible graphs" ], "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\u0027s given, a boolean indicating whether the graph is readable by the user.", "operationId": "graphsReadGet", "parameters": [ { "name": "id", "in": "path", "description": "A specific SPARQL endpoint. Every endpoint is identified by an `endpointId` URI path parameter.", "required": true, "schema": { "type": "string" }, "example": "default" }, { "name": "graphUri", "in": "query", "description": "A specific graph to check read access for, will return *true* if read is allowed, otherwise *false*", "required": false, "schema": { "type": "string" }, "example": "http://example.org/graphA" } ], "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/json": { "schema": { "type": "string" }, "example": [ "urn:readableGraphA", "urn:readableGraphB", "urn:writableGraphC" ] } } } }, "security": [ { "bearerAuth": [] } ] } }, "/graphs/list": { "get": { "tags": [ "Accessible graphs" ], "summary": "User graphs list", "description": "A list of graph URIs the user is allowed to read.", "operationId": "graphsList", "responses": { "403": { "$ref": "#/components/responses/g403" }, "200": { "description": "The request was processed successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReadableGraph" } }, "example": [ { "iri": "http://someIri", "label": { "iri": "http://someIri", "title": "Some title", "lang": "en", "graph": "https://someGraph/", "when": "00:00:99.9", "fromIri": false } }, { "iri": "http://someOtherIri", "label": { "iri": "http://someOtherIri", "title": "Some other title", "lang": "en", "graph": "https://someOtherGraph/", "when": "00:00:99.9", "fromIri": false } } ] } } } }, "security": [ { "bearerAuth": [] } ] } }, "/graphs/imports": { "get": { "tags": [ "Accessible graphs" ], "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.", "operationId": "getGraphImports", "parameters": [ { "name": "owlImportsResolution", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "graph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/graphs/importTree": { "get": { "tags": [ "Accessible graphs" ], "description": "The owl:import imports, determined by a breadth first graph traversal.", "operationId": "getImportTree", "parameters": [ { "name": "graph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportTree" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/graphs/detailed": { "get": { "tags": [ "Accessible graphs" ], "summary": "User graph with details", "description": "Graph URIs the user is allowed to read, with details (classes counts, instances counts, etc.).", "operationId": "graphDetailed", "parameters": [ { "name": "owlImportsResolution", "in": "query", "description": "Enable/disable OWL imports resolution.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "graphIri", "in": "query", "description": "The details fo the graph to fetch", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "$ref": "#/components/responses/g403" }, "200": { "description": "The request was processed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadableGraphDetailed" }, "example": "{\n \"iri\": \"http://someIri\",\n \"label\": {\n \"iri\": \"http://someIri\",\n \"title\": \"Some title\",\n \"lang\": \"en\",\n \"graph\": \"https://someGraph/\",\n \"when\": \"00:00:99.9\",\n \"fromIri\": false\n },\n \"triplesCount\": 5,\n \"wellDefinedClassesCount\": 2,\n \"classesCount\": 2,\n \"instancesCount\": 2\n " } } } }, "security": [ { "bearerAuth": [] } ] } }, "/authorization/refresh": { "get": { "tags": [ "Authorization", "Authorization Management API" ], "summary": "Authorization refresh", "description": "Reloads the access conditions model following the internal configuration parameters.", "operationId": "authorizationGetRefresh", "responses": { "403": { "description": "The user does not have permission to execute this action." }, "204": { "description": "The access conditions were successfully reloaded." }, "500": { "description": "The 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." } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/api/vocabusage/vocabUptake": { "get": { "tags": [ "vocabusage", "Vocabulary usage" ], "operationId": "getVocabUptakeFor", "parameters": [ { "name": "graphIri", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/VocabUptake" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/vocabusage/usage": { "get": { "tags": [ "classusage", "Vocabulary usage" ], "description": "Shows how classes are connected in a particular graph to each other by different properties", "operationId": "getConnectedClassesByUsage", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UsageConnectedClasses" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/vocabusage/shape": { "get": { "tags": [ "classshapeusage", "Vocabulary usage" ], "description": "Shows how shapes are connecting classes via property shapes", "operationId": "getConnectedClassesByShape", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShapeConnectedClasses" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/vocabusage/propertyusage": { "get": { "tags": [ "propertyusage", "Vocabulary usage" ], "description": "Lists all properties explicitly utilized in this graph.", "operationId": "usedProperties", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/vocabusage/properties": { "get": { "tags": [ "properties", "Vocabulary usage" ], "description": "All Properties defined in this knowledge graph by installed vocabularies", "operationId": "getDefinedProperties", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VocabularyProperty" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/vocabusage/classusage": { "get": { "tags": [ "classusage", "Vocabulary usage" ], "description": "Lists all classes explicitly utilized in this graph.", "operationId": "usedClasses", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/vocabusage/classes": { "get": { "tags": [ "classes", "Vocabulary usage" ], "description": "All Classes defined in this knowledge graph by installed vocabularies. While all classes are returned, they can easy be grouped by either their explicit association with an ontology in the isDefinedBy (rdfs:isDefinedBy)field, or by the sourceGraph field, which contains the names of the graphs from which the type statements were loaded from.", "operationId": "getDefinedClasses", "parameters": [ { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VocabularyClass" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/vocabs": { "get": { "tags": [ "Vocabulary Management" ], "summary": "List vocabularies", "description": "Lists all Vocabularies of the default endpoint.", "operationId": "vocabsGet", "parameters": [ { "name": "vocabGraph", "in": "query", "description": "The Vocabulary Catalog to query", "required": false, "schema": { "type": "string" } }, { "name": "searchTerm", "in": "query", "description": "A full text search term", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Max number of results", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "offset", "in": "query", "description": "skip the first results", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "order-by", "in": "query", "description": "Either ASC ord DESC", "required": false, "schema": { "type": "string" } }, { "name": "langPrefences", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VocabList" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/upload/{storageId}": { "get": { "tags": [ "upload-controller" ], "description": "Analyzes temporarily stored file. Returns results as json", "operationId": "analyzeStoredFile", "parameters": [ { "name": "storageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "File cannot be analyzed because it is (probably) corrupt", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UploadAnalytics" } } } }, "200": { "description": "File successfully analyzed and results returned. Possible errors in files are part of the response.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UploadAnalytics" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/upload/transferStatus/{transferId}": { "get": { "tags": [ "upload-controller" ], "description": "Returns transfer status for provided transfer id", "operationId": "transferStatus", "parameters": [ { "name": "transferId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Requested transfer id not found ", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UploadStatusInfo" } } } }, "200": { "description": "Provided transfer id exists and status info can be given", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UploadStatusInfo" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/resource": { "get": { "tags": [ "Statement-Level Metadata" ], "description": "Checks if the resource is annotated", "operationId": "isResourceAnnotated", "parameters": [ { "name": "subject", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/connectableProperties": { "get": { "tags": [ "Statement-Level Metadata" ], "description": "Fetches the properties that are enabled for ", "operationId": "getMetadataProperties", "parameters": [ { "name": "resource", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "langPref", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConnectableProperties" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/statementmetadata/applicableshapes": { "get": { "tags": [ "Statement-Level Metadata" ], "description": "Fetches the list of suitable Shapes for a reification", "operationId": "getApplicableNodeShapes", "parameters": [ { "name": "propertyShapeIri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NodeShapeListEntry" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/shapes/list": { "get": { "tags": [ "Shapes" ], "description": "Lists NodeShapes, either by the given iris, or all if empty.", "operationId": "loadNodeShape", "parameters": [ { "name": "nodeShapes", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NodeShape" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/shapes/cacheInvalidate": { "get": { "tags": [ "Shapes" ], "description": "Invalidates the shapes cache", "operationId": "invalidateCache", "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/shapes/applicable": { "get": { "tags": [ "Shapes" ], "description": "Given targets, what shapes could be applied?", "operationId": "listShapes", "parameters": [ { "name": "targetClass", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "subjectOfProperty", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "objectOfProperty", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "nodeTargetIri", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NodeShapeListEntry" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/search/parse": { "get": { "tags": [ "Search", "Query Analysis" ], "description": "Parses the given term and normalizes it. Injects the default field.", "operationId": "analyseSearchTerm", "parameters": [ { "name": "searchExpression", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "defaultField", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SearchTermAnalysis" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/resources/usage": { "get": { "tags": [ "Resources" ], "operationId": "getResoureUsage", "parameters": [ { "name": "iri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceUsage" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/queries/reports": { "get": { "tags": [ "Named Queries" ], "description": "Lists all executable queries and shows their potential parameters", "operationId": "getList", "parameters": [ { "name": "vocabCatalog", "in": "query", "description": "The uri of the query catalog, in case not all queries shall be listed.", "required": false, "schema": { "type": "string" }, "example": "https://ns.eccenca.com/data/queries/" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportList" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/prefixes": { "get": { "tags": [ "Prefixes" ], "description": "Get a plain list of all prefixes and their namespaces as used in the system. Ambiguous definitions are ignored here.", "operationId": "getPrefixes", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/prefixesDetails": { "get": { "tags": [ "Prefixes" ], "description": "A detailed view on the prefixes and how they are defined. Also overridden and ambiguous definitions are given here.", "operationId": "getPrefixesDetails", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PrefixDataView" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/navigate/viz/list": { "get": { "tags": [ "navlist" ], "description": "Lists all stored Visualizations", "operationId": "listVisualizations", "parameters": [ { "name": "langPref", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VizListEntry" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/manage/graph": { "get": { "tags": [ "graphmanagement" ], "operationId": "list", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GraphConfiguration" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/gitsync": { "get": { "tags": [ "gitsync" ], "operationId": "isActive", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/gitsync/diff": { "get": { "tags": [ "gitsync" ], "operationId": "getDiff", "parameters": [ { "name": "graphIri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "oldRevision", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "newRevision", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GitGraphSyncDiff" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/gitsync/changes": { "get": { "tags": [ "gitsync" ], "operationId": "getChanges", "parameters": [ { "name": "graphIri", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GitGraphSyncChange" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/explore/title": { "get": { "tags": [ "Label Resolution" ], "description": "This api is subject to change without further notice \n. Finds a short-form description for a single IRI.", "operationId": "getTitle", "parameters": [ { "name": "resource", "in": "query", "description": "The iri to resolve", "required": true, "schema": { "type": "string" } }, { "name": "langPrefs", "in": "query", "description": "An ordered List of language preferences", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contextGraph", "in": "query", "description": "The context/graph, in which the lookup should take place", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TitleResolve" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/explore/langs": { "get": { "tags": [ "Label Resolution" ], "description": "The configured languages preferences", "operationId": "getLangs", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/explore/facets": { "get": { "tags": [ "Facets" ], "summary": "List the properties of a class or query", "operationId": "queryGet", "parameters": [ { "name": "contextGraph", "in": "query", "description": "Single default graph", "required": false, "schema": { "type": "string" } }, { "name": "queryFragment", "in": "query", "description": "Query fragment for the WHERE clause (either queryFragment or classIri must be specified).", "required": false, "schema": { "type": "string" }, "example": "{?resource a \u003chttp://example.com/MyClass\u003e}" }, { "name": "classIri", "in": "query", "description": "IRI of the class the resource is an instance of (either queryFragment or classIri must be specified).", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "http://example.com/MyClass" }, { "name": "incoming", "in": "query", "description": "Defines, if incoming or outgoing properties of are calculated. If \u0027true\u0027, the facets are calculated for incoming properties are returned", "required": false, "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "variableName", "in": "query", "description": "Used with query fragment: Defines the variable for which the facets are calculated.", "required": false, "schema": { "type": "string" }, "example": "thing" }, { "name": "sparqlQuery", "in": "query", "description": "sparqlQuery", "required": false, "schema": { "type": "string" }, "example": "SELECT ?thing {?thing a \u003chttp://example.com/MyClass\u003e}" }, { "name": "langPrefences", "in": "query", "description": "Language preferences that override the system settings. Used for both shape and data", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "allowStale", "in": "query", "description": "Allow returning stale (possibly not current) values from cache", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Request was successful and query result is returned in the body.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FacetDetail" } } } } }, "400": { "$ref": "#/components/responses/g400Params" }, "403": { "$ref": "#/components/responses/g403" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/conf/workspaces": { "get": { "tags": [ "Workspace Config Controller" ], "summary": "Returns full set of WorkspaceConfigurations (systemDefault, projectDefault, custom workspaces", "operationId": "getConfigSet", "responses": { "200": { "description": "Workspace configuration retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/WorkspaceConfigurationSetResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/conf/workspaces/systemDefault": { "get": { "tags": [ "Workspace Config Controller" ], "summary": "Returns system default workspace", "operationId": "getSystemDefault", "responses": { "200": { "description": "Workspace configuration retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/conf/charts/shaclUsage": { "get": { "tags": [ "Charts Config Controller" ], "summary": "Retrieves connection between SHACL shapes and chart configurations. Important: The context of the data retrieval is the SHAPE catalogue and its imports (for the shapes and charts", "operationId": "shaclUsage", "parameters": [ { "name": "nodeShapeIri", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "One of the given SHACL shape IRIs not found in the shape catalogue", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ChartConfiguration" } } } } } }, "200": { "description": "Map between shapes and chart configurations retrieved", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ChartConfiguration" } } } } } }, "403": { "description": "The user is not allowed to read the shape graph", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ChartConfiguration" } } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/authorization/users": { "get": { "tags": [ "Authorization Management API 2" ], "operationId": "accessConditionAvailableUsers", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/authorization/iri": { "get": { "tags": [ "Authorization Management API 2" ], "summary": "Get an access condition by its IRI", "operationId": "accessConditionGet", "parameters": [ { "name": "resource", "in": "query", "description": "Retrieve the access condition identified by the given IRI.", "required": true, "schema": { "type": "string" }, "example": "http://eccenca.com/PublicAccessCondition" } ], "responses": { "404": { "description": "Access condition not found" }, "403": { "description": "The user is not allowed to execute this action", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } }, "200": { "description": "Access condition found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/authorization/groups": { "get": { "tags": [ "Authorization Management API 2" ], "operationId": "accessConditionAvailableGroups", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/authorization/actions": { "get": { "tags": [ "Authorization Management API 2" ], "operationId": "accessConditionAvailableActions", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/auth/actions": { "get": { "tags": [ "Actions" ], "summary": "Allowed actions", "description": "A list of action URIs the user is allowed to perform ", "operationId": "userActions", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/assist/isActive": { "get": { "tags": [ "assist-controller" ], "description": "PREVIEW: Check if the assist service is configured ", "operationId": "isAssistActive", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/admin/status": { "get": { "tags": [ "Admin Backup/Restore/Bootstrap" ], "description": "Checks for status of admin operations", "operationId": "adminStatus", "responses": { "200": { "description": "Currently ongoing admin operation. One of (RESTORE, BACKUP, SHOWCASE, BOOTSTRAP, DROP_ALL_GRAPHS, NONE", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/admin/currentQueries": { "get": { "tags": [ "Admin QueryMonitor" ], "summary": "Get query status of recently executed queries", "description": "Get the query status of recently executed queries. \n\nThe containing query execution state has the following definitions: \n| Status | Description | \n| ------ | ----------- | \n| CREATED | Query created and waiting for execution (queued)| \n| RUNNING | Query currently running in backend store | \n| FINISHED_SUCCESS | Query finished successfully in store | \n| FINISHED_CANCELLED | Query cancelled by client / store | \n| FINISHED_ERROR | Query finished with error | \n| FINISHED_TIMEOUT | Query ran into (system) timeout | \n", "operationId": "getQueryStatus", "responses": { "200": { "description": "The request was processed successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryExecutionStats" } } } } }, "403": { "description": "The current user is not authorized for this operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryExecutionStats" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/admin/currentQueries/{queryId}": { "get": { "tags": [ "Admin QueryMonitor" ], "summary": "Get query status of query with given id", "description": "Get the query status of recently executed queries. \n\nThe containing query execution state has the following definitions: \n| Status | Description | \n| ------ | ----------- | \n| CREATED | Query created and waiting for execution (queued)| \n| RUNNING | Query currently running in backend store | \n| FINISHED_SUCCESS | Query finished successfully in store | \n| FINISHED_CANCELLED | Query cancelled by client / store | \n| FINISHED_ERROR | Query finished with error | \n| FINISHED_TIMEOUT | Query ran into (system) timeout | \n", "operationId": "getSingleQueryStatus", "parameters": [ { "name": "queryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryExecutionStats" } } } }, "404": { "description": "No query with given id found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/QueryExecutionStats" } } } }, "403": { "description": "The current user is not authorized for this operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/QueryExecutionStats" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Admin QueryMonitor" ], "summary": "Forced interruption of a calculating query", "description": "Request that aborts a query which does not stream already to the client.", "operationId": "abortQuery", "parameters": [ { "name": "queryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The request was processed successfully" }, "500": { "description": "Internal error in aborting the query" }, "400": { "description": "The request is not possible in the given environment" }, "404": { "description": "No query with given id found" }, "403": { "description": "The current user is not authorized for this operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/admin/backup/zip": { "get": { "tags": [ "Admin Backup/Restore/Bootstrap" ], "description": "Creates a full backup of all knowledge graphs", "operationId": "backupAllGraphs", "responses": { "403": { "description": "User is not allowed to read all graphs in the system" }, "503": { "description": "Another administrative operation is ongoing at the moment. Please check with /admin/status" } }, "security": [ { "bearerAuth": [] } ] } }, "/actions/{id}": { "get": { "tags": [ "Actions" ], "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", "operationId": "actions", "parameters": [ { "name": "id", "in": "path", "description": "A specific SPARQL endpoint. Every endpoint is identified by an `endpointId` URI path parameter.", "required": true, "schema": { "type": "string" }, "example": "default" }, { "name": "actionUri", "in": "query", "description": "Check for a specific action, will return *true* if the user is allowed to perform the action, otherwise *false*.", "required": false, "schema": { "type": "string" }, "example": "http://example.org/actionA" } ], "responses": { "200": { "description": "The response was successfully executed.", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } } }, "components": { "schemas": { "CatalogQuery": { "required": [ "created", "iri", "label", "labels", "modified", "queryText", "type" ], "type": "object", "properties": { "iri": { "type": "string" }, "modified": { "$ref": "#/components/schemas/Literal" }, "created": { "$ref": "#/components/schemas/Literal" }, "descriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "type": { "type": "string" }, "queryText": { "type": "string" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } }, "Literal": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" }, "lang": { "type": "string" }, "datatype": { "type": "string" } } }, "TitleResolve": { "required": [ "iri", "title" ], "type": "object", "properties": { "iri": { "type": "string" }, "title": { "type": "string" }, "lang": { "type": "string" }, "graph": { "type": "string" }, "when": { "type": "string" }, "fromIri": { "type": "boolean" }, "predicate": { "type": "string" } } }, "VizNodePlacement": { "required": [ "locates", "x", "y" ], "type": "object", "properties": { "iri": { "type": "string" }, "x": { "type": "integer", "format": "int32" }, "y": { "type": "integer", "format": "int32" }, "locates": { "type": "string" } } }, "Vizualization": { "required": [ "contextGraph", "iri", "label", "labels" ], "type": "object", "properties": { "iri": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "depictionUri": { "type": "string" }, "placements": { "type": "array", "items": { "$ref": "#/components/schemas/VizNodePlacement" } }, "contextGraph": { "type": "string" }, "created": { "$ref": "#/components/schemas/Literal" }, "creator": { "type": "string" }, "modified": { "$ref": "#/components/schemas/Literal" }, "contributor": { "type": "string" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } }, "AccountSettingsModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "url": { "type": "string" } } }, "AdministrationModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" } } }, "AnnotationModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "wikidataUrl": { "type": "string" }, "exploreUrl": { "type": "string" }, "entityGraphUrl": { "type": "string" }, "endpointUrl": { "type": "string" }, "entityTransformationUrl": { "type": "string" } } }, "ApiConfiguration": { "type": "object", "properties": { "defaultTimeout": { "type": "integer", "format": "int64" } } }, "AppPresentationConfiguration": { "type": "object", "properties": { "companyName": { "type": "string" }, "applicationName": { "type": "string" }, "windowTitle": { "type": "string" }, "faviconUrl": { "type": "string" }, "logoUrl": { "type": "string" }, "bannerBackgroundColor": { "type": "string" } } }, "ChartsModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" } } }, "DiWorkspaceConfiguration": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "baseUrl": { "type": "string" } } }, "EasyNavModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "iri": { "type": "string" }, "enabled": { "type": "boolean" }, "contextGraph": { "type": "string" }, "shapePropertyView": { "type": "boolean" }, "searchListQueries": { "type": "array", "items": { "$ref": "#/components/schemas/EasyNavSearchQuery" } } } }, "EasyNavSearchQuery": { "type": "object", "properties": { "id": { "type": "string" }, "graphResourcePattern": { "$ref": "#/components/schemas/GraphResourcePattern" }, "searchProperties": { "type": "array", "items": { "type": "string" } }, "scoringMethod": { "type": "string", "enum": [ "https://vocab.eccenca.com/configuration/ScoringByLuceneScore", "https://vocab.eccenca.com/configuration/ScoringByMatchLength", "https://vocab.eccenca.com/configuration/ScoringByDb" ] }, "weight": { "type": "number", "format": "double" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/JsonLiteral" } } } }, "ExploreExternalTool": { "type": "object", "properties": { "enable": { "type": "boolean" }, "tabname": { "type": "string" }, "iframeUrlTemplate": { "type": "string" } } }, "ExploreModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "iri": { "type": "string" }, "enabled": { "type": "boolean" }, "defaultGraph": { "type": "string" }, "exploreGraphLists": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceGraphList" } }, "graphCreationShapes": { "type": "array", "items": { "type": "string" } }, "shaclAllowCopy": { "type": "boolean" }, "shaclShowGraphInfo": { "type": "boolean" }, "shaclUseSaveApi": { "type": "boolean" }, "shaclShowMetadataTab": { "type": "boolean" }, "mapServer": { "$ref": "#/components/schemas/MapServer" }, "navigationDefaultClass": { "type": "string" }, "navigationItemsPerPage": { "type": "integer", "format": "int32" }, "navigationTopQuery": { "type": "string" }, "navigationSubQuery": { "type": "string" }, "navigationSearchQuery": { "type": "string" }, "navigationListQuery": { "type": "string" }, "navigationOverallSearchQuery": { "type": "string" }, "propertiesEnabled": { "type": "boolean" }, "usageEnabled": { "type": "boolean" }, "referencesEnabled": { "type": "boolean" }, "turtleEnabled": { "type": "boolean" }, "ontodiaEnabled": { "type": "boolean" }, "ontodiaEnabledDeprecated": { "type": "boolean" }, "statisticsEnabled": { "type": "boolean" }, "statisticsSunburstEnabled": { "type": "boolean" }, "visualizationEnabled": { "type": "boolean" }, "externalTools": { "type": "array", "items": { "$ref": "#/components/schemas/ExploreExternalTool" } } } }, "FullTextSearchFilter": { "type": "object", "properties": { "searchVar": { "type": "string" }, "searchTerm": { "type": "string" }, "searchRaw": { "type": "boolean" }, "searchProperties": { "type": "array", "items": { "type": "string" } } } }, "GraphResourcePattern": { "required": [ "paths" ], "type": "object", "properties": { "pathFilters": { "type": "array", "items": { "$ref": "#/components/schemas/PathVariableFilter" } }, "paths": { "type": "array", "items": { "$ref": "#/components/schemas/Path" } }, "fullTextSearch": { "$ref": "#/components/schemas/FullTextSearchFilter" } } }, "IntegrationsModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "tabs": { "type": "array", "items": { "$ref": "#/components/schemas/Tab" } } } }, "JsonLiteral": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" }, "lang": { "type": "string" } } }, "LinkRuleModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "hierarchyEnable": { "type": "boolean" } } }, "MapServer": { "type": "object", "properties": { "ext": { "type": "string" }, "url": { "type": "string" } } }, "Modules": { "type": "object", "properties": { "exploreModuleConfiguration": { "$ref": "#/components/schemas/ExploreModuleConfiguration" }, "easyNavModuleConfiguration": { "$ref": "#/components/schemas/EasyNavModuleConfiguration" }, "accountSettingsModuleConfiguration": { "$ref": "#/components/schemas/AccountSettingsModuleConfiguration" }, "administrationModuleConfiguration": { "$ref": "#/components/schemas/AdministrationModuleConfiguration" }, "annotationModuleConfiguration": { "$ref": "#/components/schemas/AnnotationModuleConfiguration" }, "integrationsModuleConfiguration": { "$ref": "#/components/schemas/IntegrationsModuleConfiguration" }, "linkRuleModuleConfiguration": { "$ref": "#/components/schemas/LinkRuleModuleConfiguration" }, "queryModuleConfiguration": { "$ref": "#/components/schemas/QueryModuleConfiguration" }, "reportsModuleConfiguration": { "$ref": "#/components/schemas/ReportsModuleConfiguration" }, "searchModuleConfiguration": { "$ref": "#/components/schemas/SearchModuleConfiguration" }, "taskModuleConfiguration": { "$ref": "#/components/schemas/TaskModuleConfiguration" }, "thesaurusModuleConfiguration": { "$ref": "#/components/schemas/ThesaurusModuleConfiguration" }, "trackingModuleConfiguration": { "$ref": "#/components/schemas/TrackingModuleConfiguration" }, "vocabularyModuleConfiguration": { "$ref": "#/components/schemas/VocabularyModuleConfiguration" }, "chartsModuleConfiguration": { "$ref": "#/components/schemas/ChartsModuleConfiguration" } } }, "Path": { "required": [ "inverted", "predicate" ], "type": "object", "properties": { "subjectVarName": { "type": "string" }, "hideSubjectVar": { "type": "boolean" }, "objectVarName": { "type": "string" }, "hideObjectVar": { "type": "boolean" }, "inverted": { "type": "boolean" }, "zeroOrMore": { "type": "boolean" }, "oneOrMore": { "type": "boolean" }, "zeroOrOne": { "type": "boolean" }, "objectPath": { "type": "boolean" }, "predicate": { "type": "string" }, "sequence": { "type": "array", "items": { "$ref": "#/components/schemas/Path" } }, "alternative": { "type": "array", "items": { "$ref": "#/components/schemas/Path" } }, "propertyPath": { "type": "array", "items": { "$ref": "#/components/schemas/Path" } } } }, "PathVariableFilter": { "type": "object", "properties": { "varname": { "type": "string" }, "varIsAnyOneOfResource": { "type": "array", "items": { "type": "string" } }, "varIsAnyOneOfLiteral": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "isNoneOfResource": { "type": "array", "items": { "type": "string" } }, "isNoneOfLiteral": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "literalFilters": { "type": "array", "items": { "$ref": "#/components/schemas/PathVariableLiteralFilter" } } } }, "PathVariableLiteralFilter": { "required": [ "operation", "value" ], "type": "object", "properties": { "operation": { "type": "string", "enum": [ "GreaterThan", "LessThan", "GreaterEqualsThan", "LessEqualThan", "NotEquals", "Contains", "Regex" ] }, "value": { "$ref": "#/components/schemas/Literal" } } }, "QueryModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" } } }, "ReportsModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "listQuery": { "type": "string" } } }, "ResourceTableConfiguration": { "type": "object", "properties": { "timeoutDownload": { "type": "integer", "format": "int32" }, "paginationLimit": { "type": "integer", "format": "int32" } } }, "SearchModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "solrUrl": { "type": "string" } } }, "Tab": { "required": [ "name", "url" ], "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } } }, "TaskModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" } } }, "ThesaurusModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" } } }, "TrackingModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "listQuery": { "type": "string" }, "removeQuery": { "type": "string" }, "workerQuery": { "type": "string" }, "dataGraph": { "type": "string" }, "activitiesQuery": { "type": "string" } } }, "VocabularyModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" } } }, "WorkspaceConfiguration": { "required": [ "id" ], "type": "object", "properties": { "id": { "pattern": "^[a-zA-Z0-9-]+$", "type": "string" }, "order": { "type": "integer", "format": "int64" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/JsonLiteral" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/JsonLiteral" } }, "apiConfiguration": { "$ref": "#/components/schemas/ApiConfiguration" }, "appPresentationConfiguration": { "$ref": "#/components/schemas/AppPresentationConfiguration" }, "resourceTableConfiguration": { "$ref": "#/components/schemas/ResourceTableConfiguration" }, "diWorkspaceConfiguration": { "$ref": "#/components/schemas/DiWorkspaceConfiguration" }, "modules": { "$ref": "#/components/schemas/Modules" } } }, "WorkspaceGraphList": { "type": "object", "properties": { "iri": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/JsonLiteral" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/JsonLiteral" } }, "query": { "type": "string" }, "order": { "type": "integer", "format": "int64" }, "hideIfEmpty": { "type": "boolean" } } }, "ChartConfiguration": { "required": [ "description", "formType", "jsonSerialization", "labels", "referencedQueries" ], "type": "object", "properties": { "iri": { "type": "string" }, "labels": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/JsonLiteral" } }, "description": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/JsonLiteral" } }, "referencedQueries": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChartConfigurationQueryReference" } }, "formType": { "type": "string", "enum": [ "ASSISTED", "ADVANCED" ] }, "chartType": { "type": "string" }, "jsonSerialization": { "type": "string" } } }, "ChartConfigurationQueryReference": { "required": [ "index", "iri", "parameterValueMap" ], "type": "object", "properties": { "iri": { "type": "string" }, "index": { "type": "integer", "format": "int32" }, "parameterValueMap": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UpdateAccessConditionRequest": { "required": [ "allowedActions", "grantAllowedActions", "grantReadPatterns", "grantWritePatterns", "iri", "name", "readableGraphs", "requiresAccount", "requiresGroup", "writableGraphs" ], "type": "object", "properties": { "iri": { "type": "string" }, "name": { "type": "string" }, "comment": { "type": "string" }, "requiresAccount": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "requiresGroup": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "readableGraphs": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "writableGraphs": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "allowedActions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "grantAllowedActions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "grantReadPatterns": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "grantWritePatterns": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "dynamicAccessConditionQuery": { "type": "string" } } }, "AccessConditionView": { "required": [ "allowedActions", "created", "creator", "grantAllowedActions", "grantReadPatterns", "grantWritePatterns", "iri", "name", "readableGraphs", "requiresAccount", "requiresGroup", "writableGraphs" ], "type": "object", "properties": { "iri": { "type": "string" }, "name": { "type": "string" }, "comment": { "type": "string" }, "requiresAccount": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "requiresGroup": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "readableGraphs": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "writableGraphs": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "allowedActions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "grantAllowedActions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "grantReadPatterns": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "grantWritePatterns": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "dynamicAccessConditionQuery": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "creator": { "type": "string" }, "contributor": { "type": "string" }, "modified": { "type": "string", "format": "date-time" } } }, "SparqlQueryFramedSchema": { "required": [ "query" ], "type": "object", "properties": { "query": { "type": "string", "description": "A valid SPARQL 1.1 CONSTRUCT Query string as described in the [SPARQL 1.1 Query Language](https://www.w3.org/TR/sparql11-query/#construct)", "example": "CONSTRUCT ?class WHERE {?s a ?class}" }, "default-graph-uri": { "type": "array", "description": "May include zero or more default graph URIs", "items": { "type": "string", "description": "May include zero or more default graph URIs" } }, "named-graph-uri": { "type": "array", "description": "May include zero or more named graph URIs", "items": { "type": "string", "description": "May include zero or more named graph URIs" } }, "owlImportsResolution": { "type": "boolean", "description": "Enable/disable OWL imports resolution for this query" }, "base64encoded": { "type": "boolean", "description": "If set to true; the query parameter is expected in base64 encoding", "default": false }, "frame": { "type": "string", "default": "{}" } } }, "ResourceStoreFramedSchema": { "required": [ "graph", "resource" ], "type": "object", "properties": { "resource": { "type": "string", "description": "A valid resource URI ", "example": "http://example.org/person/Mark_Twain" }, "graph": { "type": "string", "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "example": "http://example.org/graph" }, "frame": { "type": "string", "description": "An optional JSON-LD frame used to force a specific JSON-LD tree layout." } } }, "PropertyUsage": { "type": "object", "properties": { "property": { "type": "string" }, "datatypesOfObjects": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "classesOfObjects": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "classesOfSubjects": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "languageTagsOfLiterals": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "FileUploadRequest": { "required": [ "fileId", "graphIri" ], "type": "object", "properties": { "fileId": { "type": "string", "description": "File id of previous analysis of this file (mandatory)" }, "graphIri": { "type": "string", "description": "Graph IRI for upload (mandatory)" } }, "description": "List of files to upload" }, "UploadRequest": { "required": [ "fileUploadRequests", "uploadId" ], "type": "object", "properties": { "uploadId": { "type": "string", "description": "Upload id of file" }, "fileUploadRequests": { "type": "array", "description": "List of files to upload", "items": { "$ref": "#/components/schemas/FileUploadRequest" } } } }, "RDFTerm": { "required": [ "termType" ], "type": "object", "properties": { "termType": { "type": "string", "enum": [ "RESOURCE", "BLANK_NODE", "LITERAL" ] }, "literal": { "$ref": "#/components/schemas/Literal" }, "resource": { "type": "string" } } }, "Statement": { "required": [ "object", "predicate", "subject" ], "type": "object", "properties": { "subject": { "type": "string" }, "predicate": { "type": "string" }, "object": { "$ref": "#/components/schemas/RDFTerm" }, "graph": { "type": "string" } } }, "StatementLevelMetadata": { "required": [ "metadataIri", "multiAnnotationValueCount", "object", "predicate", "subject" ], "type": "object", "properties": { "metadataIri": { "type": "string" }, "subject": { "type": "string" }, "predicate": { "type": "string" }, "object": { "$ref": "#/components/schemas/RDFTerm" }, "multiAnnotationValueCount": { "type": "integer", "format": "int64" } } }, "Filter": { "type": "object", "properties": { "variable": { "type": "string" }, "function": { "type": "string", "enum": [ "oneOf", "equals", "lessThan", "greaterThan", "contains", "startsWith", "endsWith", "language", "datatype", "isIri" ] }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/RdfTermNode" } } } }, "RdfTermNode": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "uri", "literal" ] }, "value": { "type": "string" }, "datatype": { "type": "string", "writeOnly": true }, "language": { "type": "string", "writeOnly": true } } }, "StatementFilter": { "type": "object", "properties": { "subjectFilter": { "$ref": "#/components/schemas/Filter" }, "predicateFilter": { "$ref": "#/components/schemas/Filter" }, "objectFilter": { "$ref": "#/components/schemas/Filter" } } }, "DepictionResolve": { "type": "object", "properties": { "resourceIri": { "type": "string" }, "direct": { "type": "boolean" }, "nodeShapeIri": { "type": "string" }, "depiction": { "type": "string" } } }, "Provenance": { "type": "object", "properties": { "graph": { "$ref": "#/components/schemas/ReadableGraph" }, "writable": { "type": "boolean" } } }, "ReadableGraph": { "required": [ "assignedClasses", "depiction", "diProjectGraph", "graphProperties", "iri", "label", "projectInternal", "systemResource", "writeable" ], "type": "object", "properties": { "iri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "depiction": { "$ref": "#/components/schemas/DepictionResolve" }, "assignedClasses": { "type": "array", "items": { "type": "string" } }, "graphProperties": { "type": "array", "items": { "type": "string" } }, "graphLists": { "type": "array", "items": { "type": "string" } }, "writeable": { "type": "boolean" }, "diProjectGraph": { "type": "boolean" }, "projectInternal": { "type": "boolean" }, "systemResource": { "type": "boolean" } } }, "RichStatement": { "required": [ "object", "predicate", "subject" ], "type": "object", "properties": { "subject": { "$ref": "#/components/schemas/ValueView" }, "predicate": { "$ref": "#/components/schemas/ValueView" }, "object": { "$ref": "#/components/schemas/ValueView" } } }, "ValueView": { "required": [ "value" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/RDFTerm" }, "titleResolve": { "$ref": "#/components/schemas/TitleResolve" }, "provenance": { "$ref": "#/components/schemas/Provenance" }, "annotated": { "type": "boolean" } } }, "BaseResource": { "required": [ "label" ], "type": "object", "properties": { "comment": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "iri": { "type": "string" } } }, "ResourceListParams": { "type": "object", "properties": { "pattern": { "$ref": "#/components/schemas/GraphResourcePattern" }, "scoringMethod": { "type": "string", "enum": [ "https://vocab.eccenca.com/configuration/ScoringByLuceneScore", "https://vocab.eccenca.com/configuration/ScoringByMatchLength", "https://vocab.eccenca.com/configuration/ScoringByDb" ] }, "projectedVars": { "type": "array", "items": { "type": "string" } }, "page": { "type": "integer", "format": "int64" }, "pageSize": { "type": "integer", "format": "int64" } } }, "ListResourceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SearchResult" } }, "hasMore": { "type": "boolean" } } }, "SearchResult": { "required": [ "highestRank", "matches", "resource" ], "type": "object", "properties": { "resource": { "type": "string" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/SearchResultMatch" } }, "highestRank": { "type": "number", "format": "double" } } }, "SearchResultMatch": { "type": "object", "properties": { "predicate": { "type": "string" }, "highlight": { "type": "string" }, "rank": { "type": "number", "format": "double" } } }, "ResourceListParseResult": { "type": "object", "properties": { "list": { "$ref": "#/components/schemas/ResourceListParams" }, "error": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } } } }, "ResourceListQuery": { "type": "object", "properties": { "query": { "type": "string" } } }, "GraphPatternParseResult": { "type": "object", "properties": { "error": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } }, "data": { "$ref": "#/components/schemas/GraphResourcePattern" } } }, "PropertyValueView": { "required": [ "annotateAble", "nodeShapeIris", "propLabel", "propShapeName", "propertyIri", "valueAddable" ], "type": "object", "properties": { "nodeShapeIris": { "type": "array", "items": { "type": "string" } }, "propertyIri": { "type": "string" }, "propShapeIri": { "type": "string" }, "propLabel": { "$ref": "#/components/schemas/TitleResolve" }, "propComment": { "$ref": "#/components/schemas/TitleResolve" }, "propShapeName": { "type": "string" }, "propShapeDescription": { "type": "string" }, "valueAddable": { "type": "boolean" }, "showAlways": { "type": "boolean" }, "group": { "$ref": "#/components/schemas/ShaclGroup" }, "minCount": { "type": "integer", "format": "int32" }, "maxCount": { "type": "integer", "format": "int32" }, "valueQuery": { "type": "string" }, "valueQueryHideHeader": { "type": "boolean" }, "valueQueryHideFooter": { "type": "boolean" }, "dataType": { "type": "string" }, "nodeKind": { "type": "string" }, "order": { "type": "integer", "format": "int64" }, "uiQuery": { "$ref": "#/components/schemas/ShuiSparqlQuery" }, "listQuery": { "type": "string" }, "annotateAble": { "type": "boolean" }, "denyNewResources": { "type": "boolean" }, "pattern": { "type": "string" }, "uriTemplate": { "type": "string" }, "flags": { "type": "string" }, "ignoreOnCopy": { "type": "boolean" }, "valueViews": { "type": "array", "items": { "$ref": "#/components/schemas/ValueView" } }, "nestedResourceViews": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceView" } }, "readOnly": { "type": "boolean" }, "textArea": { "type": "boolean" }, "inversePath": { "type": "boolean" }, "shClass": { "type": "array", "items": { "type": "string" } }, "langIn": { "type": "array", "items": { "type": "string" } }, "uniqueLang": { "type": "boolean" }, "complexPath": { "type": "boolean" }, "path": { "$ref": "#/components/schemas/Path" }, "workflowTriggers": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTrigger" } } } }, "ResourceView": { "required": [ "iri", "label" ], "type": "object", "properties": { "iri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "writable": { "type": "boolean" }, "listQuery": { "type": "array", "items": { "type": "string" } }, "shapedBy": { "type": "array", "items": { "type": "string" } }, "shapedByNodeShape": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TitleResolve" } }, "shapedByNodeShapeComment": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TitleResolve" } }, "poViews": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyValueView" } } } }, "ShaclGroup": { "required": [ "iri", "label", "labels" ], "type": "object", "properties": { "iri": { "type": "string" }, "depictionUri": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "order": { "type": "integer", "format": "int32" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } }, "ShuiSparqlQuery": { "type": "object", "properties": { "iri": { "type": "string" }, "queryType": { "type": "string" }, "queryText": { "type": "string" } } }, "WorkflowTrigger": { "required": [ "iri", "label", "labels" ], "type": "object", "properties": { "iri": { "type": "string" }, "depictionUri": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "triggeredWorkflow": { "type": "string" }, "triggeredWorkflowId": { "type": "string" }, "refreshViewOnTaskEnded": { "type": "boolean" }, "sendResourceReference": { "type": "boolean" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } }, "ChangeSet": { "type": "object", "properties": { "resource": { "type": "string" }, "newResource": { "type": "boolean" }, "nodeShapeIris": { "type": "array", "items": { "type": "string" } }, "valueChanges": { "type": "array", "items": { "$ref": "#/components/schemas/ValueChange" } } } }, "ResourceChangeSet": { "required": [ "mainResource" ], "type": "object", "properties": { "mainResource": { "type": "string" }, "comment": { "type": "string" }, "annotationFor": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeSet" } } } }, "ValueChange": { "type": "object", "properties": { "propertyShapeIri": { "type": "string" }, "propertyIri": { "type": "string" }, "deletes": { "type": "array", "items": { "$ref": "#/components/schemas/RDFTerm" } }, "inserts": { "type": "array", "items": { "$ref": "#/components/schemas/RDFTerm" } } } }, "SaveReport": { "required": [ "deletedCount", "duration", "end", "insertedCount", "metadataCount", "persistedIris", "resource", "start", "versioningCount" ], "type": "object", "properties": { "resource": { "type": "string" }, "start": { "type": "integer", "format": "int64" }, "end": { "type": "integer", "format": "int64" }, "duration": { "type": "integer", "format": "int64" }, "insertedCount": { "type": "integer", "format": "int32" }, "deletedCount": { "type": "integer", "format": "int32" }, "versioningCount": { "type": "integer", "format": "int32" }, "metadataCount": { "type": "integer", "format": "int32" }, "persistedIris": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ResourceRelationParam": { "type": "object", "properties": { "resources": { "type": "array", "items": { "type": "string" } }, "backgroundResources": { "type": "array", "items": { "type": "string" } } } }, "RelatesTo": { "type": "object", "properties": { "target": { "type": "array", "items": { "type": "string" } }, "path": { "$ref": "#/components/schemas/Path" }, "propertyShapeIris": { "type": "array", "items": { "type": "string" } }, "nodeShapeIris": { "type": "array", "items": { "type": "string" } } } }, "ResourceRelationResponse": { "type": "object", "properties": { "sources": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/RelatesTo" } } } } }, "QueryTypeAnalysis": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } }, "FormatResponse": { "required": [ "query" ], "type": "object", "properties": { "query": { "type": "string" } } }, "LogicalPlanResponse": { "required": [ "plan" ], "type": "object", "properties": { "plan": { "type": "string" } } }, "CreateResponse": { "type": "object", "properties": { "iri": { "type": "string" } } }, "FacetListEntry": { "required": [ "description", "iri", "label" ], "type": "object", "properties": { "iri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "description": { "$ref": "#/components/schemas/TitleResolve" } } }, "CreateAccessConditionRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "comment": { "type": "string" }, "requiresAccount": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "requiresGroup": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "readableGraphs": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "writableGraphs": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "allowedActions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "grantAllowedActions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "grantReadPatterns": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "grantWritePatterns": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "dynamicAccessConditionQuery": { "type": "string" } } }, "UiChatMessage": { "type": "object", "properties": { "type": { "type": "string" }, "text": { "type": "string" } } }, "BootstrapOntologyResponse": { "type": "object", "properties": { "aiMessage": { "type": "string" }, "response": { "$ref": "#/components/schemas/CreateOntologyResponse" } } }, "CreateOntologyResponse": { "type": "object", "properties": { "classes": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOntologyResponseClass" } }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOntologyResponseRelation" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOntologyResponseAttribute" } }, "individuals": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOntologyResponseIndividual" } } } }, "CreateOntologyResponseAttribute": { "required": [ "id", "label" ], "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "range": { "type": "string" } } }, "CreateOntologyResponseClass": { "required": [ "id", "label" ], "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "parentClasses": { "type": "array", "items": { "type": "string" } } } }, "CreateOntologyResponseIndividual": { "required": [ "id", "label" ], "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "classes": { "type": "array", "items": { "type": "string" } } } }, "CreateOntologyResponseRelation": { "required": [ "id", "label" ], "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "range": { "type": "string" } } }, "AssistResponse": { "type": "object", "properties": { "gotoResource": { "type": "string" }, "query": { "type": "string" }, "unclearMessage": { "type": "string" } } }, "UserInfoSchema": { "type": "object", "properties": { "accountName": { "type": "string" }, "uri": { "type": "string" } } }, "EndpointDescription": { "type": "object", "properties": { "graphs": { "type": "array", "items": { "$ref": "#/components/schemas/Graph" } } } }, "Graph": { "type": "object", "properties": { "iri": { "type": "string" }, "writeable": { "type": "boolean" } } }, "GraphCount": { "type": "object", "properties": { "graphIri": { "type": "string" }, "triplesCount": { "type": "integer", "format": "int32" }, "graphLabel": { "type": "string" }, "writable": { "type": "boolean" } } }, "QueryResult": { "type": "object" }, "ApplicationContext": { "type": "object", "properties": { "parent": { "$ref": "#/components/schemas/ApplicationContext" }, "id": { "type": "string" }, "displayName": { "type": "string" }, "autowireCapableBeanFactory": { "$ref": "#/components/schemas/AutowireCapableBeanFactory" }, "applicationName": { "type": "string" }, "startupDate": { "type": "integer", "format": "int64" }, "environment": { "$ref": "#/components/schemas/Environment" }, "beanDefinitionCount": { "type": "integer", "format": "int32" }, "beanDefinitionNames": { "type": "array", "items": { "type": "string" } }, "parentBeanFactory": { "$ref": "#/components/schemas/BeanFactory" }, "classLoader": { "type": "object", "properties": { "name": { "type": "string" }, "registeredAsParallelCapable": { "type": "boolean" }, "parent": { "type": "object", "properties": { "name": { "type": "string" }, "registeredAsParallelCapable": { "type": "boolean" }, "unnamedModule": { "type": "object", "properties": { "name": { "type": "string" }, "classLoader": { "type": "object", "properties": { "name": { "type": "string" }, "registeredAsParallelCapable": { "type": "boolean" }, "definedPackages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "annotations": { "type": "array", "items": { "type": "object" } }, "declaredAnnotations": { "type": "array", "items": { "type": "object" } }, "sealed": { "type": "boolean" }, "specificationTitle": { "type": "string" }, "specificationVersion": { "type": "string" }, "specificationVendor": { "type": "string" }, "implementationTitle": { "type": "string" }, "implementationVersion": { "type": "string" }, "implementationVendor": { "type": "string" } } } }, "defaultAssertionStatus": { "type": "boolean", "writeOnly": true } } }, "descriptor": { "type": "object", "properties": { "open": { "type": "boolean" }, "automatic": { "type": "boolean" } } }, "named": { "type": "boolean" }, "annotations": { "type": "array", "items": { "type": "object" } }, "declaredAnnotations": { "type": "array", "items": { "type": "object" } }, "packages": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "layer": { "type": "object" } } }, "definedPackages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "annotations": { "type": "array", "items": { "type": "object" } }, "declaredAnnotations": { "type": "array", "items": { "type": "object" } }, "sealed": { "type": "boolean" }, "specificationTitle": { "type": "string" }, "specificationVersion": { "type": "string" }, "specificationVendor": { "type": "string" }, "implementationTitle": { "type": "string" }, "implementationVersion": { "type": "string" }, "implementationVendor": { "type": "string" } } } }, "defaultAssertionStatus": { "type": "boolean", "writeOnly": true } } }, "unnamedModule": { "type": "object", "properties": { "name": { "type": "string" }, "classLoader": { "type": "object", "properties": { "name": { "type": "string" }, "registeredAsParallelCapable": { "type": "boolean" }, "definedPackages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "annotations": { "type": "array", "items": { "type": "object" } }, "declaredAnnotations": { "type": "array", "items": { "type": "object" } }, "sealed": { "type": "boolean" }, "specificationTitle": { "type": "string" }, "specificationVersion": { "type": "string" }, "specificationVendor": { "type": "string" }, "implementationTitle": { "type": "string" }, "implementationVersion": { "type": "string" }, "implementationVendor": { "type": "string" } } } }, "defaultAssertionStatus": { "type": "boolean", "writeOnly": true } } }, "descriptor": { "type": "object", "properties": { "open": { "type": "boolean" }, "automatic": { "type": "boolean" } } }, "named": { "type": "boolean" }, "annotations": { "type": "array", "items": { "type": "object" } }, "declaredAnnotations": { "type": "array", "items": { "type": "object" } }, "packages": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "layer": { "type": "object" } } }, "definedPackages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "annotations": { "type": "array", "items": { "type": "object" } }, "declaredAnnotations": { "type": "array", "items": { "type": "object" } }, "sealed": { "type": "boolean" }, "specificationTitle": { "type": "string" }, "specificationVersion": { "type": "string" }, "specificationVendor": { "type": "string" }, "implementationTitle": { "type": "string" }, "implementationVersion": { "type": "string" }, "implementationVendor": { "type": "string" } } } }, "defaultAssertionStatus": { "type": "boolean", "writeOnly": true } } } } }, "AutowireCapableBeanFactory": { "type": "object" }, "BeanFactory": { "type": "object" }, "Environment": { "type": "object", "properties": { "activeProfiles": { "type": "array", "items": { "type": "string" } }, "defaultProfiles": { "type": "array", "items": { "type": "string" } } } }, "FilterRegistration": { "type": "object", "properties": { "servletNameMappings": { "type": "array", "items": { "type": "string" } }, "urlPatternMappings": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "className": { "type": "string" }, "initParameters": { "type": "object", "additionalProperties": { "type": "string" } } } }, "HttpStatusCode": { "type": "object", "properties": { "error": { "type": "boolean" }, "is5xxServerError": { "type": "boolean" }, "is1xxInformational": { "type": "boolean" }, "is2xxSuccessful": { "type": "boolean" }, "is3xxRedirection": { "type": "boolean" }, "is4xxClientError": { "type": "boolean" } } }, "JspConfigDescriptor": { "type": "object", "properties": { "taglibs": { "type": "array", "items": { "$ref": "#/components/schemas/TaglibDescriptor" } }, "jspPropertyGroups": { "type": "array", "items": { "$ref": "#/components/schemas/JspPropertyGroupDescriptor" } } } }, "JspPropertyGroupDescriptor": { "type": "object", "properties": { "buffer": { "type": "string" }, "includeCodas": { "type": "array", "items": { "type": "string" } }, "deferredSyntaxAllowedAsLiteral": { "type": "string" }, "trimDirectiveWhitespaces": { "type": "string" }, "errorOnUndeclaredNamespace": { "type": "string" }, "elIgnored": { "type": "string" }, "errorOnELNotFound": { "type": "string" }, "pageEncoding": { "type": "string" }, "scriptingInvalid": { "type": "string" }, "isXml": { "type": "string" }, "includePreludes": { "type": "array", "items": { "type": "string" } }, "urlPatterns": { "type": "array", "items": { "type": "string" } }, "defaultContentType": { "type": "string" } } }, "RedirectView": { "type": "object", "properties": { "applicationContext": { "$ref": "#/components/schemas/ApplicationContext" }, "servletContext": { "$ref": "#/components/schemas/ServletContext" }, "contentType": { "type": "string" }, "requestContextAttribute": { "type": "string" }, "staticAttributes": { "type": "object", "additionalProperties": { "type": "object" } }, "exposePathVariables": { "type": "boolean" }, "exposeContextBeansAsAttributes": { "type": "boolean", "writeOnly": true }, "exposedContextBeanNames": { "type": "array", "writeOnly": true, "items": { "type": "string" } }, "beanName": { "type": "string" }, "url": { "type": "string" }, "contextRelative": { "type": "boolean", "writeOnly": true }, "http10Compatible": { "type": "boolean", "writeOnly": true }, "exposeModelAttributes": { "type": "boolean", "writeOnly": true }, "encodingScheme": { "type": "string", "writeOnly": true }, "statusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "expandUriTemplateVariables": { "type": "boolean", "writeOnly": true }, "propagateQueryParams": { "type": "boolean", "writeOnly": true }, "hosts": { "type": "array", "items": { "type": "string" } }, "redirectView": { "type": "boolean" }, "propagateQueryProperties": { "type": "boolean" }, "attributesMap": { "type": "object", "additionalProperties": { "type": "object" } }, "attributesCSV": { "type": "string", "writeOnly": true }, "attributes": { "type": "object", "additionalProperties": { "type": "string" }, "writeOnly": true } } }, "ServletContext": { "type": "object", "properties": { "classLoader": { "type": "object", "properties": { "name": { "type": "string" }, "registeredAsParallelCapable": { "type": "boolean" }, "definedPackages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "annotations": { "type": "array", "items": { "type": "object" } }, "declaredAnnotations": { "type": "array", "items": { "type": "object" } }, "sealed": { "type": "boolean" }, "specificationTitle": { "type": "string" }, "specificationVersion": { "type": "string" }, "specificationVendor": { "type": "string" }, "implementationTitle": { "type": "string" }, "implementationVersion": { "type": "string" }, "implementationVendor": { "type": "string" } } } }, "defaultAssertionStatus": { "type": "boolean", "writeOnly": true } } }, "majorVersion": { "type": "integer", "format": "int32" }, "minorVersion": { "type": "integer", "format": "int32" }, "initParameterNames": { "type": "object" }, "effectiveMajorVersion": { "type": "integer", "format": "int32" }, "effectiveMinorVersion": { "type": "integer", "format": "int32" }, "serverInfo": { "type": "string" }, "servletContextName": { "type": "string" }, "servletRegistrations": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ServletRegistration" } }, "filterRegistrations": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FilterRegistration" } }, "sessionCookieConfig": { "$ref": "#/components/schemas/SessionCookieConfig" }, "sessionTrackingModes": { "uniqueItems": true, "type": "array", "writeOnly": true, "items": { "type": "string", "enum": [ "COOKIE", "URL", "SSL" ] } }, "defaultSessionTrackingModes": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "COOKIE", "URL", "SSL" ] } }, "effectiveSessionTrackingModes": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "COOKIE", "URL", "SSL" ] } }, "jspConfigDescriptor": { "$ref": "#/components/schemas/JspConfigDescriptor" }, "virtualServerName": { "type": "string" }, "sessionTimeout": { "type": "integer", "format": "int32" }, "requestCharacterEncoding": { "type": "string" }, "responseCharacterEncoding": { "type": "string" }, "contextPath": { "type": "string" }, "attributeNames": { "type": "object" } } }, "ServletRegistration": { "type": "object", "properties": { "mappings": { "type": "array", "items": { "type": "string" } }, "runAsRole": { "type": "string" }, "name": { "type": "string" }, "className": { "type": "string" }, "initParameters": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SessionCookieConfig": { "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "comment": { "type": "string", "deprecated": true }, "secure": { "type": "boolean" }, "maxAge": { "type": "integer", "format": "int32" }, "domain": { "type": "string" }, "httpOnly": { "type": "boolean" } } }, "TaglibDescriptor": { "type": "object", "properties": { "taglibURI": { "type": "string" }, "taglibLocation": { "type": "string" } } }, "ImportTree": { "type": "object", "properties": { "tree": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "ignored": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "ReadableGraphDetailed": { "required": [ "iri", "label" ], "type": "object", "properties": { "iri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "triplesCount": { "type": "integer", "format": "int32" }, "classesCount": { "type": "integer", "format": "int32" }, "wellDefinedClassesCount": { "type": "integer", "format": "int32" }, "instancesCount": { "type": "integer", "format": "int32" } } }, "ClassUptake": { "type": "object", "properties": { "classIri": { "type": "string" }, "usedInGraph": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "PropertyUptake": { "type": "object", "properties": { "propertyIri": { "type": "string" }, "usedInGraph": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "VocabUptake": { "type": "object", "properties": { "graphIri": { "type": "string" }, "classUptakes": { "type": "array", "items": { "$ref": "#/components/schemas/ClassUptake" } }, "propertyUptakes": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyUptake" } } } }, "UsageConnectedClasses": { "required": [ "property", "sourceClass", "targetClass" ], "type": "object", "properties": { "sourceClass": { "type": "string" }, "targetClass": { "type": "string" }, "property": { "type": "string" } } }, "ShapeConnectedClasses": { "required": [ "propertyShape", "sourceClass", "targetClass" ], "type": "object", "properties": { "sourceClass": { "type": "string" }, "targetClass": { "type": "string" }, "propertyShape": { "type": "string" } } }, "VocabularyProperty": { "required": [ "iri", "label", "labels" ], "type": "object", "properties": { "iri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "parentClass": { "type": "array", "items": { "type": "string" } }, "definedBy": { "type": "array", "items": { "type": "string" } }, "domain": { "type": "array", "items": { "type": "string" } }, "range": { "type": "array", "items": { "type": "string" } }, "sourceGraph": { "type": "array", "items": { "type": "string" } } } }, "VocabularyClass": { "required": [ "iri", "label", "labels" ], "type": "object", "properties": { "iri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "depictionUri": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "parentClass": { "type": "array", "items": { "type": "string" } }, "definedBy": { "type": "array", "items": { "type": "string" } }, "sourceGraph": { "type": "array", "items": { "type": "string" } } } }, "VocabList": { "type": "object", "properties": { "vocabularies": { "type": "array", "items": { "$ref": "#/components/schemas/Vocabulary" } }, "totalCount": { "type": "integer", "format": "int32" } } }, "Vocabulary": { "type": "object", "properties": { "iri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "description": { "$ref": "#/components/schemas/TitleResolve" }, "modifications": { "type": "array", "items": { "type": "string", "format": "date-time" } }, "created": { "type": "string", "format": "date-time" }, "installed": { "type": "boolean" }, "downloadUrl": { "type": "string" }, "preferredNamespace": { "type": "string" }, "namespacePrefix": { "type": "string" }, "vocabularyLabel": { "type": "string" }, "modified": { "type": "string", "format": "date-time" } } }, "FileAnalysis": { "type": "object", "properties": { "fileId": { "type": "string", "description": "Created fileId for file" }, "fileName": { "type": "string", "description": "File name as delivered in upload" }, "suggestedGraphs": { "type": "array", "description": "List of suggested graph IRIs extracted out of file content", "items": { "type": "string", "description": "List of suggested graph IRIs extracted out of file content" } }, "errorMessage": { "type": "string", "description": "Error while parsing the file (format, parsing error etc.)" }, "lang": { "type": "string", "description": "RDF type of parsed file, one of TURTLE, JSON_LD, RDF_JSON, RDF_XML, NTRIPLES, TRIG, NQUADS", "example": "TURTLE" } }, "description": "Collection of single file analysis results containing metrics" }, "UploadAnalytics": { "type": "object", "properties": { "uploadId": { "type": "string", "description": "Id of this upload for later reference" }, "fileName": { "type": "string", "description": "File name of uploaded file" }, "fileAnalyses": { "type": "array", "description": "Collection of single file analysis results containing metrics", "items": { "$ref": "#/components/schemas/FileAnalysis" } } } }, "FileUploadStats": { "required": [ "fileId", "fileName", "fileUploadStatus", "uploadId" ], "type": "object", "properties": { "uploadId": { "type": "string", "description": "Upload id of the original store request for this file" }, "fileId": { "type": "string", "description": "File id of the original analysis request for this file" }, "fileName": { "type": "string", "description": "File name as provided in upload" }, "uploadStarted": { "type": "string", "description": "Time for the start of upload to store (UTC)", "format": "date-time" }, "uploadFinished": { "type": "string", "description": "Time for the end of upload to store (UTC)", "format": "date-time" }, "fileUploadStatus": { "type": "string", "description": "Status of the upload of this file (one of QUEUED, STARTED, UPLOADING, FINISHED, FAILED)", "enum": [ "QUEUED", "STARTED", "UPLOADING", "FINISHED", "FAILED" ] }, "errorMessage": { "type": "string", "description": "Error message if error occurred" } }, "description": "Status infos for single requested file uploads" }, "UploadStatusInfo": { "required": [ "fileUploadStats", "status", "uploadId" ], "type": "object", "properties": { "uploadId": { "type": "string", "description": "Upload id of stored file (data or archive)" }, "fileUploadStats": { "type": "array", "description": "Status infos for single requested file uploads", "items": { "$ref": "#/components/schemas/FileUploadStats" } }, "status": { "type": "string", "description": "Summary status for upload (one of QUEUED, RUNNING, FINISHED, FAILED)", "enum": [ "QUEUED", "RUNNING", "FINISHED", "FAILED" ] } } }, "ConnectableProperties": { "type": "object", "properties": { "preferredAnnotableProperties": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResource" } }, "allAnnotateableProperties": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResource" } } } }, "NodeShapeListEntry": { "type": "object", "properties": { "iri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "propertyCount": { "type": "integer", "format": "int32" } } }, "NodeShape": { "required": [ "iri", "label", "labels" ], "type": "object", "properties": { "iri": { "type": "string" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "depictionUri": { "type": "string" }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "VALIDATION" ] }, "deactived": { "type": "boolean" }, "closed": { "type": "boolean" }, "displayNames": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "targetClasses": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyShape" } }, "listQuery": { "$ref": "#/components/schemas/ShuiSparqlQuery" }, "targetGraphTemplate": { "$ref": "#/components/schemas/TargetGraphTemplate" }, "onDeleteUpdate": { "$ref": "#/components/schemas/ShuiSparqlQuery" }, "onUpdateUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/ShuiSparqlQuery" } }, "isApplicableAsStatementLevelMetadata": { "type": "boolean" }, "enableStatementLevelMetadata": { "type": "boolean" }, "metadataPreferredNodeShapes": { "type": "array", "items": { "type": "string" } }, "uriTemplate": { "$ref": "#/components/schemas/UriTemplate" }, "order": { "type": "integer", "format": "int32" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } }, "PropertyShape": { "required": [ "iri", "label", "labels" ], "type": "object", "properties": { "iri": { "type": "string" }, "depictionUri": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "path": { "type": "string" }, "shapePath": { "$ref": "#/components/schemas/Path" }, "names": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "order": { "type": "integer", "format": "int64" }, "propertyClass": { "type": "array", "items": { "type": "string" } }, "dataType": { "type": "string" }, "minCount": { "type": "integer", "format": "int32" }, "maxCount": { "type": "integer", "format": "int32" }, "nodeKind": { "type": "string" }, "group": { "$ref": "#/components/schemas/ShaclGroup" }, "readOnly": { "type": "boolean" }, "valueQuery": { "$ref": "#/components/schemas/ShuiSparqlQuery" }, "valueQueryHideFooter": { "type": "boolean" }, "valueQueryHideHeader": { "type": "boolean" }, "onInsertQueries": { "type": "array", "items": { "$ref": "#/components/schemas/ShuiSparqlQuery" } }, "onDeleteQueries": { "type": "array", "items": { "$ref": "#/components/schemas/ShuiSparqlQuery" } }, "uiQuery": { "$ref": "#/components/schemas/ShuiSparqlQuery" }, "targetGraphTemplate": { "$ref": "#/components/schemas/TargetGraphTemplate" }, "metadataPreferredNodeShapes": { "type": "array", "items": { "type": "string" } }, "enableStatementLevelMetadata": { "type": "boolean" }, "nodeShapes": { "type": "array", "items": { "type": "string" } }, "inversePath": { "type": "boolean" }, "denyNewResources": { "type": "boolean" }, "descriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "ignoreOnCopy": { "type": "boolean" }, "flags": { "type": "string" }, "pattern": { "type": "string" }, "textArea": { "type": "boolean" }, "uriTemeplate": { "type": "string" }, "showAlways": { "type": "boolean" }, "shClass": { "type": "array", "items": { "type": "string" } }, "langIn": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "uniqueLang": { "type": "boolean" }, "workflowTriggers": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTrigger" } }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } }, "TargetGraphTemplate": { "type": "object", "properties": { "iri": { "type": "string" }, "templateString": { "type": "string" }, "resourceOwnshipMethod": { "type": "string" } } }, "UriTemplate": { "required": [ "iri", "label", "labels" ], "type": "object", "properties": { "iri": { "type": "string" }, "depictionUri": { "type": "string" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "templateString": { "type": "string" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } }, "SearchTermAnalysis": { "type": "object", "properties": { "originalTerm": { "type": "string" }, "refactoredTerm": { "type": "string" }, "errorMessage": { "type": "string" } } }, "ResourceUsage": { "type": "object", "properties": { "iri": { "type": "string" }, "resolve": { "$ref": "#/components/schemas/TitleResolve" }, "asAnnotationValue": { "type": "array", "items": { "$ref": "#/components/schemas/ValueView" } }, "asAnnotationValueHasMore": { "type": "boolean" }, "asStatementValue": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } }, "asSubjectInGraph": { "type": "array", "items": { "$ref": "#/components/schemas/ReadableGraph" } }, "asObjectInGraph": { "type": "array", "items": { "$ref": "#/components/schemas/ReadableGraph" } } } }, "DataResponseError": { "type": "object", "properties": { "resourceIri": { "type": "string" }, "contextIri": { "type": "string" }, "property": { "type": "string" }, "code": { "type": "string" } } }, "ListResponseCatalogQuery": { "type": "object", "properties": { "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/DataResponseError" } }, "payload": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogQuery" } } } }, "Report": { "type": "object", "properties": { "iri": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "queryParameter": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "ReportList": { "type": "object", "properties": { "queries": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } } }, "PrefixDataView": { "type": "object", "properties": { "catalogPrefixes": { "type": "object", "additionalProperties": { "type": "string" } }, "catalogNamespacesWithMultiplePrefixes": { "type": "array", "items": { "type": "string" } }, "catalogPrefixesWithMultipleNamespaces": { "type": "array", "items": { "type": "string" } }, "installedPrefixes": { "type": "object", "additionalProperties": { "type": "string" } }, "installedNamespacesWithMultiplePrefixes": { "type": "array", "items": { "type": "string" } }, "installedPrefixesWithMultipleNamespaces": { "type": "array", "items": { "type": "string" } }, "diPrefixes": { "type": "object", "additionalProperties": { "type": "string" } }, "diNamespacesWithMultiplePrefixes": { "type": "array", "items": { "type": "string" } }, "diPrefixesWithMultipleNamespaces": { "type": "array", "items": { "type": "string" } }, "userPrefixes": { "type": "object", "additionalProperties": { "type": "string" } }, "userNamespacesWithMultiplePrefixes": { "type": "array", "items": { "type": "string" } }, "userPrefixesWithMultipleNamespaces": { "type": "array", "items": { "type": "string" } } } }, "VizListEntry": { "required": [ "contextGraph", "iri", "label", "labels" ], "type": "object", "properties": { "iri": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "depictionUri": { "type": "string" }, "contextGraph": { "type": "string" }, "created": { "$ref": "#/components/schemas/Literal" }, "creator": { "type": "string" }, "modified": { "$ref": "#/components/schemas/Literal" }, "contributor": { "type": "string" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } }, "GraphConfiguration": { "type": "object", "properties": { "iri": { "type": "string" }, "targetGraph": { "type": "string" }, "isImporting": { "type": "array", "items": { "type": "string" } }, "gitSyncEnabled": { "type": "boolean" }, "repository": { "type": "string" }, "file": { "type": "string" }, "systemRelativeFilePath": { "type": "string" } } }, "GitGraphSyncDiff": { "required": [ "addedStatements", "deletedStatements", "ignoredAddedStatements", "ignoredDeletedStatements" ], "type": "object", "properties": { "addedStatements": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } }, "deletedStatements": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } }, "ignoredAddedStatements": { "type": "integer", "format": "int64" }, "ignoredDeletedStatements": { "type": "integer", "format": "int64" } } }, "GitGraphSyncChange": { "required": [ "author", "commit", "message", "timestamp" ], "type": "object", "properties": { "author": { "type": "string" }, "timestamp": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "commit": { "type": "string" } } }, "FacetDetail": { "required": [ "count", "iri", "label" ], "type": "object", "properties": { "iri": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "description": { "$ref": "#/components/schemas/TitleResolve" } } }, "WorkspaceConfigurationSetResponse": { "type": "object", "properties": { "systemDefaultConfiguration": { "$ref": "#/components/schemas/WorkspaceConfiguration" }, "projectDefaultConfiguration": { "$ref": "#/components/schemas/WorkspaceConfiguration" }, "projectWorkspaces": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } }, "Pageable": { "type": "object", "properties": { "page": { "minimum": 0, "type": "integer", "format": "int32" }, "size": { "minimum": 1, "type": "integer", "format": "int32" }, "sort": { "type": "array", "items": { "type": "string" } } } }, "PageAccessConditionView": { "type": "object", "properties": { "totalPages": { "type": "integer", "format": "int32" }, "totalElements": { "type": "integer", "format": "int64" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AccessConditionView" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "empty": { "type": "boolean" } } }, "PageableObject": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int64" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "paged": { "type": "boolean" }, "unpaged": { "type": "boolean" } } }, "SortObject": { "type": "object", "properties": { "empty": { "type": "boolean" }, "sorted": { "type": "boolean" }, "unsorted": { "type": "boolean" } } }, "QueryExecutionStats": { "type": "object", "properties": { "traceId": { "type": "string" }, "id": { "type": "string" }, "queryString": { "type": "string" }, "user": { "type": "string" }, "type": { "type": "string", "enum": [ "ASK", "SELECT", "DESCRIBE", "CONSTRUCT", "UPDATE", "UNKNOWN" ] }, "timeout": { "type": "integer", "format": "int64" }, "executionStarted": { "type": "integer", "format": "int64" }, "executionFinished": { "type": "integer", "format": "int64" }, "queryExecutionState": { "type": "string", "enum": [ "CREATED", "RUNNING", "FINISHED_SUCCESS", "FINISHED_CANCELLED", "FINISHED_ERROR", "FINISHED_TIMEOUT" ] }, "error": { "type": "string" }, "affectedGraphs": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "dataplatformNode": { "type": "string" }, "queryStringSha1Hash": { "type": "string" }, "executionTime": { "type": "integer", "format": "int64" } } } }, "responses": { "sgs200Get": { "description": "The request was processed successfully.", "headers": { "ETag": { "description": "Present only if the `etag` parameter was set to `true`. Contains a [weak ETag](https://tools.ietf.org/html/rfc7232#section-2.3) for the loaded graph. The tag consists of a hash/digest of the referenced graph.", "schema": { "type": "string" } } }, "content": { "text/turtle": { "schema": { "type": "string" }, "examples": { "turtle-example": { "$ref": "#/components/examples/turtle-example" } } }, "application/n-triples": { "schema": { "type": "string" } }, "application/rdf+xml": { "schema": { "type": "string" } } } }, "sgs200Head": { "description": "The request was processed successfully.", "headers": { "ETag": { "description": "Present only if the `etag` parameter was set to `true`. Contains a [weak ETag](https://tools.ietf.org/html/rfc7232#section-2.3) for the loaded graph. The tag consists of a hash/digest of the referenced graph.", "schema": { "type": "string" } } } }, "sgs204": { "description": "The request was processed successfully, but the graph is empty." }, "sgs409": { "description": "Transaction aborted due to deadlock. Retrying should solve the problem." }, "sgs415": { "description": "The current user is not authorized to access the given graph." }, "sgs503": { "description": "The given media type is not supported." }, "sq200": { "description": "Returns the result of the SPARQL query, which will either be a result set (in case of SELECT \u0026 ASK queries) or an RDF model (in case of CONSTRUCT \u0026 DESCRIBE queries).", "content": { "text/turtle": { "schema": { "type": "string" }, "examples": { "turtle-example": { "$ref": "#/components/examples/turtle-example" } } }, "application/json": { "schema": { "type": "string" } }, "application/ld+json": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" } }, "application/rdf+json": { "schema": { "type": "string" } }, "application/rdf+xml": { "schema": { "type": "string" } }, "application/sparql-results+json": { "schema": { "type": "string" } }, "application/sparql-results+xml": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string" } }, "text/csv": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } } } }, "g204": { "description": "The request was processed successfully, but no information for the given parameters was found." }, "g204NC": { "description": "The request was processed successfully, no content is returned." }, "g400": { "description": "The server cannot or will not process the request due to a query parsing error (e.g., due to a defective graph URI)." }, "g400Params": { "description": "The request was malformed, check the parameters." }, "g403": { "description": "The current user is not authorized to access the given graph." }, "g404": { "description": "The endpoint that has been requested could not be found." }, "g503": { "description": "The connection pool to the database is overloaded, retry in a few (milli)seconds." }, "g406": { "description": "The endpoint cannot produce a response matching the list of acceptable values" } }, "examples": { "turtle-example": { "value": "PREFIX rdf: \u003chttp://www.w3.org/1999/02/22-rdf-syntax-ns#\u003e\nPREFIX owl: \u003chttp://www.w3.org/2002/07/owl#\u003e\nPREFIX example: \u003chttp://example.org/\u003e\nexample:class rdf:type owl:Class .\nexample:instance rdf:type example:class .\n" }, "additional-columns-example": { "value": "{\n \"label\": \"http://www.w3.org/2000/01/rdf-schema#label\",\n \"prefLabel\": \"http://www.w3.org/2004/02/skos/core#prefLabel\"\n}" }, "filter-example": { "value": "[\n {\n \"variable\": \"s\",\n \"function\": \"oneOf\",\n \"parameters\": [\n {\n \"type\": \"uri\",\n \"value\": \"urn:some:resource\"\n },\n {\n \"type\": \"uri\",\n \"value\": \"urn:another:resource\"\n }\n ]\n },\n {\n \"variable\": \"o\",\n \"function\": \"lessThan\",\n \"parameters\": [\n {\n \"type\": \"literal\",\n \"value\": \"100\",\n \"datatype\": \"http://www.w3.org/2001/XMLSchema#long\"\n }\n ]\n }\n]\n" }, "order-by-example": { "value": "[\n {\n \"variable\": \"age\",\n \"modifier\": \"DESC\"\n },\n {\n \"variable\": \"resource\",\n \"modifier\": \"ASC\"\n }\n]\n" }, "sparql-results-json-count-example": { "value": "{\n \"head\": {\n \"vars\": [ \"count\" ]\n },\n \"results\": {\n \"bindings\": [\n {\n \"count\": {\n \"type\": \"literal\",\n \"datatype\": \"http://www.w3.org/2001/XMLSchema#integer\",\n \"value\": \"42\"\n }\n }\n ]\n }\n}\n" }, "sparql-results-xml-example": { "value": "\u003c?xml version\u003d\u00271.0\u0027 encoding\u003d\u0027UTF-8\u0027?\u003e\n\u003csparql xmlns\u003d\u0027http://www.w3.org/2005/sparql-results#\u0027\u003e\n \u003chead\u003e\n \u003cvariable name\u003d\u0027greeting\u0027/\u003e\n \u003cvariable name\u003d\u0027language\u0027/\u003e\n \u003c/head\u003e\n \u003cresults\u003e\n \u003cresult\u003e\n \u003cbinding name\u003d\u0027greeting\u0027\u003e\n \u003cliteral\u003eHello!\u003c/literal\u003e\n \u003c/binding\u003e\n \u003cbinding name\u003d\u0027language\u0027\u003e\n \u003curi\u003ehttp://www.lexvo.org/page/iso639-3/eng\u003c/uri\u003e\n \u003c/binding\u003e\n \u003c/result\u003e\n \u003cresult\u003e\n \u003cbinding name\u003d\u0027greeting\u0027\u003e\n \u003cliteral\u003eHallo!\u003c/literal\u003e\n \u003c/binding\u003e\n \u003cbinding name\u003d\u0027language\u0027\u003e\n \u003curi\u003ehttp://www.lexvo.org/page/iso639-3/deu\u003c/uri\u003e\n \u003c/binding\u003e\n \u003c/result\u003e\n \u003cresult\u003e\n \u003cbinding name\u003d\u0027greeting\u0027\u003e\n \u003cliteral\u003e¡Hola!\u003c/literal\u003e\n \u003c/binding\u003e\n \u003cbinding name\u003d\u0027language\u0027\u003e\n \u003curi\u003ehttp://www.lexvo.org/page/iso639-3/spa\u003c/uri\u003e\n \u003c/binding\u003e\n \u003c/result\u003e\n \u003c/results\u003e\n\u003c/sparql\u003e\n" }, "sparql-results-application-ld-json-example": { "value": "{\n \"@context\": {\n \"ex\": \"http://example.org/vocab#\"\n },\n \"@graph\": [\n {\n \"@id\": \"http://example.org/library\",\n \"@type\": \"ex:Library\"\n }\n ]\n}\n" }, "store-graph-turtle-example": { "value": "@prefix person: \u003chttp://example.org/person/\u003e .\n@prefix relation: \u003chttp://example.org/relation/\u003e .\n@prefix books: \u003chttp://example.org/books/\u003e .\nperson:Mark_Twain relation:author books:Huckleberry_Finn ." }, "rdf-example": { "value": "\u003c?xml version\u003d\"1.0\" encoding\u003d\"utf-8\"?\u003e\n\u003crdf:RDF xmlns:rdf\u003d\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\u003e\n \u003crdf:Description rdf:about\u003d\"http://example.org/person/Mark_Twain\"\u003e\n \u003cns0:author xmlns:ns0\u003d\"http://example.org/relation/\" rdf:resource\u003d\"http://example.org/books/Huckleberry_Finn\"/\u003e\n \u003c/rdf:Description\u003e\n\u003c/rdf:RDF\u003e\n" }, "ld-example": { "value": "{\n \"@context\": {\n \"ns0\": \"http://example.org/relation/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\"\n },\n \"@id\": \"http://example.org/person/Mark_Twain\",\n \"ns0:author\": {\n \"@id\": \"http://example.org/books/Huckleberry_Finn\"\n }\n}" }, "trig-example": { "value": "@prefix rdf: \u003chttp://www.w3.org/1999/02/22-rdf-syntax-ns#\u003e .\n@prefix dc: \u003chttp://purl.org/dc/terms/\u003e .\n@prefix foaf: \u003chttp://xmlns.com/foaf/0.1/\u003e .\n {\n \u003chttp://example.org/bob\u003e dc:publisher \"Bob\" .\n \u003chttp://example.org/alice\u003e dc:publisher \"Alice\" .\n }\n\u003chttp://example.org/bob\u003e\n {\n \u003chttp://example.org/bob\u003e foaf:name \"Bob\" .\n \u003chttp://example.org/bob\u003e foaf:mbox \u003cmailto:bob@oldcorp.example.org\u003e .\n \u003chttp://example.org/bob\u003e foaf:knows \u003chttp://example.org/alice\u003e .\n }\n\u003chttp://example.org/alice\u003e\n {\n \u003chttp://example.org/alice\u003e foaf:name \"Alice\" .\n \u003chttp://example.org/alice\u003e foaf:mbox \u003cmailto:alice@work.example.org\u003e .\n }" }, "sparql-update-example": { "value": "PREFIX foaf: \u003chttp://xmlns.com/foaf/0.1/\u003e\n\nWITH \u003chttp://example/addresses\u003e\nDELETE { ?person foaf:givenName \u0027Bill\u0027 }\nINSERT { ?person foaf:givenName \u0027William\u0027 }\nWHERE { ?person foaf:givenName \u0027Bill\u0027 }" }, "sparql-response-example": { "value": "{\n \"graphs\": [\n {\n \"iri\": \"urn:graph:A\",\n \"writeable\": false\n },\n {\n \"iri\": \"urn:graph:B\",\n \"writeable\": true\n }\n ]\n}" }, "vowl-response-example": { "value": "{\n \"_comment\" : \"Created with OWL2VOWL (version 0.3.4), http://vowl.visualdataweb.org\",\n \"header\" : {\n \"baseIris\" : [ \"http://example.org\", \"http://www.w3.org/2000/01/rdf-schema\" ],\n \"iri\" : \"No IRI set\"\n },\n \"namespace\" : [ ],\n \"metrics\" : {\n \"classCount\" : 1,\n \"objectPropertyCount\" : 0,\n \"datatypePropertyCount\" : 0,\n \"individualCount\" : 1\n },\n \"class\" : [ {\n \"id\" : \"0\",\n \"type\" : \"owl:Class\"\n } ],\n \"classAttribute\" : [ {\n \"iri\" : \"http://example.org/Class\",\n \"baseIri\" : \"http://example.org\",\n \"instances\" : 0,\n \"label\" : {\n \"IRI-based\" : \"Class\"\n },\n \"individuals\" : [ {\n \"iri\" : \"http://example.org/instance\",\n \"baseIri\" : \"http://example.org\",\n \"labels\" : {\n \"IRI-based\" : \"instance\"\n }\n } ],\n \"attributes\" : [ \"external\" ],\n \"id\" : \"0\"\n } ]\n}" }, "application-ld-framed-request-example": { "value": "{\n \"@context\": {\n \"@vocab\": \"https://vocab.eccenca.com/auth/\"\n },\n \"@type\": \"AccessCondition\"\n}" }, "application-ld-json-response-example": { "value": "{\n \"@context\":{\n \"@vocab\":\"https://vocab.eccenca.com/auth/\"\n },\n \"@graph\":[\n {\n \"@id\":\"https://ns.eccenca.com/PublicAccessCondition\",\n \"@type\":\"AccessCondition\",\n \"http://purl.org/dc/terms/created\":{\n \"@type\":\"http://www.w3.org/2001/XMLSchema#date\",\n \"@value\":\"2017-03-14T16:41:15Z\"\n },\n \"http://purl.org/dc/terms/creator\":{\n \"@id\":\"https://ns.eccenca.com/username\"\n },\n \"http://www.w3.org/2000/01/rdf-schema#label\":\"Public access condition\",\n \"readGraph\":{\n \"@id\":\"urn:elds-backend-all-graphs\"\n },\n \"requiresGroup\":{\n \"@id\":\"urn:elds-backend-public-group\"\n }\n }\n ]\n}\n" }, "turtle-auth-condition-example": { "value": "@prefix : \u003chttps://ns.eccenca.com/\u003e .\n@prefix rdfs: \u003chttp://www.w3.org/2000/01/rdf-schema#\u003e .\n@prefix eccauth: \u003chttps://vocab.eccenca.com/auth/\u003e .\n[] a eccauth:AccessCondition ;\n eccauth:requiresGroup \u003curn:elds-backend-public-group\u003e ;\n eccauth:requiresEndpointId \"endpointId\" ;\n eccauth:readGraph :GraphPublic ;\n rdfs:label \"Public access condition on \u0027endpointId\u0027\" ;\n." }, "turtle-auth-condition-resp-example": { "value": "@prefix : \u003chttps://ns.eccenca.com/\u003e .\n@prefix rdfs: \u003chttp://www.w3.org/2000/01/rdf-schema#\u003e .\n@prefix eccauth: \u003chttps://vocab.eccenca.com/auth/\u003e .\n@prefix dct: \u003chttp://purl.org/dc/terms/\u003e .\n@prefix xsd: \u003chttp://www.w3.org/2001/XMLSchema#\u003e .\n:PublicAccessCondition a eccauth:AccessCondition ;\n eccauth:requiresGroup \u003curn:elds-backend-public-group\u003e ;\n eccauth:requiresEndpointId \"endpointId\" ;\n eccauth:readGraph :GraphPublic ;\n rdfs:label \"Public access condition on \u0027endpointId\u0027\" ;\n dct:creator :username ;\n dct:created \"2017-03-14T16:41:15Z\"^^xsd:date ;\n.\n" }, "turtle-auth-condition-put-example": { "value": "@prefix : \u003chttps://ns.eccenca.com/\u003e .\n@prefix eccauth: \u003chttps://vocab.eccenca.com/auth/\u003e .\n:PublicAccessCondition a eccauth:AccessCondition ;\n eccauth:requiresGroup \u003curn:elds-backend-public-group\u003e ;\n eccauth:readGraph :GraphPublic ;\n." }, "turtle-auth-condition-resp-put-example": { "value": "@prefix : \u003chttps://ns.eccenca.com/\u003e .\n@prefix rdfs: \u003chttp://www.w3.org/2000/01/rdf-schema#\u003e .\n@prefix eccauth: \u003chttps://vocab.eccenca.com/auth/\u003e .\n@prefix dct: \u003chttp://purl.org/dc/terms/\u003e .\n@prefix xsd: \u003chttp://www.w3.org/2001/XMLSchema#\u003e .\n:PublicAccessCondition a eccauth:AccessCondition ;\n eccauth:requiresGroup \u003curn:elds-backend-public-group\u003e ;\n eccauth:readGraph :GraphPublic ;\n dct:creator :username ;\n rdfs:label \"Public access condition\" ;\n dct:created \"2017-03-14T16:41:15Z\"^^xsd:date ;\n." }, "facets-result-example": { "value": "[\n {\n \"iri\": \"http://kota.s12.xrea.com/vocab/uranaibloodtype\",\n \"count\": 1,\n \"label\": \"kota.s12.xrea.com_vocab_uranaibloodtype\",\n \"description\": null\n },\n {\n \"iri\": \"http://purl.org/net/inkel/rdf/schemas/lang/1.1#masters\",\n \"count\": 15,\n \"label\": \"lang_1.1_masters\",\n \"description\": null\n }\n]\n" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }