{ "openapi": "3.1.0", "info": { "title": "eccenca DataPlatform API", "description": "eccenca DataPlatform Linked Data API", "contact": { "url": "https://eccenca.com/", "email": "info@eccenca.com" }, "version": "v26.1.0" }, "servers": [ { "url": "http://localhost:9091", "description": "Generated server url" } ], "tags": [ { "name": "SHACL Management API", "description": "Beta - This api is subject to change in the next releases without further notice.\n\nProvides access to functionality in the context of validating resources with SHACL." }, { "name": "SHACL Batch Validation API", "description": "Beta - This api is subject to change in the next releases without further notice. \n\nProvides access to functionality of batch validating resources with SHACL." }, { "name": "Git Synchronisation", "description": "Manages the synchronization with a configured git repository." }, { "name": "Statement-Level Metadata", "description": "Provides methods for listing, exploring and managing statement-level metadata." }, { "name": "Companion", "description": "Chat based interaction with cmem" }, { "name": "Sparql Catalog", "description": "Manages the query Catalog" }, { "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": "Semspect Integration API", "description": "Beta - This api is subject to change in the next releases without further notice. \n\nProvides access to the semspect integration" }, { "name": "Application Health \u0026 Info", "description": "Provides application runtime information." }, { "name": "Facets", "description": "Facets query" }, { "name": "Accessible graphs", "description": "Get a list of graph URIs the requesting user is allowed to read or write." }, { "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 / Resource store", "description": "Provides read and write operations for [Concise Bound Description](https://www.w3.org/Submission/CBD/#definition) of RDF resources.The CBD is calculated without considering reifications.There are two algorithms from which the client can choose. 1. ITERATIVE (default): Selection through the chain of blank nodes in an iterative mode. Deletion uses loaded CBD as base for a DELETE DATA query. In some cases this can be prone to memory issues. 2. QUERY: Selection in a one query-based approach. In some cases faster than iterative. Selection of a resource loads data into memory. Deletion of a resource does not load data into memory. Algorithm does not select blank node chains which are not complete i.e. end in a non-blank node. Example: Resource r connected via property p to blank node b1. Blank node b1 not connected (in target graph). This will not be part of the CBD in the query algorithm." }, { "name": "Data Endpoints", "description": "A collection of provided semantic data endpoints. Each endpoint is equipped with a set of APIs." }, { "name": "Graph Visualizations", "description": "Navigates the Knowledge graph and by searching and listing resources and relations" }, { "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 Resolution", "description": "Resolves certain types of data i.e. titles, descriptions etc. in the data repository" }, { "name": "Graph Uploads", "description": "Operations for asynchronous graph uploads" }, { "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": "Authorization Management API 2", "description": "API for authorization management. Access conditions can be managed using the provided methods. The requesting user must have the \u003chttps://vocab.eccenca.com/auth/Action/ChangeAccessConditions\u003e action granted to be able to use this API. Root users can manage any access condition." }, { "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": "Resource API for SHACL forms", "description": "Beta - This api is subject to change in the next releases without further notice. \n\n Application interface endpoints for interaction with node shape based resources" }, { "name": "Application Health \u0026 Info (Legacy)", "description": "Provides application runtime information." }, { "name": "Authorization Management API", "description": "API for authorization management. Access conditions can be managed using the provided methods. The requesting user must have the \u003chttps://vocab.eccenca.com/auth/Action/ChangeAccessConditions\u003e action granted to be able to use this API. Root users can manage any access condition." }, { "name": "Search", "description": "Search related operations" }, { "name": "Named Queries", "description": "Allows the listing and execution of SELECT / CONSTRUCT queries via their identifiers.Provides information about the required parameters" }, { "name": "Graph Configuration", "description": "Manages the synchronization with a configured git repository." } ], "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": {}, "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": {}, "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": {}, "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": {} } ], "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": [] } ] } }, "/dataplatform/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" }, { "name": "algorithm", "in": "query", "description": "CBD calculation algorithm.\n\nThe algorithm to calculate the CBD (Concise Bounded Description).\n\nThe CBD is mainly used when deleting resources and viewing resources as RDF-serializations. There are two options:\n\n ITERATIVE (default): Selection through the chain of blank nodes in an iterative mode. Deletion uses loaded CBD as base for a DELETE DATA query. In some cases this can be prone to memory issues.\n\n QUERY: Selection in a one query-based approach. In some cases faster than iterative. Selection of a resource loads data into memory. Deletion of a resource does not load data into memory.\n\nAs general note: Algorithm does not select blank node chains which are not complete i.e. end in a non-blank node.\n\nExample: Resource r connected via property p to blank node b1. Blank node b1 not connected (in target graph). This will not be part of the CBD in the query algorithm.\n\nThere exists limits on the maximum size of a loadable CBD. Please consult the cmem DataPlatform documentation for more details.", "required": false, "schema": { "type": "string", "default": "ITERATIVE", "enum": [ "ITERATIVE", "QUERY" ] } }, { "name": "owlImportsResolution", "in": "query", "description": "Whether owl imports shall be resolved. If not given then the setting of Dataplatform is applied", "required": false, "schema": { "type": "boolean" } } ], "responses": { "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" } } }, "204": { "$ref": "#/components/responses/g204" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "403": { "$ref": "#/components/responses/g403" }, "503": { "$ref": "#/components/responses/g503" } }, "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" }, { "name": "algorithm", "in": "query", "required": false, "schema": { "type": "string", "default": "ITERATIVE", "enum": [ "ITERATIVE", "QUERY" ] } }, { "name": "owlImportsResolution", "in": "query", "description": "Whether owl imports shall be resolved. If not given then the setting of Dataplatform is applied", "required": false, "schema": { "type": "boolean" } } ], "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": { "204": { "$ref": "#/components/responses/g204NC" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "403": { "$ref": "#/components/responses/g403" }, "503": { "$ref": "#/components/responses/g503" } }, "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 } }, { "name": "algorithm", "in": "query", "required": false, "schema": { "type": "string", "default": "ITERATIVE", "enum": [ "ITERATIVE", "QUERY" ] } }, { "name": "owlImportsResolution", "in": "query", "description": "Whether owl imports shall be resolved. If not given then the setting of Dataplatform is applied", "required": false, "schema": { "type": "boolean" } } ], "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 }, { "name": "algorithm", "in": "query", "required": false, "schema": { "type": "string", "default": "ITERATIVE", "enum": [ "ITERATIVE", "QUERY" ] } }, { "name": "owlImportsResolution", "in": "query", "description": "Whether owl imports shall be resolved. If not given then the setting of Dataplatform is applied", "required": false, "schema": { "type": "boolean" } } ], "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" }, { "name": "algorithm", "in": "query", "required": false, "schema": { "type": "string", "default": "ITERATIVE", "enum": [ "ITERATIVE", "QUERY" ] } }, { "name": "owlImportsResolution", "in": "query", "description": "Whether owl imports shall be resolved. If not given then the setting of Dataplatform is applied", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "The request was processed successfully." }, "204": { "$ref": "#/components/responses/g204" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "403": { "$ref": "#/components/responses/g403" }, "503": { "$ref": "#/components/responses/g503" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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. It is possible to request a gzip version of the payload with the header accept-encoding set to gzip. No other compression algorithms are supported.", "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": { "200": { "$ref": "#/components/responses/sgs200Get" }, "204": { "$ref": "#/components/responses/sgs204" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "403": { "$ref": "#/components/responses/g403" }, "406": { "$ref": "#/components/responses/g406" }, "503": { "$ref": "#/components/responses/g503" } }, "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": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "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." } }, "required": [ "file" ] } } }, "required": true }, "responses": { "204": { "$ref": "#/components/responses/g204NC" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "403": { "$ref": "#/components/responses/g403" }, "409": { "$ref": "#/components/responses/sgs409" }, "415": { "$ref": "#/components/responses/sgs415" }, "503": { "$ref": "#/components/responses/sgs503" } }, "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 The triples are stored in the given graph. \n It is possible to provide a gzip compressed payload using the header Content-Encoding set to gzip. No other compression algorithms are supported.", "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": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "The uploaded Turtle (`.ttl`), NTriples (`.nt`), RDF/XML (`.rdf` or `.owl`) or JSON-LD (`.jsonld`) file content. Max filesize is set to 1024MB which can be adjusted in the config." } }, "required": [ "file" ] } } }, "required": true }, "responses": { "204": { "$ref": "#/components/responses/g204NC" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "403": { "$ref": "#/components/responses/g403" }, "409": { "$ref": "#/components/responses/sgs409" }, "415": { "$ref": "#/components/responses/sgs415" }, "503": { "$ref": "#/components/responses/sgs503" } }, "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": { "204": { "$ref": "#/components/responses/g204NC" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "403": { "$ref": "#/components/responses/g403" }, "503": { "$ref": "#/components/responses/g503" } }, "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": { "200": { "$ref": "#/components/responses/sgs200Head" }, "204": { "$ref": "#/components/responses/sgs204" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "403": { "$ref": "#/components/responses/g403" }, "503": { "$ref": "#/components/responses/g503" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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." }, "403": { "description": "The user is not allowed to manage the access condition or does not have permission to execute this action." }, "404": { "description": "The access condition does not exist." } }, "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." }, "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." }, "422": { "description": "The access condition was not stored because it is not valid." } }, "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": { "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." }, "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." } }, "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." }, "403": { "description": "The user is not allowed to delete the access condition or does not have permission to execute this action." }, "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." } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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", "default": [], "items": { "type": "string" } } }, { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string", "default": "https://ns.eccenca.com/data/queries/" } }, { "name": "owlImportsResolution", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "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 by deleting the (non-symmetric) CBD of the resource.", "operationId": "deleteQuery", "parameters": [ { "name": "queryIri", "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": [] } ] } }, "/dataplatform/api/navigate/viz": { "get": { "tags": [ "Graph Visualizations" ], "summary": "Retrieves specific visualisation", "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" } }, { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string", "default": "https://ns.eccenca.com/data/queries/" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vizualization" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Graph Visualizations" ], "summary": "Updates an existing visualisation", "description": "Updates an existing visualisation", "operationId": "writeVisualization", "parameters": [ { "name": "vizIri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string", "default": "https://ns.eccenca.com/data/queries/" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vizualization" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Graph Visualizations" ], "summary": "Creates a new visualisation", "description": "Creates a new visualisation", "operationId": "createVisualization", "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/Vizualization" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CreateResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Graph Visualizations" ], "summary": "Delete a specific visualisation", "description": "Delete a specific visualisation", "operationId": "deleteVisualization", "parameters": [ { "name": "vizIri", "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": [] } ] } }, "/dataplatform/api/gitsync/setgraphtorevision": { "put": { "tags": [ "Git Synchronisation" ], "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": [] } ] } }, "/dataplatform/api/gitsync/gitSyncEnabled": { "get": { "tags": [ "Git Synchronisation" ], "operationId": "getGitSyncEnable", "parameters": [ { "name": "graphIri", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Git Synchronisation" ], "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": [] } ] } }, "/dataplatform/api/ext/semspect/snapshot/{id}": { "put": { "tags": [ "Semspect Integration API" ], "summary": "Updates a snapshot of the given id.", "description": "Updating the data in the snapshot of a given id.", "operationId": "updateGraphSnapshot", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The request was processed successfully" }, "403": { "description": "The current user is not authorized for this operation" }, "404": { "description": "No snapshot found for given id" }, "423": { "description": "There is an ongoing sync for the corresponding dataset" }, "500": { "description": "An internal error processing the request occurred" }, "503": { "description": "The external service cannot be reached or a connection error occurred" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Semspect Integration API" ], "summary": "Deletes a snapshot of the given id.", "description": "Deletes the data in the snapshot of the given id and removes the database from Semspect.", "operationId": "deleteGraphSnapshot", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request was processed successfully" }, "403": { "description": "The current user is not authorized for this operation" }, "404": { "description": "No snapshot found for given id" }, "423": { "description": "There is an ongoing sync for the corresponding dataset" }, "500": { "description": "An internal error processing the request occurred" }, "503": { "description": "The external service cannot be reached or a connection error occurred" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/explore/resource": { "put": { "tags": [ "Resource API for SHACL forms" ], "summary": "Updates data of resource", "operationId": "putShaclUpdate", "parameters": [ { "name": "shapeGraph", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "validationMode", "in": "query", "required": false, "schema": { "type": "string", "default": "NARROW", "enum": [ "NONE", "NARROW", "COMPLETE" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceChangeSet" } } }, "required": true }, "responses": { "200": { "description": "The changes to the resource were applied successfully.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SaveReport" } } } }, "400": { "description": "Request parameters invalid i.e. no changes provided" }, "403": { "description": "The data or shape graph is not readable by the user" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": { "204": { "description": "Project default workspace is updated" }, "400": { "description": "The request is formally not valid" }, "403": { "description": "The user is not allowed to store workspace configurations" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": { "200": { "description": "Workspace configuration retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } }, "404": { "description": "Workspace configuration not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } }, "403": { "description": "The user is not allowed to read workspace configurations", "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": { "200": { "description": "Custom workspace is updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } }, "400": { "description": "The request is formally not valid" }, "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": { "204": { "description": "Workspace configuration deleted" }, "404": { "description": "Workspace configuration not found" }, "403": { "description": "The user is not allowed to store workspace configurations" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": "https://ns.eccenca.com/data/queries/" }, "example": "https://ns.eccenca.com/data/queries/" }, { "name": "owlImportsResolution", "in": "query", "description": "Include owl:imported graphs.", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Chart configuration retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } }, "404": { "description": "Chart configuration not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } }, "403": { "description": "The user is not allowed to read chart configurations", "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": "https://ns.eccenca.com/data/queries/" }, "example": "https://ns.eccenca.com/data/queries/" }, { "name": "owlImportsResolution", "in": "query", "description": "Include owl:imported graphs.", "required": false, "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } }, "required": true }, "responses": { "200": { "description": "Chart configuration is updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } }, "400": { "description": "The request is formally not valid", "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": [] } ] }, "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": "https://ns.eccenca.com/data/queries/" }, "example": "https://ns.eccenca.com/data/queries/" }, { "name": "owlImportsResolution", "in": "query", "description": "Include owl:imported graphs.", "required": false, "schema": { "type": "boolean", "default": true } } ], "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": [] } ] } }, "/dataplatform/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": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Access conditions retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PagedModelAccessConditionView" } } } } }, "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": { "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" } } } }, "404": { "description": "The access condition does not exist.", "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": { "201": { "description": "Access condition is created", "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": [] } ] }, "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": { "200": { "description": "Removal of the access condition was successful. The body contains the deleted access condition.", "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" } } } }, "404": { "description": "The access condition does not exist.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": { "202": { "description": "The update query was processed successfully, however not fully. This typically means that further tasks still have to be post-processed." }, "204": { "$ref": "#/components/responses/g204NC" }, "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)." }, "409": { "description": "Transaction aborted due to deadlock. Retrying should solve the problem." }, "503": { "$ref": "#/components/responses/g503" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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 (deprecated, please use \u0027default\u0027)", "required": true, "deprecated": true, "schema": { "type": "string" }, "example": "default" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SparqlQueryFramedSchema" } } }, "required": true }, "responses": { "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" } } } }, "400": { "$ref": "#/components/responses/g400" }, "409": { "$ref": "#/components/responses/g409" }, "503": { "$ref": "#/components/responses/g503" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": { "200": { "description": "The request was processed successfully.", "content": { "application/ld+json": { "schema": { "type": "string" } } } }, "204": { "$ref": "#/components/responses/g204" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "403": { "$ref": "#/components/responses/g403" }, "503": { "$ref": "#/components/responses/g503" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/graphs/api/graphs/writeCheck": { "post": { "tags": [ "Accessible graphs" ], "summary": "Writable graphs", "description": "Check, whether 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": [] } ] } }, "/dataplatform/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": { "200": { "description": "Successful retrieval of the requested access condition(s).", "content": { "application/ld+json": { "schema": { "type": "string" } } } }, "204": { "description": "The access conditions model is empty." }, "400": { "description": "The given JSON-LD frame is malformed." }, "403": { "description": "The user is not allowed to manage the access condition or does not have permission to execute this action." }, "404": { "description": "The access condition does not exist." } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/vocabusage/propertyUsageSampling": { "post": { "tags": [ "Vocabulary usage" ], "summary": "Shows estimation of how given properties are explicitly used in given graph (via sampling)", "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": [] } ] } }, "/dataplatform/api/vocabusage/propertyUsageAnalytics": { "post": { "tags": [ "Vocabulary usage" ], "summary": "Shows how given properties are explicitly used in given graph", "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": [] } ] } }, "/dataplatform/api/upload/transfer": { "post": { "tags": [ "Graph Uploads" ], "summary": "Uploads analysed file", "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": { "200": { "description": "Upload is queued and transfer id given", "content": { "*/*": { "schema": { "type": "string" } } } }, "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" } } } }, "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": [] } ] } }, "/dataplatform/api/upload/": { "post": { "tags": [ "Graph Uploads" ], "summary": "Stores file for later analysis", "description": "Stores a file (single graph file or archive) temporarily for later analysis. Returns id for upload", "operationId": "storeFile", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Archive in format Zip (`.zip`) containing / or single file in format Turtle (`.ttl`), NTriples (`.nt`), RDF/XML (`.rdf` or `.owl`), JSON-LD (`.jsonld`) file content. Max filesize is set to 1024MB which can be adjusted in the config." } }, "required": [ "file" ] } } } }, "responses": { "200": { "description": "File successfully stored and uploadId returned", "content": { "*/*": { "schema": { "type": "string" } } } }, "415": { "description": "Unsupported media type - file format not valid or file empty", "content": { "*/*": { "schema": { "type": "string" } } } }, "500": { "description": "File could not be stored due to technical reasons - please contact administrator", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": "includeVersioning", "in": "query", "description": "If true, include versioning statements in the results.", "required": false, "schema": { "type": "boolean", "default": false } }, { "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", "description": "An RDF Statement with subject, predicate and object, with an optional graph." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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" } }, { "name": "includeVersioning", "in": "query", "description": "If true, include versioning statements in the results.", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The statement to be searched for", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement", "description": "An RDF Statement with subject, predicate and object, with an optional graph." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatementLevelMetadata" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/api/shacl/validation": { "post": { "tags": [ "SHACL Management API" ], "summary": "Validates a given resource against all applicable node shapes or given node shapes", "description": "Validates a resource either in-memory or on the store. If a changeset is given, the validation applies this to the data first (in-memory). If the parameter validationMode is set to\n COMPLETE and no changes to the resource need to be applied the validation runs on the store backend. Otherwise a limited validation runs in-memory.\n If nodes shapes are given only those nodes shapes are evaluated. If no node shapes are given all targetClass node shapes are resolves. \nWarning: If the request specifies node shapes which do not match the resource then the validation will be executed regardless with invalid results! \nWarning: if the request specifies a resource which does not exist then the response might still contain results depending on the shapes! \nWarning: If the request has a changeset or specifies quick validation then the validation cannot execute completely for all constrainst!", "operationId": "validateResource", "parameters": [ { "name": "resource", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "shapeGraph", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "nodeShapes", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } }, { "name": "validationMode", "in": "query", "required": false, "schema": { "type": "string", "default": "COMPLETE", "enum": [ "NONE", "NARROW", "COMPLETE" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceChangeSet" } } }, "required": true }, "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceValidationReportView" } } } }, "400": { "description": "Request parameters invalid i.e. node shape does not exist in shape graph", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceValidationReportView" } } } }, "403": { "description": "The data or shape graph is not readable" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/shacl/validation/batches": { "get": { "tags": [ "SHACL Batch Validation API" ], "summary": "Gets a detailed status of all submitted batch runs", "description": "Status of validation runs ", "operationId": "getBatchesStatusList", "responses": { "200": { "description": "Status returned", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceBatchValidationRunStatus" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "SHACL Batch Validation API" ], "summary": "Creates and starts a validation batch run for a selection of resources which are validated against all applicable node shapes", "description": "Validates resources selected by given SPARQL query containing a projection variable \"resource\". The resources are queried in the given context graph. \nAn optional shape graph determines the source of the shapes for the resources. If not given the default shape graph is used. \nThe response consists of a batch id which can be used for querying the results of the batch run. ", "operationId": "validateResourceBatch", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "shapeGraph", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "selectionQuery", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "validationResultsTargetGraph", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "replace", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "owlImportsIgnoreList", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "201": { "description": "The batch has been successfully created and can be found in the location header.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceBatchValidationRunStatus" } } } }, "400": { "description": "Request parameters invalid" }, "403": { "description": "The data or shape graph is not readable" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/shacl/nodeShapes/resource": { "get": { "tags": [ "SHACL Management API" ], "summary": "Resolves applicable node shapes of given resources", "description": "Resolves applicable node shapes of given resources.The response contains a map from resource iri to an array of node shapes. Resources which do not exist or do not match a node shape (in the given context) are not contained in the response. ", "operationId": "resolveShapesForIris", "parameters": [ { "name": "resources", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "shapeGraph", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request was processed successfully.", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } } } } }, "400": { "description": "Request parameters invalid" }, "403": { "description": "The data or shape graph is not readable" } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "SHACL Management API" ], "summary": "Resolves applicable node shapes of given resources", "description": "Resolves applicable node shapes of given resources.The response contains a map from resource iri to an array of node shapes. Resources which do not exist or do not match a node shape (in the given context) are not contained in the response. ", "operationId": "resolveShapesForIrisPost", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkResolveNodeShapeRequest" } } }, "required": true }, "responses": { "200": { "description": "The request was processed successfully.", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } } } } }, "400": { "description": "Request parameters invalid" }, "403": { "description": "The data or shape graph is not readable" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/search": { "post": { "tags": [ "Search" ], "summary": "Lists found resources on specified pattern(s)", "description": "Lists found resources on specified pattern(s)", "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": [] } ] } }, "/dataplatform/api/search/indexed": { "post": { "tags": [ "Search" ], "summary": "Checks if a path has full text search", "description": "Checks if a 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": [] } ] } }, "/dataplatform/api/search/generateResourceListQuery": { "post": { "tags": [ "Search" ], "summary": "Generates a resource list parse result for the given query", "description": "Generates a resource list parse result for the given query", "operationId": "generateResourceListQuery", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceListParseResult" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/search/generateQuery": { "post": { "tags": [ "Search" ], "summary": "Generates a query for given graph patterns", "description": "Generates a query for given graph patterns", "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": [] } ] } }, "/dataplatform/api/search/generateQueryBody": { "post": { "tags": [ "Search" ], "summary": "Generates a query body for given graph patterns", "description": "Generates a query body for given graph patterns", "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": [] } ] } }, "/dataplatform/api/search/generateGraphResourcePattern": { "post": { "tags": [ "Search" ], "summary": "Generates a graph pattern for the given query body", "description": "Generates a graph pattern for the given query body", "operationId": "generateGraphResourcePattern", "parameters": [ { "name": "queryBody", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GraphPatternParseResult" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/search/count": { "post": { "tags": [ "Search" ], "summary": "Counts found resources on specified pattern(s)", "description": "Counts found resources on specified pattern(s)", "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": [] } ] } }, "/dataplatform/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" } } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/api/querycatalog/logicalPlan": { "post": { "tags": [ "Sparql Catalog" ], "description": "If the backend RDF store supports it, a textual execution plan is provided for the provided query. Otherwise the endpoint returns 503. Note: The execution plan is based on the exact query provided and does not include rewriting done by Explore!", "operationId": "logicalExecutionPlan", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Execution plan for query", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LogicalPlanResponse" } } } }, "503": { "description": "Store backend does not provide functionality for execution plan", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LogicalPlanResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/queries/reports/perform": { "get": { "tags": [ "Named Queries" ], "summary": "Executes the given SELECT query and returns a CSV result", "description": "Executes the given SELECT 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" ], "summary": "Executes the given SELECT query and returns a CSV result", "description": "Executes the given SELECT query and returns a CSV result", "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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/api/queries/jsonld/perform": { "get": { "tags": [ "Named Queries" ], "summary": "Executes the given CONSTRUCT query and returns a result in JSON-LD", "description": "Executes the given CONSTRUCT query and returns a result in JSON-LD", "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": "string" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Named Queries" ], "summary": "Executes the given CONSTRUCT query and returns a JSON-LD result", "description": "Executes the given CONSTRUCT query and returns a JSON-LD 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": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/ext/semspect/snapshot": { "post": { "tags": [ "Semspect Integration API" ], "summary": "Creates a snapshot of the given graph for the provided user\u0027s rights and saves it as a database in Semspect. Returns the id of the snapshot.", "description": "Snapshot of a given graph to a Semspect database. If the database exists already it is hot-swapped by Semspect.The snapshot contains only the graphs the requesting user can read.", "operationId": "createGraphSnapshot", "parameters": [ { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The request was processed successfully", "content": { "*/*": { "schema": { "type": "string" } } } }, "403": { "description": "The current user is not authorized for this operation" }, "423": { "description": "There is an ongoing sync for the corresponding dataset" }, "500": { "description": "An internal error processing the request occurred" }, "503": { "description": "The external service cannot be reached or a connection error occurred" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Semspect Integration API" ], "summary": "Deletes all graph snapshots in Semspect. This resets the state completely. Only available with Graph Insights management action.", "operationId": "deleteGraphSnapshots", "responses": { "200": { "description": "The request was processed successfully" }, "403": { "description": "The current user is not authorized for this operation" }, "423": { "description": "There is an ongoing sync for a dataset" }, "500": { "description": "An internal error processing the request occurred" }, "503": { "description": "The external service cannot be reached or a connection error occurred" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/explore/titles": { "post": { "tags": [ "Data Resolution" ], "summary": "Gets short-form titles (i.e. rdfs:label) for multiple resources", "description": "@Beta, this api is subject to change without further notice \n. Finds short-form titles (i.e. rdfs:label) for 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": [] } ] } }, "/dataplatform/api/explore/resource/relations": { "post": { "tags": [ "Resource API for SHACL forms" ], "summary": "Resource relations based on SHACL shapes", "description": "Returns relations between given resources based on their SHACL shape definitions. These relations include direct/inverse relations based on property shape paths as well as relations which are the result of SHUI value queries. The type of relation is marked in the response", "operationId": "shaclResourceRelations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShaclResourceRelationRequest" } } }, "required": true }, "responses": { "200": { "description": "The changes to the resource were applied successfully.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ShaclResourceRelationsDto" } } } }, "400": { "description": "Request parameters invalid i.e. no changes provided" }, "403": { "description": "The data or shape graph is not readable by the user" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/explore/resource/propertyShapeDataSelectQuery": { "post": { "tags": [ "Resource API for SHACL forms" ], "summary": "Returns the query to select property shape data for given property shape IRIs. Returns existing data on the property shape\u0027s path (or the result of shui:valueQuery) and possible other values for the path to add (or the result of shui:uiQuery)If the property shape has a shui:valueQuery / shui:uiQuery then that query will be parsed / filled with values and returned.The return model contains an indication which variable in the result contains the resource node. This will be a variable called ?resource or the first variable of the query if ?resource is not present.", "operationId": "shaclPropertyShapeDataSelectQueryPost", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyShapeDataSelectQueryRequest" } } }, "required": true }, "responses": { "200": { "description": "The request was processed successfully.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListResponseShaclDataQuerySet" } } } }, "403": { "description": "The data or shape graph is not readable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListResponseShaclDataQuerySet" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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" } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Facets" ], "summary": "List the properties of a class or query", "operationId": "getFacets", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFacetsRequest" } } }, "required": true }, "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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/api/explore/descriptions": { "post": { "tags": [ "Data Resolution" ], "summary": "Gets descriptions (i.e. rdfs:comment) for multiple resources", "description": "@Beta, this api is subject to change without further notice \n. Finds the descriptions (i.e. rdfs:comment) for multiple IRIs.", "operationId": "getDescriptions", "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 descriptions for", "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": [] } ] } }, "/dataplatform/api/explore/depictions": { "post": { "tags": [ "Data Resolution" ], "summary": "Gets the depictions of multiple resources", "description": "Reads foaf: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": [] } ] } }, "/dataplatform/api/custom/{slug}": { "get": { "tags": [ "Named Queries" ], "summary": "Executes the query and returns a JSON result by evaluating a Jinja Template", "description": "Executes the query and returns a JSON result by evaluating a Jinja 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": "string" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Named Queries" ], "summary": "Executes the query and returns a JSON result by evaluating a Jinja Template", "description": "Executes the query and returns a JSON result by evaluating a Jinja Template", "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": [] } ] } }, "/dataplatform/api/conf/workspaces/migrateConfiguration": { "post": { "tags": [ "Workspace Config Controller" ], "summary": "Migrates persisted configuration to current CMEM version. Returns list of migrated IRIs or empty if migration not necessary.", "operationId": "migrateWorkspaceConfigurations", "responses": { "200": { "description": "Configurations migrated", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "403": { "description": "The user is not allowed to store workspace configurations", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "500": { "description": "An error occurred during migration of workspace configurations", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": { "201": { "description": "Custom workspace is created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceConfiguration" } } } }, "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" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": "https://ns.eccenca.com/data/queries/" }, "example": "https://ns.eccenca.com/data/queries/" }, { "name": "owlImportsResolution", "in": "query", "description": "Include owl:imported graphs.", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Chart configuration retrieved", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChartConfiguration" } } } } }, "403": { "description": "The user is not allowed to read chart configurations", "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": "https://ns.eccenca.com/data/queries/" }, "example": "https://ns.eccenca.com/data/queries/" }, { "name": "owlImportsResolution", "in": "query", "description": "Include owl:imported graphs.", "required": false, "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } }, "required": true }, "responses": { "201": { "description": "Chart configuration is created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartConfiguration" } } } }, "400": { "description": "The request is formally not valid", "content": { "*/*": { "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": [] } ] } }, "/dataplatform/api/companion/transcribe": { "post": { "tags": [ "Companion" ], "description": "Transcribe audio to text using OpenAI Whisper", "operationId": "companionTranscribe", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "audio": { "type": "string", "format": "binary" } }, "required": [ "audio" ] } } } }, "responses": { "200": { "description": "Transcription of voice recording", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/VoiceTranscriptionResponse" } } } }, "503": { "description": "Companion is not activated", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/VoiceTranscriptionResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/companion/chat/stop": { "post": { "tags": [ "Companion" ], "description": "Stops a ongoing chat, which usually consists out of multiple server\u003c-\u003eLLM interactions.\nNo more requests are send to the LLM provider.\nDoes not interrupt an already submitted requests.\n", "operationId": "companionChatStop", "parameters": [ { "name": "conversationId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/companion/chat/multipart": { "post": { "tags": [ "Companion" ], "description": "Chat with the eccenca companion with file attachments support.\nYou can restrict the tool usage by providing a positive list of tool names, which can be used.\nTo prevent any tool usage, simply provide a single, non-existing tool name \"invalid\"\n", "operationId": "companionChatMultipart", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "userMessageString": { "type": "string" }, "jsonContext": { "type": "string" }, "conversationId": { "type": "string" }, "attachments": { "type": "array", "items": { "type": "string", "format": "binary" } }, "tools": { "type": "array", "items": { "type": "string" } } }, "required": [ "conversationId", "userMessageString" ] } } } }, "responses": { "200": { "description": "Chat Model response to query", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CompanionResponse" } } } }, "503": { "description": "Companion is not activated", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CompanionResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/companion/chat/multipart/async": { "post": { "tags": [ "Companion" ], "description": "Chat with the eccenca companion with file attachments support.\nYou can restrict the tool usage by providing a positive list of tool names, which can be used.\nTo prevent any tool usage, simply provide a single, non-existing tool name \"invalid\"\n", "operationId": "companionChatMultipartAsync", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "userMessageString": { "type": "string" }, "jsonContext": { "type": "string" }, "conversationId": { "type": "string" }, "attachments": { "type": "array", "items": { "type": "string", "format": "binary" } }, "tools": { "type": "array", "items": { "type": "string" } } }, "required": [ "conversationId", "userMessageString" ] } } } }, "responses": { "200": { "description": "Chat Model response to query" }, "503": { "description": "Companion is not activated" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/authorization/review": { "get": { "tags": [ "Authorization Management API 2" ], "summary": "Review the graph rights of a given account IRI and a given set of group IRIs.", "description": "Shows the rights a (potential) user has with given groups", "operationId": "review", "parameters": [ { "name": "accountIri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "groupIris", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } } ], "responses": { "200": { "description": "List of rights retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionReviewView" } } } }, "403": { "description": "The user is not allowed to manage access conditions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionReviewView" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Authorization Management API 2" ], "summary": "Review the graph rights of a given account IRI and a given set of group IRIs.", "description": "Shows the rights a (potential) user has with given groups", "operationId": "accessConditionReview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessConditionReviewRequest" } } }, "required": true }, "responses": { "200": { "description": "List of rights retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionReviewView" } } } }, "403": { "description": "The user is not allowed to manage access conditions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionReviewView" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "ZIP-file which needs to be restored" } }, "required": [ "file" ] } } } }, "responses": { "403": { "description": "The current user is not authorized to use this endpoint " }, "400": { "description": "The restore-file is broken or not suitable for the task." }, "503": { "description": "Another administrative operation is ongoing at the moment. Please check with /admin/status" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/admin/flushCache": { "post": { "tags": [ "Admin QueryMonitor" ], "description": "Flushes all existing caches", "operationId": "flushCaches", "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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 (deprecated, please use \u0027default\u0027)", "required": true, "deprecated": true, "schema": { "type": "string" }, "example": "default" }, { "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": "SELECT * WHERE { ?s ?p ?v } LIMIT 10" }, { "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" }, "409": { "$ref": "#/components/responses/g409" }, "503": { "$ref": "#/components/responses/g503" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/proxy/{id}/resource/quads": { "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 as quad format.", "description": "Returns the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the requested resource in the given graph as quad format.", "operationId": "resourceStoreGetAsQuads", "parameters": [ { "name": "resource", "in": "query", "description": "A valid resource URI", "required": true, "schema": { "type": "string" }, "example": "http://example.org/person/Mark_Twain" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "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 loaded, otherwise the right-bounded CBD (resource in subject)", "required": false, "schema": { "type": "boolean", "default": true }, "example": true }, { "name": "algorithm", "in": "query", "description": "CBD calculation algorithm.\n\nThe algorithm to calculate the CBD (Concise Bounded Description).\n\nThe CBD is mainly used when deleting resources and viewing resources as RDF-serializations. There are two options:\n\n ITERATIVE (default): Selection through the chain of blank nodes in an iterative mode. Deletion uses loaded CBD as base for a DELETE DATA query. In some cases this can be prone to memory issues.\n\n QUERY: Selection in a one query-based approach. In some cases faster than iterative. Selection of a resource loads data into memory. Deletion of a resource does not load data into memory.\n\nAs general note: Algorithm does not select blank node chains which are not complete i.e. end in a non-blank node.\n\nExample: Resource r connected via property p to blank node b1. Blank node b1 not connected (in target graph). This will not be part of the CBD in the query algorithm.\n\nThere exists limits on the maximum size of a loadable CBD. Please consult the cmem DataPlatform documentation for more details.", "required": false, "schema": { "type": "string", "default": "ITERATIVE", "enum": [ "ITERATIVE", "QUERY" ] } }, { "name": "owlImportsResolution", "in": "query", "description": "Whether owl imports shall be resolved. If not given then the setting of Dataplatform is applied", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/trig": { "schema": { "type": "string" }, "example": "N/A" }, "application/n-quads": { "schema": { "type": "string" }, "example": "N/A" } } }, "204": { "$ref": "#/components/responses/g204" }, "404": { "$ref": "#/components/responses/g404" }, "400": { "$ref": "#/components/responses/g400" }, "403": { "$ref": "#/components/responses/g403" }, "503": { "$ref": "#/components/responses/g503" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": { "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 } } ] } } }, "403": { "$ref": "#/components/responses/g403" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": { "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 " } } }, "403": { "$ref": "#/components/responses/g403" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": { "204": { "description": "The access conditions were successfully reloaded." }, "403": { "description": "The user does not have permission to execute this action." }, "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": [] } ] } }, "/dataplatform/api/vocabusage/vocabUptake": { "get": { "tags": [ "Vocabulary usage" ], "summary": "Shows existences in graphs of classes and properties in a given context graph", "operationId": "getVocabUptakeFor", "parameters": [ { "name": "graphIri", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/VocabUptake" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/vocabusage/usage": { "get": { "tags": [ "Vocabulary usage" ], "summary": "Shows (inter)connection of classes", "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": [] } ] } }, "/dataplatform/api/vocabusage/shape": { "get": { "tags": [ "Vocabulary usage" ], "summary": "Shows connection of classes via property shapes", "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": [] } ] } }, "/dataplatform/api/vocabusage/propertyusage": { "get": { "tags": [ "Vocabulary usage" ], "summary": "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": [] } ] } }, "/dataplatform/api/vocabusage/properties": { "get": { "tags": [ "Vocabulary usage" ], "summary": "Lists all properties in knowledge graph by installed vocabularies", "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": [] } ] } }, "/dataplatform/api/vocabusage/classusage": { "get": { "tags": [ "Vocabulary usage" ], "summary": "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": [] } ] } }, "/dataplatform/api/vocabusage/classes": { "get": { "tags": [ "Vocabulary usage" ], "summary": "Lists all classes in this graph by installed vocabularies", "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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/api/upload/{storageId}": { "get": { "tags": [ "Graph Uploads" ], "summary": "Retrieves analysis of uploaded file", "description": "Analyzes temporarily stored file. Returns results as json", "operationId": "analyzeStoredFile", "parameters": [ { "name": "storageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "File successfully analyzed and results returned. Possible errors in files are part of the response.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UploadAnalytics" } } } }, "400": { "description": "File cannot be analyzed because it is (probably) corrupt", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UploadAnalytics" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/upload/transferStatus/{transferId}": { "get": { "tags": [ "Graph Uploads" ], "summary": "Retrieves transfer status for on-going upload", "description": "Returns transfer status for provided transfer id", "operationId": "transferStatus", "parameters": [ { "name": "transferId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Provided transfer id exists and status info can be given", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UploadStatusInfo" } } } }, "404": { "description": "Requested transfer id not found ", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UploadStatusInfo" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": "includeVersioning", "in": "query", "description": "If true, include versioning statements in the results.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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" } } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/shapes/listWithValidation": { "get": { "tags": [ "Shapes" ], "description": "Lists NodeShapes, either by the given iris, or all if empty as ListResponse with validation errors.", "operationId": "loadNodeShapeWithValidation", "parameters": [ { "name": "nodeShapes", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Shapes returned without technical error reading data", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListResponseNodeShape" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/shapes/cacheInvalidate": { "get": { "tags": [ "Shapes" ], "description": "Invalidates the shapes cache", "operationId": "invalidateCache", "responses": { "200": { "description": "OK" } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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" } } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/shacl/validation/batches/{batchId}": { "get": { "tags": [ "SHACL Batch Validation API" ], "summary": "Gets a detailed status of a submitted batch run request", "description": "Status of validation run ", "operationId": "statusOfResourceBatchValidation", "parameters": [ { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Status returned", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceBatchValidationRunStatus" } } } }, "404": { "description": "Batch run with id not found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "SHACL Batch Validation API" ], "summary": "Cancels a submitted batch run request", "description": "Cancellation of submitted batch run request", "operationId": "cancelResourceBatchValidation", "parameters": [ { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cancellation success" }, "400": { "description": "Cancellation requested on non-running batch" }, "404": { "description": "Batch run with id not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/shacl/validation/batches/{batchId}/view/rdf": { "get": { "tags": [ "SHACL Batch Validation API" ], "summary": "Gets a detailed status of a submitted batch run request as RDF validation report", "description": "Status of validation run ", "operationId": "rdfStatusOfResourceBatchValidation", "parameters": [ { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Status returned", "content": { "text/turtle": { "schema": { "type": "string" } } } }, "404": { "description": "Batch run with id not found", "content": { "text/turtle": { "schema": { "type": "string" } } } }, "409": { "description": "Batch run with id not finished yet and cannot be provided as RDF", "content": { "text/turtle": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/shacl/validation/batches/{batchId}/view/aggregation": { "get": { "tags": [ "SHACL Batch Validation API" ], "summary": "Gets an aggregated status view of a submitted batch run request", "description": "Aggregated status of validation run which does not contain single results ", "operationId": "aggregatedStatusOfResourceBatchValidation", "parameters": [ { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Status returned", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceBatchAggregatedValidationRunStatus" } } } }, "404": { "description": "Batch run with id not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/shacl/validation/batches/view/aggregation": { "get": { "tags": [ "SHACL Batch Validation API" ], "summary": "Gets an aggregated status of a all submitted batch runs", "description": "Aggregated Status of validation runs ", "operationId": "getBatchesStatusListAggregated", "responses": { "200": { "description": "Status returned" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/search/parse": { "get": { "tags": [ "Search" ], "summary": "Parses the given term and normalizes it. Injects the default field.", "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": [] } ] } }, "/dataplatform/api/resources/usage": { "get": { "tags": [ "Resources" ], "operationId": "getResoureUsage", "parameters": [ { "name": "iri", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceUsage" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/queries/reports": { "get": { "tags": [ "Named Queries" ], "summary": "Lists all executable queries and shows their potential parameters", "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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/api/navigate/viz/list": { "get": { "tags": [ "Graph Visualizations" ], "summary": "Lists all stored Visualizations", "description": "Lists all stored Visualizations", "operationId": "listVisualizations", "parameters": [ { "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/ListResponseVizListEntryDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/manage/graph": { "get": { "tags": [ "Graph Configuration" ], "operationId": "list", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GraphConfiguration" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/gitsync": { "get": { "tags": [ "Git Synchronisation" ], "operationId": "isActive", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/gitsync/diff": { "get": { "tags": [ "Git Synchronisation" ], "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": [] } ] } }, "/dataplatform/api/gitsync/changes": { "get": { "tags": [ "Git Synchronisation" ], "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": [] } ] } }, "/dataplatform/api/ext/semspect": { "get": { "tags": [ "Semspect Integration API" ], "summary": "Gets a status of the Semspect integration configuration.", "operationId": "getSemspectIntegrationStatus", "responses": { "200": { "description": "Status returned", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SemspectIntegrationStatus" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/ext/semspect/snapshot/{id}/can-read": { "get": { "tags": [ "Semspect Integration API" ], "summary": "Returns true if the user can read the given Semspect snapshot.", "operationId": "userCanReadSemspectSnapshot", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request was processed successfully", "content": { "*/*": { "schema": { "type": "boolean" } } } }, "404": { "description": "No snapshot found for given id", "content": { "*/*": { "schema": { "type": "boolean" } } } }, "500": { "description": "An internal error processing the request occurred", "content": { "*/*": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/ext/semspect/snapshot/ui/{id}": { "get": { "tags": [ "Semspect Integration API" ], "summary": "Gets the link to the Semspect UI opening the given database", "operationId": "getSemspectUiLink", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Link to UI returned", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/ext/semspect/snapshot/ui/{id}/resource": { "get": { "tags": [ "Semspect Integration API" ], "summary": "Gets the link to the Semspect UI opening the given database filtering on the given RDF resource. If no class is given then the resource is shown in the class context of RDFS.Resource. Otherwise the view is filtered to that class.", "operationId": "getSemspectUiResourceIriLink", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceIri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "classIri", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Link to UI returned", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/ext/semspect/snapshot/ui/{id}/class": { "get": { "tags": [ "Semspect Integration API" ], "summary": "Gets the link to the Semspect UI opening the given database filtering on the given RDF class", "operationId": "getSemspectUiClassIriLink", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "classIri", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Link to UI returned", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/ext/semspect/snapshot/status": { "get": { "tags": [ "Semspect Integration API" ], "summary": "Returns list of current and past loading activities of snapshots for the current user. Optionally this is filtered to a given graph and / or for including snapshots which are not viewable for the manager user as the data does not match the reading rights of the user. These snapshots can only be managed by the user i.e. deleted.", "description": "Returns status list for snapshot loads for the current user", "operationId": "getGraphSnapshotStatus", "parameters": [ { "name": "contextGraph", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeManagementOnly", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "The request was processed successfully", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SemspectSnapshotStatus" } } } } }, "403": { "description": "The current user is not authorized for this operation" }, "404": { "description": "No snapshot found for given id" }, "500": { "description": "An internal error processing the request occurred" }, "503": { "description": "The external service cannot be reached or a connection error occurred" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/ext/semspect/snapshot/status/{id}": { "get": { "tags": [ "Semspect Integration API" ], "summary": "Returns graph snapshot state for the given snapshot id. \nThe status values are as follows: created (database created, not loaded), started(loading init), ongoing (load in progress), done (success), failed(error). In case of an error the error field contains details.", "operationId": "getGraphSnapshotStatusForId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request was processed successfully", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SemspectSnapshotStatus" } } } }, "403": { "description": "The current user is not authorized for this operation" }, "404": { "description": "No snapshot found for given id" }, "500": { "description": "An internal error processing the request occurred" }, "503": { "description": "The external service cannot be reached or a connection error occurred" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/ext/semspect/snapshot/can-manage": { "get": { "tags": [ "Semspect Integration API" ], "summary": "Returns true if the user can manage Semspect databases.", "operationId": "userCanManageSemspectSnaphots", "responses": { "200": { "description": "The request was processed successfully", "content": { "*/*": { "schema": { "type": "boolean" } } } }, "500": { "description": "An internal error processing the request occurred", "content": { "*/*": { "schema": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/explore/title": { "get": { "tags": [ "Data Resolution" ], "summary": "Gets short-form title (i.e. rdfs:label) for a single resource", "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": [] } ] } }, "/dataplatform/api/explore/resource/nodeshapeforms/iri": { "get": { "tags": [ "Resource API for SHACL forms" ], "summary": "Returns given node shape form. Returns a form version with SHUI properties of the supplied node shape IRI.", "operationId": "nodeShapeForms", "parameters": [ { "name": "nodeShape", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "shapeGraph", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request was processed successfully.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NodeShapeFormDto" } } } }, "400": { "description": "Request parameters invalid" }, "403": { "description": "The data or shape graph is not readable" }, "404": { "description": "The requested node shape was not found in the shape graph" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/explore/resource/nodeshapeforms/bytargetclass": { "get": { "tags": [ "Resource API for SHACL forms" ], "summary": "Returns node shape forms which target the provided target class.. Returns a form version with SHUI properties of node shapes applying to the class or super classes.", "operationId": "targetClassNodeShapeForms", "parameters": [ { "name": "targetClass", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "shapeGraph", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request was processed successfully.", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NodeShapeFormDto" } } } } }, "400": { "description": "Request parameters invalid" }, "403": { "description": "The data or shape graph is not readable" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/explore/resource/nodeshapeforms/byresource": { "get": { "tags": [ "Resource API for SHACL forms" ], "summary": "Returns node shape forms with SHUI properties in given shape graph which target the class (or super classes) of the given resource. The node shapes are returned in their sh:order (missing order shapes last)", "operationId": "applicableTargetClassNodeShapeForms", "parameters": [ { "name": "resource", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "shapeGraph", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request was processed successfully.", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NodeShapeFormDto" } } } } }, "400": { "description": "Request parameters invalid" }, "403": { "description": "The data or shape graph is not readable" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/explore/langs": { "get": { "tags": [ "Data Resolution" ], "summary": "Gets the configured preferred language", "description": "The configured languages preferences", "operationId": "getLangs", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/explore/description": { "get": { "tags": [ "Data Resolution" ], "summary": "Gets a description (i.e. rdfs:comment) for a single resource", "description": "This api is subject to change without further notice \n. Gets a description (i.e. rdfs:comment) for a single IRI.", "operationId": "getDescription", "parameters": [ { "name": "resource", "in": "query", "description": "The iri to resolve the description for", "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": [] } ] } }, "/dataplatform/api/explore/datagraph": { "get": { "tags": [ "Data Resolution" ], "summary": "Gets the actual data graph of the resource after resolving imports", "description": "This api is subject to change without further notice \n. Gets the actual data graph of the given resource (in case it is imported by the contextGraph).The graph is defined as having a triple with the resource in subject and a determining predicate which is set via parameter and defaults to rdf:type. When multiple triples are found the first one is taken (non-deterministic).", "operationId": "getDataGraph", "parameters": [ { "name": "resource", "in": "query", "description": "The resource to resolve the graph for", "required": true, "schema": { "type": "string" } }, { "name": "contextGraph", "in": "query", "description": "The integration graph, in which the lookup should take place", "required": true, "schema": { "type": "string" } }, { "name": "determiningProperty", "in": "query", "description": "The determining property for the lookup", "required": false, "schema": { "type": "string", "default": "http://www.w3.org/1999/02/22-rdf-syntax-ns#type" } } ], "responses": { "200": { "description": "The request was processed successfully and the data graph is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataGraphResolution" } } } }, "400": { "description": "Request parameters invalid" }, "403": { "description": "The context graph cannot be read by the user" }, "404": { "description": "The resource (triple with property) is not found in the context graph" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/conf/workspaces": { "get": { "tags": [ "Workspace Config Controller" ], "summary": "Returns full set of WorkspaceConfigurations (systemDefault, projectDefault, custom workspaces. If there is a configuration error then the system default only is returned", "operationId": "getConfigSet", "responses": { "200": { "description": "Workspace configuration retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/WorkspaceConfigurationSetResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/api/companion/tools": { "get": { "tags": [ "Companion" ], "description": "Active Tools", "operationId": "companionToolsList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ToolDefinitionResponse" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/companion/config": { "get": { "tags": [ "Companion" ], "description": "Gets the frontend configuration for the companion.", "operationId": "getConfiguration", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CompanionSettings" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/companion/chat": { "get": { "tags": [ "Companion" ], "description": "List all conversations for the current user.", "operationId": "companionChatList", "responses": { "200": { "description": "List of conversations", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Conversation" } } } } }, "503": { "description": "Companion is not activated", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Conversation" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Companion" ], "description": "Deletes all conversations of the user from the chat memory.", "operationId": "companionChatDeleteAll", "responses": { "200": { "description": "Deletion successful. Returns number of deleted conversations.", "content": { "*/*": { "schema": { "type": "integer", "format": "int32" } } } }, "503": { "description": "Companion is not activated", "content": { "*/*": { "schema": { "type": "integer", "format": "int32" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/companion/chat/{conversationId}": { "get": { "tags": [ "Companion" ], "description": "Stream chat responses from the eccenca companion.", "operationId": "companionChatGet", "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of messages or empty list if conversation does not exist", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanionMessage" } } } } }, "503": { "description": "Companion is not activated", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanionMessage" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Companion" ], "description": "Deletes a conversation from the chat memory.", "operationId": "companionChatDelete", "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletion successful" }, "503": { "description": "Companion is not activated" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/companion/chat/{conversationId}/summary": { "get": { "tags": [ "Companion" ], "description": "Summarize an chat", "operationId": "companionChatSummary", "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Conversation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/companion/chat/{conversationId}/stomp": { "get": { "tags": [ "Companion" ], "description": "Stream chat responses from the eccenca companion asstomp messages.", "operationId": "companionChatGetStomp", "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of messages or empty list if conversation does not exist", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanionStompMessage" } } } } }, "503": { "description": "Companion is not activated", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanionStompMessage" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/authorization/users": { "get": { "tags": [ "Authorization Management API 2" ], "summary": "Lists IRIs of user of users who have already logged into CMEM or are persisted in access conditions as required user. Anonymous user is also returned.", "operationId": "accessConditionAvailableUsers", "responses": { "200": { "description": "User IRIs returned", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "403": { "description": "The user is not allowed to manage access conditions", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": { "200": { "description": "Access condition found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } }, "403": { "description": "The user is not allowed to execute this action", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AccessConditionView" } } } }, "404": { "description": "Access condition not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/authorization/groups": { "get": { "tags": [ "Authorization Management API 2" ], "summary": "Lists IRIs of groups of users who have already logged into CMEM or are persisted in access conditions as required group. Also returned are configured admin group and public group.", "operationId": "accessConditionAvailableGroups", "responses": { "200": { "description": "Group IRIs returned", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "403": { "description": "The user is not allowed to manage access conditions", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/api/authorization/actions": { "get": { "tags": [ "Authorization Management API 2" ], "summary": "Lists available actions for access conditions", "operationId": "accessConditionAvailableActions", "responses": { "200": { "description": "Actions returned", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Action" } } } } }, "403": { "description": "The user is not allowed to manage access conditions", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Action" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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" }, "404": { "description": "No query with given id found" }, "403": { "description": "The current user is not authorized for this operation" }, "400": { "description": "The request is not possible in the given environment" }, "500": { "description": "Internal error in aborting the query" } }, "security": [ { "bearerAuth": [] } ] } }, "/dataplatform/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": [] } ] } }, "/dataplatform/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": { "type": "object", "properties": { "iri": { "type": "string" }, "queryTypes": { "type": "array", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true }, "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" } }, "queryText": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "comment": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true } }, "required": [ "iri", "label", "labels", "queryText", "queryTypes" ] }, "Literal": { "type": "object", "properties": { "value": { "type": "string" }, "lang": { "type": "string" }, "datatype": { "type": "string" } }, "required": [ "value" ] }, "TitleResolve": { "type": "object", "properties": { "iri": { "type": "string" }, "title": { "type": "string" }, "lang": { "type": "string" }, "graph": { "type": "string" }, "fromIri": { "type": "boolean" }, "predicate": { "type": "string" } }, "required": [ "iri", "title" ] }, "VizNodePlacement": { "type": "object", "properties": { "iri": { "type": "string" }, "x": { "type": "integer", "format": "int32" }, "y": { "type": "integer", "format": "int32" }, "locates": { "type": "string" } }, "required": [ "locates", "x", "y" ] }, "Vizualization": { "type": "object", "properties": { "iri": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "minItems": 1 }, "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" }, "label": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "comment": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true } }, "required": [ "comments", "contextGraph", "iri", "label", "labels" ] }, "ChangeSet": { "type": "object", "properties": { "resource": { "type": "string" }, "newResource": { "type": "boolean" }, "nodeShapeIris": { "type": "array", "items": { "type": "string" } }, "valueChanges": { "type": "array", "items": { "$ref": "#/components/schemas/ValueChange" } } } }, "RDFTerm": { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "RESOURCE", "BLANK_NODE", "LITERAL" ] }, "literal": { "$ref": "#/components/schemas/Literal" }, "resource": { "type": "string" } }, "required": [ "termType" ] }, "ResourceChangeSet": { "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" } } }, "required": [ "mainResource" ] }, "Statement": { "type": "object", "properties": { "subject": { "type": "string" }, "predicate": { "type": "string" }, "object": { "$ref": "#/components/schemas/RDFTerm" }, "graph": { "type": "string" } }, "required": [ "object", "predicate", "subject" ] }, "ValueChange": { "type": "object", "properties": { "propertyShapeIri": { "type": "string" }, "propertyIri": { "type": "string" }, "deleteGraphIri": { "type": "string" }, "deletes": { "type": "array", "items": { "$ref": "#/components/schemas/RDFTerm" } }, "inserts": { "type": "array", "items": { "$ref": "#/components/schemas/RDFTerm" } } } }, "SaveReport": { "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" } }, "onSaveTriggeredWorkflowsWithPayload": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/WorkFlowTriggerWidgetDto" }, "uniqueItems": true } }, "onSaveTriggeredWorkflowsNoPayload": { "type": "array", "items": { "$ref": "#/components/schemas/WorkFlowTriggerWidgetDto" }, "uniqueItems": true }, "operationTraceDescription": { "type": "string" } }, "required": [ "deletedCount", "duration", "end", "insertedCount", "metadataCount", "onSaveTriggeredWorkflowsNoPayload", "onSaveTriggeredWorkflowsWithPayload", "persistedIris", "resource", "start", "versioningCount" ] }, "WorkFlowTriggerWidgetDto": { "type": "object", "properties": { "name": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "depictionUri": { "type": "string" }, "triggeredWorkflowUri": { "type": "string" }, "refreshViewOnTaskEnded": { "type": "boolean" }, "sendResourceReference": { "type": "boolean" } }, "required": [ "name", "refreshViewOnTaskEnded", "sendResourceReference", "triggeredWorkflowUri" ] }, "AccessControlModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" } } }, "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" }, "conciseBoundLoadAlgorithm": { "type": "string", "enum": [ "ITERATIVE", "QUERY" ] } } }, "AppPresentationConfiguration": { "type": "object", "properties": { "companyName": { "type": "string" }, "applicationName": { "type": "string" }, "windowTitle": { "type": "string" }, "faviconUrl": { "type": "string" }, "logoUrl": { "type": "string" }, "bannerBackgroundColor": { "type": "string" } } }, "BkeModuleConfiguration": { "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/BkeSearchQuery" } } } }, "BkeSearchQuery": { "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" } } } }, "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" } } }, "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", "format": "uri", "example": "https://my/default/graph" }, "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" }, "enableFullShaclValidationInEditModes": { "type": "boolean" }, "mapServer": { "$ref": "#/components/schemas/MapServer" }, "navigationDefaultClass": { "type": "string" }, "navigationItemsPerPage": { "type": "integer", "format": "int32" }, "navigationTopQuery": { "type": "string", "deprecated": true }, "navigationSubQuery": { "type": "string", "deprecated": true }, "navigationSearchQuery": { "type": "string", "deprecated": true }, "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": { "type": "object", "properties": { "pathFilters": { "type": "array", "items": { "$ref": "#/components/schemas/PathVariableFilter" } }, "paths": { "type": "array", "items": { "$ref": "#/components/schemas/Path" } }, "fullTextSearch": { "$ref": "#/components/schemas/FullTextSearchFilter" } }, "required": [ "paths" ] }, "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": { "type": "object", "properties": { "value": { "type": "string" }, "lang": { "type": "string" } }, "required": [ "value" ] }, "LinkRuleModuleConfiguration": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "hierarchyEnable": { "type": "boolean" }, "projectId": { "type": "string" }, "publishedRulesWorkflowId": { "type": "string" }, "outputGraphTemplate": { "type": "string" }, "publicationGraphTemplate": { "type": "string" }, "annotationClassIri": { "type": "string" }, "annotationValuePropertyIri": { "type": "string" }, "annotationLinkPropertyIri": { "type": "string" }, "annotationGraphIri": { "type": "string" }, "accessConditionIri": { "type": "string" }, "resultDownloadQuery": { "type": "string" }, "templateCatalogIri": { "type": "string" } }, "required": [ "enabled", "hierarchyEnable", "id" ] }, "MapServer": { "type": "object", "properties": { "ext": { "type": "string" }, "url": { "type": "string" } } }, "Modules": { "type": "object", "properties": { "exploreModuleConfiguration": { "$ref": "#/components/schemas/ExploreModuleConfiguration" }, "bkeModuleConfiguration": { "$ref": "#/components/schemas/BkeModuleConfiguration" }, "accountSettingsModuleConfiguration": { "$ref": "#/components/schemas/AccountSettingsModuleConfiguration" }, "administrationModuleConfiguration": { "$ref": "#/components/schemas/AdministrationModuleConfiguration" }, "accessControlModuleConfiguration": { "$ref": "#/components/schemas/AccessControlModuleConfiguration" }, "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" } } }, "NavigationConfiguration": { "type": "object", "properties": { "topConceptQuery": { "type": "string" }, "conceptParentChildQuery": { "type": "string" }, "fallbackPrefixes": { "type": "object", "additionalProperties": { "type": "string" } }, "workspaceBadgesConfiguration": { "$ref": "#/components/schemas/WorkspaceBadgesConfiguration" } } }, "Path": { "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" } } }, "required": [ "inverted", "predicate" ] }, "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": { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "GreaterThan", "LessThan", "GreaterEqualsThan", "LessEqualThan", "NotEquals", "Contains", "Regex" ] }, "value": { "$ref": "#/components/schemas/Literal" } }, "required": [ "operation", "value" ] }, "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": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "name", "url" ] }, "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" } } }, "WorkspaceBadgeFacet": { "type": "object", "properties": { "id": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/JsonLiteral" }, "minItems": 1 }, "prefixes": { "type": "array", "items": { "$ref": "#/components/schemas/JsonLiteral" } }, "type": { "type": "string", "enum": [ "NUMERIC", "DATE", "STRING", "RESOURCE" ] }, "bgColor": { "type": "string" }, "query": { "type": "string" }, "order": { "type": "integer", "format": "int64" }, "alwaysVisible": { "type": "boolean" }, "enabled": { "type": "boolean" }, "target": { "type": "string", "enum": [ "RESOURCE", "STATEMENT" ] } }, "required": [ "alwaysVisible", "bgColor", "enabled", "id", "labels", "order", "query", "target", "type" ] }, "WorkspaceBadgesConfiguration": { "type": "object", "properties": { "facets": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceBadgeFacet" } } } }, "WorkspaceConfiguration": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" }, "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" }, "featureFlags": { "type": "string" }, "featureFlagConfig": { "type": "string" }, "enableGraphInsights": { "type": "boolean" }, "enableCompanion": { "type": "boolean" }, "navigationConfiguration": { "$ref": "#/components/schemas/NavigationConfiguration" } }, "required": [ "id" ] }, "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": { "type": "object", "properties": { "iri": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/JsonLiteral" }, "minItems": 1, "uniqueItems": true }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/JsonLiteral" }, "uniqueItems": true }, "referencedQueries": { "type": "array", "items": { "$ref": "#/components/schemas/ChartConfigurationQueryReference" }, "minItems": 1, "uniqueItems": true }, "formType": { "type": "string", "enum": [ "ASSISTED", "ADVANCED" ] }, "chartType": { "type": "string" }, "jsonSerialization": { "type": "string" } }, "required": [ "description", "formType", "jsonSerialization", "labels", "referencedQueries" ] }, "ChartConfigurationQueryReference": { "type": "object", "properties": { "iri": { "type": "string" }, "index": { "type": "integer", "format": "int32" }, "parameterValueMap": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "index", "iri", "parameterValueMap" ] }, "UpdateAccessConditionRequest": { "type": "object", "properties": { "iri": { "type": "string" }, "name": { "type": "string" }, "comment": { "type": "string" }, "requiresAccount": { "type": "string", "pattern": "^((?!((^|, )http://eccenca.com/)+$).)*$" }, "requiresGroup": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "readableGraphs": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "writableGraphs": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "allowedActions": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "grantAllowedActions": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "grantReadPatterns": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "grantWritePatterns": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "dynamicAccessConditionQuery": { "type": "string" } }, "required": [ "allowedActions", "grantAllowedActions", "grantReadPatterns", "grantWritePatterns", "iri", "name", "readableGraphs", "requiresGroup", "writableGraphs" ] }, "AccessConditionView": { "type": "object", "properties": { "iri": { "type": "string" }, "name": { "type": "string" }, "comment": { "type": "string" }, "requiresAccount": { "type": "string", "pattern": "^((?!((^|, )http://eccenca.com/)+$).)*$" }, "requiresGroup": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "readableGraphs": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "writableGraphs": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "allowedActions": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "grantAllowedActions": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "grantReadPatterns": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "grantWritePatterns": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "dynamicAccessConditionQuery": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "creator": { "type": "string" }, "contributor": { "type": "string" }, "modified": { "type": "string", "format": "date-time" } }, "required": [ "allowedActions", "created", "creator", "grantAllowedActions", "grantReadPatterns", "grantWritePatterns", "iri", "name", "readableGraphs", "requiresGroup", "writableGraphs" ] }, "SparqlQueryFramedSchema": { "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" } }, "named-graph-uri": { "type": "array", "description": "May include zero or more named graph URIs", "items": { "type": "string" } }, "owlImportsResolution": { "type": "boolean", "description": "Enable/disable OWL imports resolution for this query" }, "base64encoded": { "type": "boolean", "default": false, "description": "If set to true; the query parameter is expected in base64 encoding" }, "frame": { "type": "string", "default": "{}" } }, "required": [ "query" ] }, "ResourceStoreFramedSchema": { "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." } }, "required": [ "graph", "resource" ] }, "PropertyUsage": { "type": "object", "properties": { "property": { "type": "string" }, "datatypesOfObjects": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "classesOfObjects": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "classesOfSubjects": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "languageTagsOfLiterals": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } } }, "FileUploadRequest": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File id of previous analysis of this file (mandatory)", "minLength": 1 }, "graphIri": { "type": "string", "description": "Graph IRI for upload (mandatory)", "minLength": 1 } }, "required": [ "fileId", "graphIri" ] }, "UploadRequest": { "type": "object", "properties": { "uploadId": { "type": "string", "description": "Upload id of file", "minLength": 1 }, "fileUploadRequests": { "type": "array", "description": "List of files to upload", "items": { "$ref": "#/components/schemas/FileUploadRequest" }, "minItems": 1 } }, "required": [ "fileUploadRequests", "uploadId" ] }, "StatementLevelMetadata": { "type": "object", "properties": { "metadataIri": { "type": "string" }, "subject": { "type": "string" }, "predicate": { "type": "string" }, "object": { "$ref": "#/components/schemas/RDFTerm" }, "multiAnnotationValueCount": { "type": "integer", "format": "int64" } }, "required": [ "metadataIri", "multiAnnotationValueCount", "object", "predicate", "subject" ] }, "Filter": { "type": "object", "properties": { "variable": { "type": "string" }, "function": { "type": "string", "enum": [ "oneOf", "equals", "equalsStr", "lessThan", "lessEqualsThan", "greaterThan", "greaterEqualsThan", "contains", "startsWith", "endsWith", "regex", "language", "datatype", "isIri", "isLiteral", "isBound", "isNotBound" ] }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/RdfTermNode" } } } }, "RdfTermNode": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "uri", "literal" ] }, "value": { "type": "string" }, "datatype": { "type": "string" }, "language": { "type": "string" } }, "required": [ "type", "value" ] }, "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": { "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" } }, "required": [ "assignedClasses", "depiction", "diProjectGraph", "graphProperties", "iri", "label", "projectInternal", "systemResource", "writeable" ] }, "RichStatement": { "type": "object", "properties": { "subject": { "$ref": "#/components/schemas/ValueView" }, "predicate": { "$ref": "#/components/schemas/ValueView" }, "object": { "$ref": "#/components/schemas/ValueView" } }, "required": [ "object", "predicate", "subject" ] }, "ValueView": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/RDFTerm" }, "titleResolve": { "$ref": "#/components/schemas/TitleResolve" }, "provenance": { "$ref": "#/components/schemas/Provenance" }, "annotated": { "type": "boolean" } }, "required": [ "value" ] }, "BaseResource": { "type": "object", "properties": { "label": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "comment": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "iri": { "type": "string" } }, "required": [ "label" ] }, "ReportEntryConstraintMessageTemplate": { "type": "object", "properties": { "constraintName": { "type": "string", "enum": [ "CLASS", "MIN_COUNT", "MAX_COUNT", "DATATYPE", "SH_SHAPE", "PATTERN", "STR_LANGUAGE_IN", "STR_MAX_LENGTH", "STR_MIN_LENGTH", "NODE_KIND", "IN", "VALUE_MAX_EXCLUSIVE", "VALUE_MAX_INCLUSIVE", "VALUE_MIN_EXCLUSIVE", "VALUE_MIN_INCLUSIVE", "UNIQUE_LANG", "CLOSED", "SPARQL", "UNKNOWN" ] }, "param1": { "type": "string" }, "param2": { "type": "string" }, "scope": { "type": "string", "enum": [ "VALUE", "NODE", "NODE_SHAPE" ] } }, "required": [ "constraintName", "scope" ] }, "ReportEntryView": { "type": "object", "properties": { "path": { "type": "string" }, "focusNode": { "type": "string" }, "source": { "type": "string" }, "severity": { "type": "string", "enum": [ "INFO", "WARNING", "VIOLATION" ] }, "value": { "$ref": "#/components/schemas/RDFTerm" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "minItems": 1 }, "reportEntryConstraintMessageTemplate": { "$ref": "#/components/schemas/ReportEntryConstraintMessageTemplate" }, "isCustomMessage": { "type": "boolean" } }, "required": [ "focusNode", "isCustomMessage", "messages", "reportEntryConstraintMessageTemplate", "severity", "source" ] }, "ResourceValidationReportView": { "type": "object", "properties": { "resourceIri": { "type": "string" }, "originalIri": { "type": "string" }, "nodeShapes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "violations": { "type": "array", "items": { "$ref": "#/components/schemas/ReportEntryView" } }, "shapeGraphIri": { "type": "string" } } }, "ResourceBatchValidationRunStatus": { "type": "object", "properties": { "id": { "type": "string" }, "user": { "type": "string" }, "resources": { "type": "array", "items": { "type": "string" } }, "executionStarted": { "type": "integer", "format": "int64" }, "executionFinished": { "type": "integer", "format": "int64" }, "resourceSelectionQuery": { "type": "string" }, "shapeGraphIri": { "type": "string" }, "contextGraphIri": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceValidationReportView" } }, "state": { "type": "string", "enum": [ "SCHEDULED", "RUNNING", "FINISHED", "ERROR", "CANCELLED" ] }, "error": { "type": "string" }, "traceId": { "type": "string" }, "filteredGraphs": { "type": "array", "items": { "type": "string" } }, "resultsGraphIri": { "type": "string" }, "violationsCount": { "type": "integer", "format": "int64" }, "resourcesWithViolationsCount": { "type": "integer", "format": "int64" }, "resourceCount": { "type": "integer", "format": "int64" }, "resourceProcessedCount": { "type": "integer", "format": "int64" }, "executionTime": { "type": "integer", "format": "int64" } }, "required": [ "contextGraphIri", "filteredGraphs", "id", "resourceCount", "resourceProcessedCount", "resourceSelectionQuery", "resources", "resourcesWithViolationsCount", "shapeGraphIri", "state", "user", "violationsCount" ] }, "BulkResolveNodeShapeRequest": { "type": "object", "properties": { "resources": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "contextGraph": { "type": "string" }, "shapeGraph": { "type": "string" } }, "required": [ "resources" ] }, "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": { "type": "object", "properties": { "resource": { "type": "string" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/SearchResultMatch" } }, "highestRank": { "type": "number", "format": "double" } }, "required": [ "highestRank", "matches", "resource" ] }, "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": { "type": "object", "properties": { "nodeShapeIris": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "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" } } }, "required": [ "annotateAble", "nodeShapeIris", "propLabel", "propShapeName", "propertyIri", "valueAddable" ] }, "ResourceView": { "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" } } }, "required": [ "iri", "label" ] }, "ShaclGroup": { "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" }, "label": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "comment": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true } }, "required": [ "iri", "label", "labels" ] }, "ShuiSparqlQuery": { "type": "object", "properties": { "iri": { "type": "string" }, "queryText": { "type": "string" }, "queryTypes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } } }, "WorkflowTrigger": { "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" }, "refreshViewOnTaskEnded": { "type": "boolean" }, "sendResourceReference": { "type": "boolean" }, "label": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "comment": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true } }, "required": [ "iri", "label", "labels" ] }, "QueryTypeAnalysis": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } }, "FormatResponse": { "type": "object", "properties": { "query": { "type": "string" } }, "required": [ "query" ] }, "LogicalPlanResponse": { "type": "object", "properties": { "plan": { "type": "string" } }, "required": [ "plan" ] }, "CreateResponse": { "type": "object", "properties": { "iri": { "type": "string" } } }, "ShaclResourceRelationRequest": { "type": "object", "properties": { "shapeGraph": { "type": "string" }, "contextGraph": { "type": "string" }, "resources": { "type": "array", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true } }, "required": [ "contextGraph", "resources" ] }, "ShaclResourceRelationDto": { "type": "object", "properties": { "sourceResourceIri": { "type": "string" }, "targetResourceIri": { "type": "string" }, "contextGraph": { "type": "string" }, "propertyShapeIri": { "type": "string" } }, "required": [ "contextGraph", "propertyShapeIri", "sourceResourceIri", "targetResourceIri" ] }, "ShaclResourceRelationsDto": { "type": "object", "properties": { "relations": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ShaclResourceRelationDto" }, "uniqueItems": true } } }, "required": [ "relations" ] }, "PropertyShapeDataSelectQueryRequest": { "type": "object", "properties": { "propertyShapes": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "shapeGraph": { "type": "string" }, "resource": { "type": "string" }, "contextGraph": { "type": "string" } }, "required": [ "contextGraph", "propertyShapes", "resource" ] }, "DataResponseError": { "type": "object", "properties": { "resourceIri": { "type": "string" }, "contextIri": { "type": "string" }, "property": { "type": "string" }, "code": { "type": "string", "enum": [ "NOT_NULL", "NOT_EMPTY", "SIZE_CONSTRAINT_VIOLATION", "POSITIVE_OR_ZERO", "POSITIVE", "NEGATIVE_OR_ZERO", "NEGATIVE", "FUTURE", "PAST", "DOUBLE_TRIPLE", "DATATYPE", "MORE_THEN_ONE_FIELD", "UNKNOWN", "NOT_FOUND", "PATH_COMPLEX", "QUERY_UNPARSABLE" ] }, "message": { "type": "string" } }, "required": [ "code", "contextIri", "message", "resourceIri" ] }, "ListResponseShaclDataQuerySet": { "type": "object", "properties": { "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/DataResponseError" } }, "payload": { "type": "array", "items": { "$ref": "#/components/schemas/ShaclDataQuerySet" } } }, "required": [ "payload", "validationErrors" ] }, "ShaclDataQuery": { "type": "object", "properties": { "resolvedQuery": { "type": "string" }, "resourceVariable": { "type": "string" }, "graphVariable": { "type": "string" } }, "required": [ "resolvedQuery", "resourceVariable" ] }, "ShaclDataQuerySet": { "type": "object", "properties": { "propertyShapeIri": { "type": "string" }, "valueQuery": { "$ref": "#/components/schemas/ShaclDataQuery" }, "uiQuery": { "$ref": "#/components/schemas/ShaclDataQuery" } }, "required": [ "propertyShapeIri", "uiQuery", "valueQuery" ] }, "FacetDetail": { "type": "object", "properties": { "iri": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "description": { "$ref": "#/components/schemas/TitleResolve" } }, "required": [ "count", "iri", "label" ] }, "GetFacetsRequest": { "type": "object", "properties": { "contextGraph": { "type": "string", "description": "Single default graph", "example": "http://context/graph" }, "queryFragment": { "type": "string", "description": "Query fragment for the WHERE clause (either queryFragment or classIri must be specified).", "example": "{?resource a \u003chttp://example.com/MyClass\u003e}" }, "classIris": { "type": "array", "description": "IRI of the class the resource is an instance of (either queryFragment or classIri must be specified).", "example": "http://example.com/MyClass", "items": { "type": "string" } }, "incoming": { "type": "boolean", "description": "Defines, if incoming or outgoing properties of are calculated. If \u0027true\u0027, the facets are calculated for incoming properties are returned, default \u003d false", "example": false }, "variableName": { "type": "string", "description": "Used with query fragment: Defines the variable for which the facets are calculated.", "example": "thing" }, "sparqlQuery": { "type": "string", "description": "sparqlQuery", "example": "SELECT ?thing {?thing a \u003chttp://example.com/MyClass\u003e}" }, "langPrefences": { "type": "array", "description": "Language preferences that override the system settings. Used for both shape and data", "items": { "type": "string" } }, "allowStale": { "type": "boolean", "description": "Allow returning stale (possibly not current) values from cache, default \u003d false" } } }, "FacetListEntry": { "type": "object", "properties": { "iri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "description": { "$ref": "#/components/schemas/TitleResolve" } }, "required": [ "description", "iri", "label" ] }, "VoiceTranscriptionResponse": { "type": "object", "properties": { "text": { "type": "string" } }, "required": [ "text" ] }, "CompanionResponse": { "type": "object", "description": "Container for the possible replies of the companion.", "properties": { "unifiedCompanionResponse": { "$ref": "#/components/schemas/UnifiedCompanionResponse" }, "textResponse": { "type": "string" }, "chatInterruptReason": { "type": "string", "enum": [ "USER_INTERRUPT", "MAX_TOOLCALL_INTERRUPT", "ERROR_OCCURRED", "COMPANION_DISABLED" ] } } }, "CompanionResponseEntryChanges": { "type": "object", "description": "Provide suggested changes, if the user wants to alter the knowledge graph. Those changes will be displayed to the user for confirmation before applying them.", "properties": { "proposedChanges": { "type": "array", "description": "Proposed changes to resources in the knowledge graph", "items": { "$ref": "#/components/schemas/ResourceChange" } }, "relatedResourceIris": { "type": "array", "description": "IRIs of related resources that provide context for these changes", "items": { "type": "string" } } }, "required": [ "proposedChanges" ] }, "CompanionResponseEntryQuery": { "type": "object", "description": "Navigation response for executing a SPARQL query", "properties": { "userMessage": { "type": "string", "description": "Explains how this query further explains the result description", "example": "This query finds all customers with recent orders", "minLength": 1 }, "sparqlQuery": { "type": "string", "description": "SPARQL query string", "minLength": 1 }, "queryLabel": { "type": "string", "description": "Human-readable query label" } }, "required": [ "queryLabel", "sparqlQuery", "userMessage" ] }, "CompanionResponseEntryResources": { "type": "object", "description": "Navigation response for pointing users to certain resources. Use different instances for different types of navigation or different contextGraphs", "properties": { "listLabel": { "type": "string", "description": "A short user facing label for the list", "example": "Customer records of the last 3 days.", "minLength": 1 }, "resourceIris": { "type": "array", "description": "List of resource IRIs to display", "items": { "type": "string" }, "maxItems": 2147483647, "minItems": 1 }, "contextGraphIri": { "type": "string" } }, "required": [ "contextGraphIri", "listLabel", "resourceIris" ] }, "ResourceChange": { "type": "object", "description": "Contains one or more changes to a specific resource in the knowledge graph", "properties": { "resourceIri": { "type": "string", "description": "IRI of the resource to modify", "minLength": 1 }, "changes": { "type": "array", "description": "List of property value changes for this resource", "items": { "$ref": "#/components/schemas/ResourceValueChange" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "changes", "resourceIri" ] }, "ResourceValueChange": { "type": "object", "description": "Updates the value of the specified property. Update existing values or add new ones by setting oldValue to null, delete values by setting newValue to null", "properties": { "propertyIri": { "type": "string", "description": "IRI of the property to modify", "minLength": 1 }, "oldValue": { "$ref": "#/components/schemas/RDFTerm", "description": "Current value to replace or remove (null for new values)" }, "newValue": { "$ref": "#/components/schemas/RDFTerm", "description": "New value to set (null to delete)" } }, "required": [ "propertyIri" ] }, "UnifiedCompanionResponse": { "type": "object", "description": "Unified companion response containing all possible response types", "properties": { "userMessage": { "type": "string", "description": "User-facing message explaining the AI\u0027s response", "minLength": 1 }, "resources": { "type": "array", "description": "Resource lists for navigation", "items": { "$ref": "#/components/schemas/CompanionResponseEntryResources" } }, "queries": { "type": "array", "description": "SPARQL queries for further exploration", "items": { "$ref": "#/components/schemas/CompanionResponseEntryQuery" } }, "changes": { "type": "array", "description": "Suggested changes to apply to the knowledge graph", "items": { "$ref": "#/components/schemas/CompanionResponseEntryChanges" } } }, "required": [ "changes", "queries", "resources", "userMessage" ] }, "CreateAccessConditionRequest": { "type": "object", "properties": { "staticId": { "type": "string" }, "name": { "type": "string" }, "comment": { "type": "string" }, "requiresAccount": { "type": "string", "pattern": "^((?!((^|, )http://eccenca.com/)+$).)*$" }, "requiresGroup": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "readableGraphs": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "writableGraphs": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "allowedActions": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "grantAllowedActions": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "grantReadPatterns": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "grantWritePatterns": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "dynamicAccessConditionQuery": { "type": "string" } }, "required": [ "name" ] }, "AccessConditionReviewRequest": { "type": "object", "properties": { "accountIri": { "type": "string" }, "groupIris": { "type": "array", "items": { "type": "string" } } }, "required": [ "accountIri" ] }, "AccessConditionReviewMatch": { "type": "object", "properties": { "accessConditionIri": { "type": "string" }, "accessConditionName": { "type": "string" }, "accessConditionDescription": { "type": "string" }, "dynamicAccessConditionQuery": { "type": "string" }, "readableGraphs": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "writableGraphs": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "allowedActions": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "readGraphGrants": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "writeGraphGrants": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } }, "required": [ "accessConditionIri", "allowedActions", "readGraphGrants", "readableGraphs", "writableGraphs", "writeGraphGrants" ] }, "AccessConditionReviewView": { "type": "object", "properties": { "principalName": { "type": "string" }, "accountIri": { "type": "string" }, "hasRootAccess": { "type": "boolean" }, "canReadAll": { "type": "boolean" }, "canWriteAll": { "type": "boolean" }, "areAllActionsAllowed": { "type": "boolean" }, "readableGraphs": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "writableGraphs": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "allowedActions": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "readGraphGrants": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "writeGraphGrants": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "matchingAccessConditions": { "type": "array", "items": { "$ref": "#/components/schemas/AccessConditionReviewMatch" }, "uniqueItems": true }, "validityTimeStamp": { "type": "string", "format": "date-time" } }, "required": [ "accountIri", "allowedActions", "areAllActionsAllowed", "canReadAll", "canWriteAll", "hasRootAccess", "matchingAccessConditions", "principalName", "readGraphGrants", "readableGraphs", "validityTimeStamp", "writableGraphs", "writeGraphGrants" ] }, "UserInfoSchema": { "type": "object", "properties": { "accountName": { "type": "string" }, "uri": { "type": "string" }, "isRoot": { "type": "boolean" } }, "required": [ "uri" ] }, "EndpointDescription": { "type": "object", "properties": { "graphs": { "type": "array", "items": { "$ref": "#/components/schemas/Graph" } } } }, "Graph": { "type": "object", "properties": { "iri": { "type": "string" }, "writeable": { "type": "boolean" } } }, "ImportTree": { "type": "object", "properties": { "tree": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "ignored": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "ReadableGraphDetailed": { "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" } }, "required": [ "iri", "label" ] }, "ClassUptake": { "type": "object", "properties": { "classIri": { "type": "string" }, "usedInGraph": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } } }, "PropertyUptake": { "type": "object", "properties": { "propertyIri": { "type": "string" }, "usedInGraph": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } } }, "VocabUptake": { "type": "object", "properties": { "graphIri": { "type": "string" }, "classUptakes": { "type": "array", "items": { "$ref": "#/components/schemas/ClassUptake" } }, "propertyUptakes": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyUptake" } } } }, "UsageConnectedClasses": { "type": "object", "properties": { "sourceClass": { "type": "string" }, "targetClass": { "type": "string" }, "property": { "type": "string" } }, "required": [ "property", "sourceClass", "targetClass" ] }, "ShapeConnectedClasses": { "type": "object", "properties": { "sourceClass": { "type": "string" }, "targetClass": { "type": "string" }, "propertyShape": { "type": "string" } }, "required": [ "propertyShape", "sourceClass", "targetClass" ] }, "VocabularyProperty": { "type": "object", "properties": { "iri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "comment": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "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" } } }, "required": [ "iri", "label", "labels" ] }, "VocabularyClass": { "type": "object", "properties": { "iri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "comment": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "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" } } }, "required": [ "iri", "label", "labels" ] }, "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" } }, "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" } } }, "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": { "type": "object", "properties": { "uploadId": { "type": "string", "description": "Upload id of the original store request for this file", "minLength": 1 }, "fileId": { "type": "string", "description": "File id of the original analysis request for this file", "minLength": 1 }, "fileName": { "type": "string", "description": "File name as provided in upload", "minLength": 1 }, "uploadStarted": { "type": "string", "format": "date-time", "description": "Time for the start of upload to store (UTC)" }, "uploadFinished": { "type": "string", "format": "date-time", "description": "Time for the end of upload to store (UTC)" }, "fileUploadStatus": { "type": "string", "description": "Status of the upload of this file (one of QUEUED, STARTED, UPLOADING, FINISHED, FAILED)", "enum": [ "QUEUED", "STARTED", "UPLOADING", "FINISHED", "FAILED" ], "minLength": 1 }, "errorMessage": { "type": "string", "description": "Error message if error occurred" } }, "required": [ "fileId", "fileName", "fileUploadStatus", "uploadId" ] }, "UploadStatusInfo": { "type": "object", "properties": { "uploadId": { "type": "string", "description": "Upload id of stored file (data or archive)", "minLength": 1 }, "fileUploadStats": { "type": "array", "description": "Status infos for single requested file uploads", "items": { "$ref": "#/components/schemas/FileUploadStats" }, "minItems": 1 }, "status": { "type": "string", "description": "Summary status for upload (one of QUEUED, RUNNING, FINISHED, FAILED)", "enum": [ "QUEUED", "RUNNING", "FINISHED", "FAILED" ], "minLength": 1 } }, "required": [ "fileUploadStats", "status", "uploadId" ] }, "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": { "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": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "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" }, "label": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "comment": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true } }, "required": [ "iri", "label", "labels" ] }, "PropertyShape": { "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" } }, "label": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "comment": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true } }, "required": [ "iri", "label", "labels" ] }, "TargetGraphTemplate": { "type": "object", "properties": { "iri": { "type": "string" }, "templateString": { "type": "string" }, "resourceOwnshipMethod": { "type": "string" } } }, "UriTemplate": { "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" }, "label": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true }, "comment": { "$ref": "#/components/schemas/TitleResolve", "readOnly": true } }, "required": [ "iri", "label", "labels" ] }, "ListResponseNodeShape": { "type": "object", "properties": { "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/DataResponseError" } }, "payload": { "type": "array", "items": { "$ref": "#/components/schemas/NodeShape" } } }, "required": [ "payload", "validationErrors" ] }, "ResourceBatchAggregatedValidationRunStatus": { "type": "object", "properties": { "id": { "type": "string" }, "traceId": { "type": "string" }, "user": { "type": "string" }, "executionStarted": { "type": "integer", "format": "int64" }, "executionFinished": { "type": "integer", "format": "int64" }, "executionTime": { "type": "integer", "format": "int64" }, "resourceSelectionQuery": { "type": "string" }, "shapeGraphIri": { "type": "string" }, "contextGraphIri": { "type": "string" }, "resultsGraphIri": { "type": "string" }, "state": { "type": "string", "enum": [ "SCHEDULED", "RUNNING", "FINISHED", "ERROR", "CANCELLED" ] }, "error": { "type": "string" }, "resourceCount": { "type": "integer", "format": "int64" }, "resourceProcessedCount": { "type": "integer", "format": "int64" }, "violationsCount": { "type": "integer", "format": "int64" }, "resourcesWithViolationsCount": { "type": "integer", "format": "int64" }, "filteredGraphs": { "type": "array", "items": { "type": "string" } } }, "required": [ "contextGraphIri", "filteredGraphs", "id", "resourceCount", "resourceProcessedCount", "resourceSelectionQuery", "resourcesWithViolationsCount", "shapeGraphIri", "state", "user", "violationsCount" ] }, "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" } } } }, "ListResponseCatalogQuery": { "type": "object", "properties": { "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/DataResponseError" } }, "payload": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogQuery" } } }, "required": [ "payload", "validationErrors" ] }, "Report": { "type": "object", "properties": { "iri": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "queryParameter": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } } }, "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" } } } }, "ListResponseVizListEntryDto": { "type": "object", "properties": { "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/DataResponseError" } }, "payload": { "type": "array", "items": { "$ref": "#/components/schemas/VizListEntryDto" } } }, "required": [ "payload", "validationErrors" ] }, "VizListEntryDto": { "type": "object", "properties": { "iri": { "type": "string" }, "contextGraph": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "minItems": 1 }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "createdBy": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string" }, "modifiedOn": { "type": "string", "format": "date-time" } }, "required": [ "comments", "contextGraph", "createdBy", "createdOn", "iri", "labels" ] }, "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": { "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" } }, "required": [ "addedStatements", "deletedStatements", "ignoredAddedStatements", "ignoredDeletedStatements" ] }, "GitGraphSyncChange": { "type": "object", "properties": { "author": { "type": "string" }, "timestamp": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "commit": { "type": "string" } }, "required": [ "author", "commit", "message", "timestamp" ] }, "SemspectIntegrationStatus": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Activation Status", "example": true }, "isUserAllowed": { "type": "boolean", "description": "Flag if user in context is allowed to access Semspect integration", "example": true } }, "required": [ "isActive", "isUserAllowed" ] }, "SemspectSnapshotStatus": { "type": "object", "properties": { "databaseId": { "type": "string", "description": "Generated ID of snapshot - result of graph hash" }, "updateInfoTimestamp": { "type": "string", "format": "date-time", "description": "Last update timestamp of snapshot" }, "mainGraphSynced": { "type": "string", "description": "The graph which has been synced in this snapshot" }, "allGraphsSynced": { "type": "array", "description": "The graph which has been synced in this snapshot including its sub-graphs", "items": { "type": "string", "description": "The graph which has been synced in this snapshot including its sub-graphs" }, "uniqueItems": true }, "status": { "type": "string", "description": "The status of the last snapshot load", "enum": [ "CREATED", "STARTING", "ONGOING", "DONE", "FAILED" ] }, "error": { "type": "string", "description": "A possible error in generating / updating a snapshot" }, "isValid": { "type": "boolean", "description": "A boolean flag if the data in the snapshot is still valid" }, "isOffline": { "type": "boolean", "description": "A boolean flag if the database is offline (currently unused)" } } }, "ChartConfigurationWidgetLinkDto": { "type": "object", "properties": { "chartConfigurationIri": { "type": "string" } }, "required": [ "chartConfigurationIri" ] }, "ConditionalResourceQueriesDto": { "type": "object", "properties": { "askIfCreatableQueryTemplate": { "type": "string" }, "askIfRemovableQueryTemplate": { "type": "string" }, "askIfEditableQueryTemplate": { "type": "string" }, "askIfCloneableQueryTemplate": { "type": "string" } } }, "NodeKindDto": { "type": "object", "properties": { "canBeIri": { "type": "boolean" }, "canBeLiteral": { "type": "boolean" } }, "required": [ "canBeIri", "canBeLiteral" ] }, "NodeShapeFormDto": { "type": "object", "properties": { "nodeShapeIris": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "targetClasses": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "depictionIri": { "type": "string" }, "targetGraphTemplate": { "type": "string" }, "resourceCreationUriTemplate": { "type": "string" }, "propertyShapeForms": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyShapeFormDto" } }, "widgetIntegrations": { "type": "array", "items": { "$ref": "#/components/schemas/WidgetFormViewDto" } }, "conditionalResourceQueryTemplates": { "$ref": "#/components/schemas/ConditionalResourceQueriesDto" }, "navigationListQuery": { "type": "string" }, "isAllowStatementLevelMetaData": { "type": "boolean" }, "isApplicableAsStatementLevelMetadata": { "type": "boolean" } }, "required": [ "conditionalResourceQueryTemplates", "description", "isAllowStatementLevelMetaData", "isApplicableAsStatementLevelMetadata", "name", "nodeShapeIris", "propertyShapeForms", "targetClasses", "widgetIntegrations" ] }, "PathInformationDto": { "type": "object", "properties": { "shaclPathString": { "type": "string" }, "shaclPathType": { "type": "string", "enum": [ "SIMPLE_FORWARD", "SIMPLE_BACKWARD", "COMPLEX" ] }, "simplePredicate": { "type": "string" } }, "required": [ "shaclPathString", "shaclPathType" ] }, "PropertyGroupFormDto": { "type": "object", "properties": { "propertyGroupIri": { "type": "string" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "comment": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "order": { "type": "integer", "format": "int32" } }, "required": [ "comment", "name", "propertyGroupIri" ] }, "PropertyShapeFormDto": { "type": "object", "properties": { "propertyShapeIri": { "type": "string" }, "pathInformation": { "$ref": "#/components/schemas/PathInformationDto" }, "order": { "type": "integer", "format": "int32" }, "defaultValue": { "$ref": "#/components/schemas/RDFTerm" }, "nodeShapeIris": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "label": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "isDeactivated": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "minCount": { "type": "integer", "format": "int32" }, "maxCount": { "type": "integer", "format": "int32" }, "isUniqueLang": { "type": "boolean" }, "isTextAreaInput": { "type": "boolean" }, "isShowAlways": { "type": "boolean" }, "isIgnoreOnCopy": { "type": "boolean" }, "isDenyNewResources": { "type": "boolean" }, "isAllowStatementLevelMetaData": { "type": "boolean" }, "isPreventsPathValueSorting": { "type": "boolean" }, "hasValueQuery": { "type": "boolean" }, "hasUiQuery": { "type": "boolean" }, "statementLevelMetaDataNodeShapesFilter": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "constrainedClass": { "type": "string" }, "resourceCreationClass": { "type": "string" }, "defaultResourceViewerIri": { "type": "string" }, "nodeKind": { "$ref": "#/components/schemas/NodeKindDto" }, "dataType": { "type": "string" }, "languagesIn": { "type": "array", "items": { "type": "string" } }, "propertyGroupForm": { "$ref": "#/components/schemas/PropertyGroupFormDto" }, "targetGraphTemplate": { "type": "string" }, "subResourceNodeShapeIris": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } }, "required": [ "defaultResourceViewerIri", "description", "hasUiQuery", "hasValueQuery", "isAllowStatementLevelMetaData", "isDeactivated", "isDenyNewResources", "isIgnoreOnCopy", "isPreventsPathValueSorting", "isReadOnly", "isShowAlways", "isTextAreaInput", "label", "name", "nodeKind", "nodeShapeIris", "pathInformation", "propertyShapeIri", "subResourceNodeShapeIris" ] }, "TableReportWidgetDto": { "type": "object", "properties": { "name": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "query": { "type": "string" }, "hideFooter": { "type": "boolean" }, "hideHeader": { "type": "boolean" } }, "required": [ "hideFooter", "hideHeader", "name", "query" ] }, "WidgetFormViewDto": { "type": "object", "properties": { "widgetIntegrationIri": { "type": "string" }, "widgetIri": { "type": "string" }, "widgetTypeIri": { "type": "string" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" }, "uniqueItems": true }, "order": { "type": "integer", "format": "int32" }, "propertyGroupForm": { "$ref": "#/components/schemas/PropertyGroupFormDto" }, "workFlowTriggerWidget": { "$ref": "#/components/schemas/WorkFlowTriggerWidgetDto" }, "chartConfigurationWidgetLink": { "$ref": "#/components/schemas/ChartConfigurationWidgetLinkDto" }, "tableReportWidget": { "$ref": "#/components/schemas/TableReportWidgetDto" } }, "required": [ "name", "widgetIntegrationIri", "widgetIri", "widgetTypeIri" ] }, "DataGraphResolution": { "type": "object", "properties": { "resource": { "type": "string" }, "dataGraph": { "type": "string" } }, "required": [ "dataGraph", "resource" ] }, "WorkspaceConfigurationSetResponse": { "type": "object", "properties": { "systemDefaultConfiguration": { "$ref": "#/components/schemas/WorkspaceConfiguration" }, "projectDefaultConfiguration": { "$ref": "#/components/schemas/WorkspaceConfiguration" }, "projectWorkspaces": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceConfiguration" } }, "brokenWorkspaces": { "type": "array", "items": { "type": "string" } } }, "required": [ "projectDefaultConfiguration", "projectWorkspaces", "systemDefaultConfiguration" ] }, "ToolDefinitionResponse": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "inputSchema": { "type": "string" } }, "required": [ "description", "inputSchema", "name" ] }, "CompanionSettings": { "type": "object", "properties": { "isChatActive": { "type": "boolean" }, "hasVoiceTranscriptor": { "type": "boolean" }, "isMcpActive": { "type": "boolean" } }, "required": [ "hasVoiceTranscriptor", "isChatActive", "isMcpActive" ] }, "Conversation": { "type": "object", "properties": { "conversationId": { "type": "string" }, "username": { "type": "string" }, "userLabel": { "type": "string" }, "autoSummary": { "type": "string" }, "summaryMessageCount": { "type": "integer", "format": "int32" } }, "required": [ "conversationId", "username" ] }, "AssistantMessage": { "type": "object", "properties": { "messageType": { "type": "string", "enum": [ "USER", "ASSISTANT", "SYSTEM", "TOOL" ] }, "metadata": { "type": "object", "additionalProperties": {} }, "toolCalls": { "type": "array", "items": { "$ref": "#/components/schemas/ToolCall" } }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "text": { "type": "string" } } }, "CompanionMessage": { "type": "object", "properties": { "id": { "type": "string" }, "messageType": { "type": "string", "enum": [ "USER", "ASSISTANT", "SYSTEM", "TOOL" ] }, "assistantMessage": { "$ref": "#/components/schemas/AssistantMessage" }, "toolResponseMessage": { "$ref": "#/components/schemas/ToolResponseMessage" }, "userMessage": { "$ref": "#/components/schemas/UserMessage" }, "systemMessage": { "$ref": "#/components/schemas/SystemMessage" } }, "required": [ "id", "messageType" ] }, "Media": { "type": "object", "properties": { "id": { "type": "string" }, "mimeType": { "$ref": "#/components/schemas/MimeType" }, "data": {}, "name": { "type": "string" }, "dataAsByteArray": { "type": "string", "format": "byte" } } }, "MimeType": { "type": "object", "properties": { "type": { "type": "string" }, "subtype": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "concrete": { "type": "boolean" }, "wildcardType": { "type": "boolean" }, "wildcardSubtype": { "type": "boolean" }, "subtypeSuffix": { "type": "string" }, "charset": { "type": "string" } } }, "SystemMessage": { "type": "object", "properties": { "messageType": { "type": "string", "enum": [ "USER", "ASSISTANT", "SYSTEM", "TOOL" ] }, "metadata": { "type": "object", "additionalProperties": {} }, "text": { "type": "string" } } }, "ToolCall": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "arguments": { "type": "string" } } }, "ToolResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "responseData": { "type": "string" } } }, "ToolResponseMessage": { "type": "object", "properties": { "messageType": { "type": "string", "enum": [ "USER", "ASSISTANT", "SYSTEM", "TOOL" ] }, "metadata": { "type": "object", "additionalProperties": {} }, "responses": { "type": "array", "items": { "$ref": "#/components/schemas/ToolResponse" } }, "text": { "type": "string" } } }, "UserMessage": { "type": "object", "properties": { "messageType": { "type": "string", "enum": [ "USER", "ASSISTANT", "SYSTEM", "TOOL" ] }, "metadata": { "type": "object", "additionalProperties": {} }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "text": { "type": "string" } } }, "CompanionMessageSummary": { "type": "object", "properties": { "summary": { "type": "string" } } }, "CompanionStompMessage": { "type": "object", "properties": { "conversationId": { "type": "string" }, "messageType": { "type": "string", "enum": [ "MESSAGE", "CONVERSATION_STATE", "SUMMARY" ] }, "message": { "$ref": "#/components/schemas/CompanionMessage" }, "conversationState": { "type": "string", "enum": [ "USER_MESSAGE_RECEIVED", "WAITING_FOR_LLM", "WAITING_FOR_TOOL_RESPONSE", "WAITING_FOR_NEW_USER_MESSAGE", "CANCELED", "ERROR" ] }, "summary": { "$ref": "#/components/schemas/CompanionMessageSummary" }, "errorDetail": { "type": "string" } }, "required": [ "conversationId", "messageType" ] }, "PageMetadata": { "type": "object", "properties": { "size": { "type": "integer", "format": "int64" }, "number": { "type": "integer", "format": "int64" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int64" } } }, "PagedModelAccessConditionView": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/AccessConditionView" } }, "page": { "$ref": "#/components/schemas/PageMetadata" } } }, "Action": { "type": "object", "properties": { "iri": { "type": "string" }, "name": { "type": "string" }, "comment": { "type": "string" } }, "required": [ "comment", "iri", "name" ] }, "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": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "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": {} } }, "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": {} } } }, "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": {}, "examples": { "turtle-example": { "$ref": "#/components/examples/turtle-example" } } }, "application/json": { "schema": {} }, "application/ld+json": { "schema": {} }, "application/n-triples": { "schema": {} }, "application/rdf+json": { "schema": {} }, "application/rdf+xml": { "schema": {} }, "application/sparql-results+json": { "schema": {} }, "application/sparql-results+xml": { "schema": {} }, "application/xml": { "schema": {} }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": {} }, "text/csv": { "schema": {} }, "text/html": { "schema": {} }, "text/plain": { "schema": {} }, "text/tab-separated-values": { "schema": {} } } }, "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" }, "g409": { "description": "Query has been cancelled by another user/client." } }, "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\":\"https://vocab.eccenca.com/auth/PublicGroup\"\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 eccauth:PublicGroup ;\n eccauth:requiresEndpointId \"endpointId\" ;\n eccauth:readGraph :GraphPublic ;\n rdfs:label \"Public access condition on \u0027endpointId\u0027\" ;\n.\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 eccauth:PublicGroup ;\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 eccauth:PublicGroup ;\n eccauth:readGraph :GraphPublic ;\n.\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 eccauth:PublicGroup ;\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.\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" } } } }