{ "components": { "examples": { "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 }" }, "turtle-auth-condition-resp-example": { "value": "@prefix : \u003chttps://ns.eccenca.com/\u003e .\n@prefix rdfs: \u003chttp://www.w3.org/2000/01/rdf-schema#\u003e .\n@prefix eccauth: \u003chttps://vocab.eccenca.com/auth/\u003e .\n@prefix dct: \u003chttp://purl.org/dc/terms/\u003e .\n@prefix xsd: \u003chttp://www.w3.org/2001/XMLSchema#\u003e .\n:PublicAccessCondition a eccauth:AccessCondition ;\n eccauth:requiresGroup \u003curn:elds-backend-public-group\u003e ;\n eccauth:requiresEndpointId \"endpointId\" ;\n eccauth:readGraph :GraphPublic ;\n rdfs:label \"Public access condition on \u0027endpointId\u0027\" ;\n dct:creator :username ;\n dct:created \"2017-03-14T16:41:15Z\"^^xsd:date ;\n.\n" }, "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" }, "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}" }, "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" }, "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}" }, "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}" }, "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 ." }, "turtle-auth-condition-example": { "value": "@prefix : \u003chttps://ns.eccenca.com/\u003e .\n@prefix rdfs: \u003chttp://www.w3.org/2000/01/rdf-schema#\u003e .\n@prefix eccauth: \u003chttps://vocab.eccenca.com/auth/\u003e .\n[] a eccauth:AccessCondition ;\n eccauth:requiresGroup \u003curn:elds-backend-public-group\u003e ;\n eccauth:requiresEndpointId \"endpointId\" ;\n eccauth:readGraph :GraphPublic ;\n rdfs:label \"Public access condition on \u0027endpointId\u0027\" ;\n." }, "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" }, "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" }, "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" }, "application-ld-json-response-example": { "value": "{\n \"@context\":{\n \"@vocab\":\"https://vocab.eccenca.com/auth/\"\n },\n \"@graph\":[\n {\n \"@id\":\"https://ns.eccenca.com/PublicAccessCondition\",\n \"@type\":\"AccessCondition\",\n \"http://purl.org/dc/terms/created\":{\n \"@type\":\"http://www.w3.org/2001/XMLSchema#date\",\n \"@value\":\"2017-03-14T16:41:15Z\"\n },\n \"http://purl.org/dc/terms/creator\":{\n \"@id\":\"https://ns.eccenca.com/username\"\n },\n \"http://www.w3.org/2000/01/rdf-schema#label\":\"Public access condition\",\n \"readGraph\":{\n \"@id\":\"urn:elds-backend-all-graphs\"\n },\n \"requiresGroup\":{\n \"@id\":\"urn:elds-backend-public-group\"\n }\n }\n ]\n}\n" }, "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-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 }" }, "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}" }, "turtle-auth-condition-put-example": { "value": "@prefix : \u003chttps://ns.eccenca.com/\u003e .\n@prefix eccauth: \u003chttps://vocab.eccenca.com/auth/\u003e .\n:PublicAccessCondition a eccauth:AccessCondition ;\n eccauth:requiresGroup \u003curn:elds-backend-public-group\u003e ;\n eccauth:readGraph :GraphPublic ;\n." }, "turtle-auth-condition-resp-put-example": { "value": "@prefix : \u003chttps://ns.eccenca.com/\u003e .\n@prefix rdfs: \u003chttp://www.w3.org/2000/01/rdf-schema#\u003e .\n@prefix eccauth: \u003chttps://vocab.eccenca.com/auth/\u003e .\n@prefix dct: \u003chttp://purl.org/dc/terms/\u003e .\n@prefix xsd: \u003chttp://www.w3.org/2001/XMLSchema#\u003e .\n:PublicAccessCondition a eccauth:AccessCondition ;\n eccauth:requiresGroup \u003curn:elds-backend-public-group\u003e ;\n eccauth:readGraph :GraphPublic ;\n dct:creator :username ;\n rdfs:label \"Public access condition\" ;\n dct:created \"2017-03-14T16:41:15Z\"^^xsd:date ;\n." }, "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" } }, "schemas": { "SparqlQueryFramedSchema": { "type": "object", "required": [ "query" ], "properties": { "named-graph-uri": { "description": "May include zero or more named graph URIs", "type": "array", "items": { "description": "May include zero or more named graph URIs", "type": "string" } }, "owlImportsResolution": { "description": "Enable/disable OWL imports resolution for this query", "type": "boolean" }, "base64encoded": { "default": false, "description": "If set to true; the query parameter is expected in base64 encoding", "type": "boolean" }, "default-graph-uri": { "description": "May include zero or more default graph URIs", "type": "array", "items": { "description": "May include zero or more default graph URIs", "type": "string" } }, "query": { "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)", "type": "string", "example": "CONSTRUCT ?class WHERE {?s a ?class}" }, "frame": { "default": "{}", "type": "string" } } }, "ReadableGraph": { "type": "object", "required": [ "assignedClasses", "diProjectGraph", "graphProperies", "iri", "label", "projectInternal", "systemResource", "writeable" ], "properties": { "iri": { "type": "string" }, "graphProperies": { "type": "array", "items": { "type": "string" } }, "diProjectGraph": { "type": "boolean" }, "assignedClasses": { "type": "array", "items": { "type": "string" } }, "projectInternal": { "type": "boolean" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "writeable": { "type": "boolean" }, "systemResource": { "type": "boolean" } } }, "GraphCount": { "type": "object", "properties": { "graphLabel": { "type": "string" }, "graphIri": { "type": "string" }, "triplesCount": { "format": "int32", "type": "integer" }, "writable": { "type": "boolean" } } }, "Provenance": { "type": "object", "properties": { "graph": { "$ref": "#/components/schemas/ReadableGraph" }, "writable": { "type": "boolean" } } }, "PropertyShape": { "type": "object", "required": [ "iri", "labels" ], "properties": { "inversePath": { "type": "boolean" }, "uiQuery": { "$ref": "#/components/schemas/ShuiSparqlQuery" }, "flags": { "type": "string" }, "pattern": { "type": "string" }, "valueQueryHideHeader": { "type": "boolean" }, "propertyClass": { "type": "array", "items": { "type": "string" } }, "maxCount": { "format": "int32", "type": "integer" }, "enableStatementLevelMetadata": { "type": "boolean" }, "descriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "path": { "type": "string" }, "uriTemeplate": { "type": "string" }, "uniqueLang": { "type": "boolean" }, "valueQuery": { "$ref": "#/components/schemas/ShuiSparqlQuery" }, "denyNewResources": { "type": "boolean" }, "onInsertQueries": { "type": "array", "items": { "$ref": "#/components/schemas/ShuiSparqlQuery" } }, "ignoreOnCopy": { "type": "boolean" }, "depictionUri": { "type": "string" }, "nodeKind": { "type": "string" }, "nodeShapes": { "type": "array", "items": { "type": "string" } }, "order": { "format": "int32", "type": "integer" }, "group": { "$ref": "#/components/schemas/ShaclGroupResolvable" }, "iri": { "type": "string" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "shClass": { "type": "array", "items": { "type": "string" } }, "langIn": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "dataType": { "type": "string" }, "targetGraphTemplate": { "$ref": "#/components/schemas/TargetGraphTemplate" }, "readOnly": { "type": "boolean" }, "showAlways": { "type": "boolean" }, "valueQueryHideFooter": { "type": "boolean" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "names": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "minCount": { "format": "int32", "type": "integer" }, "onDeleteQueries": { "type": "array", "items": { "$ref": "#/components/schemas/ShuiSparqlQuery" } }, "metadataPreferredNodeShapes": { "type": "array", "items": { "type": "string" } }, "textArea": { "type": "boolean" } } }, "FacetDetail": { "type": "object", "required": [ "count", "iri", "label" ], "properties": { "iri": { "type": "string" }, "count": { "format": "int32", "type": "integer" }, "description": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } }, "TargetGraphTemplate": { "type": "object", "properties": { "iri": { "type": "string" }, "resourceOwnshipMethod": { "type": "string" }, "templateString": { "type": "string" } } }, "ConnectableProperties": { "type": "object", "properties": { "preferredAnnotableProperties": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResource" } }, "allAnnotateableProperties": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResource" } } } }, "ListOptions": { "type": "object", "properties": { "searchTerm": { "type": "string" }, "offset": { "format": "int32", "type": "integer" }, "limit": { "format": "int32", "type": "integer" }, "focusVar": { "type": "string" } } }, "ShaclGroupResolvable": { "type": "object", "required": [ "iri", "labels" ], "properties": { "iri": { "type": "string" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "depictionUri": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "order": { "format": "int32", "type": "integer" } } }, "ResourceChangeSet": { "type": "object", "required": [ "mainResource" ], "properties": { "annotationFor": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeSet" } }, "comment": { "type": "string" }, "mainResource": { "type": "string" } } }, "ResourceView": { "type": "object", "required": [ "iri", "label" ], "properties": { "iri": { "type": "string" }, "shapedByNodeShape": { "additionalProperties": { "$ref": "#/components/schemas/TitleResolve" }, "type": "object" }, "shapedBy": { "type": "array", "items": { "type": "string" } }, "shapedByNodeShapeComment": { "additionalProperties": { "$ref": "#/components/schemas/TitleResolve" }, "type": "object" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "poViews": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyValueView" } }, "writable": { "type": "boolean" }, "listQuery": { "type": "array", "items": { "type": "string" } } } }, "QueryExecutionStats": { "type": "object", "required": [ "executionStarted", "id", "queryString" ], "properties": { "executionTime": { "format": "int64", "type": "integer" }, "executionFinished": { "format": "int64", "type": "integer" }, "id": { "type": "string" }, "queryString": { "type": "string" }, "executionStarted": { "format": "int64", "type": "integer" } } }, "RichStatement": { "type": "object", "required": [ "object", "predicate", "subject" ], "properties": { "predicate": { "$ref": "#/components/schemas/ValueView" }, "subject": { "$ref": "#/components/schemas/ValueView" }, "object": { "$ref": "#/components/schemas/ValueView" } } }, "Literal": { "type": "object", "required": [ "value" ], "properties": { "datatype": { "type": "string" }, "lang": { "type": "string" }, "value": { "type": "string" } } }, "NodeShape": { "type": "object", "required": [ "iri", "labels" ], "properties": { "severity": { "type": "string", "enum": [ "INFO", "WARN", "VALIDATION" ] }, "iri": { "type": "string" }, "targetClasses": { "type": "array", "items": { "type": "string" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "isApplicableAsStatementLevelMetadata": { "type": "boolean" }, "displayNames": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "targetGraphTemplate": { "$ref": "#/components/schemas/TargetGraphTemplate" }, "onUpdateUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/ShuiSparqlQuery" } }, "enableStatementLevelMetadata": { "type": "boolean" }, "targetNodes": { "type": "array", "items": { "type": "string" } }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "deactived": { "type": "boolean" }, "listQuery": { "$ref": "#/components/schemas/ShuiSparqlQuery" }, "templateString": { "type": "string" }, "subjectsOfPred": { "type": "array", "items": { "type": "string" } }, "objectsOfPred": { "type": "array", "items": { "type": "string" } }, "closed": { "type": "boolean" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Literal" } }, "depictionUri": { "type": "string" }, "metadataPreferredNodeShapes": { "type": "array", "items": { "type": "string" } }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyShape" } }, "order": { "format": "int32", "type": "integer" } } }, "ValueView": { "type": "object", "required": [ "value" ], "properties": { "provenance": { "$ref": "#/components/schemas/Provenance" }, "value": { "$ref": "#/components/schemas/RDFTerm" }, "titleResolve": { "$ref": "#/components/schemas/TitleResolve" }, "annotated": { "type": "boolean" } } }, "ShuiSparqlQuery": { "type": "object", "properties": { "iri": { "type": "string" }, "queryText": { "type": "string" }, "queryType": { "type": "string" } } }, "RdfTermNode": { "type": "object", "properties": { "datatype": { "writeOnly": true, "type": "string" }, "language": { "writeOnly": true, "type": "string" }, "type": { "type": "string", "enum": [ "uri", "literal" ] }, "value": { "type": "string" } } }, "ChangeSet": { "type": "object", "properties": { "resource": { "type": "string" }, "valueChanges": { "type": "array", "items": { "$ref": "#/components/schemas/ValueChange" } }, "nodeShapeIris": { "type": "array", "items": { "type": "string" } }, "newResource": { "type": "boolean" } } }, "ValueChange": { "type": "object", "properties": { "propertyIri": { "type": "string" }, "deletes": { "type": "array", "items": { "$ref": "#/components/schemas/RDFTerm" } }, "inserts": { "type": "array", "items": { "$ref": "#/components/schemas/RDFTerm" } }, "propertyShapeIri": { "type": "string" } } }, "TitleResolve": { "type": "object", "required": [ "iri", "title" ], "properties": { "iri": { "type": "string" }, "fromIri": { "type": "boolean" }, "title": { "type": "string" }, "lang": { "type": "string" }, "when": { "type": "string" }, "graph": { "type": "string" } } }, "UserInfoSchema": { "type": "object", "properties": { "accountName": { "type": "string" }, "uri": { "type": "string" } } }, "Report": { "type": "object", "properties": { "iri": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "queryParameter": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "Statement": { "type": "object", "required": [ "object", "predicate", "subject" ], "properties": { "predicate": { "type": "string" }, "subject": { "type": "string" }, "graph": { "type": "string" }, "object": { "$ref": "#/components/schemas/RDFTerm" } } }, "ResourceUsage": { "type": "object", "properties": { "iri": { "type": "string" }, "asObjectInGraph": { "type": "array", "items": { "$ref": "#/components/schemas/ReadableGraph" } }, "resolve": { "$ref": "#/components/schemas/TitleResolve" }, "asAnnotationValueHasMore": { "type": "boolean" }, "asSubjectInGraph": { "type": "array", "items": { "$ref": "#/components/schemas/ReadableGraph" } }, "asAnnotationValue": { "type": "array", "items": { "$ref": "#/components/schemas/ValueView" } }, "asStatementValue": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } } }, "BaseResource": { "type": "object", "properties": { "iri": { "type": "string" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "depictionUri": { "type": "string" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } }, "PropertyValueView": { "type": "object", "required": [ "annotateAble", "nodeShapeIris", "propLabel", "propShapeName", "propertyIri", "valueAddable" ], "properties": { "propShapeIri": { "type": "string" }, "inversePath": { "type": "boolean" }, "uiQuery": { "$ref": "#/components/schemas/ShuiSparqlQuery" }, "pattern": { "type": "string" }, "flags": { "type": "string" }, "valueQueryHideHeader": { "type": "boolean" }, "maxCount": { "format": "int32", "type": "integer" }, "listQuery": { "type": "string" }, "uniqueLang": { "type": "boolean" }, "valueQuery": { "type": "string" }, "denyNewResources": { "type": "boolean" }, "propLabel": { "$ref": "#/components/schemas/TitleResolve" }, "ignoreOnCopy": { "type": "boolean" }, "nestedResourceViews": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceView" } }, "propShapeName": { "type": "string" }, "nodeKind": { "type": "string" }, "group": { "$ref": "#/components/schemas/ShaclGroup" }, "order": { "format": "int32", "type": "integer" }, "propertyIri": { "type": "string" }, "propShapeDescription": { "type": "string" }, "valueAddable": { "type": "boolean" }, "shClass": { "type": "array", "items": { "type": "string" } }, "uriTemplate": { "type": "string" }, "langIn": { "type": "array", "items": { "type": "string" } }, "dataType": { "type": "string" }, "nodeShapeIris": { "type": "array", "items": { "type": "string" } }, "readOnly": { "type": "boolean" }, "showAlways": { "type": "boolean" }, "propComment": { "$ref": "#/components/schemas/TitleResolve" }, "valueQueryHideFooter": { "type": "boolean" }, "annotateAble": { "type": "boolean" }, "minCount": { "format": "int32", "type": "integer" }, "valueViews": { "type": "array", "items": { "$ref": "#/components/schemas/ValueView" } }, "textArea": { "type": "boolean" } } }, "StatementLevelMetadata": { "type": "object", "required": [ "metadataIri", "multiAnnotationValueCount", "object", "predicate", "subject" ], "properties": { "predicate": { "type": "string" }, "metadataIri": { "type": "string" }, "subject": { "type": "string" }, "multiAnnotationValueCount": { "format": "int64", "type": "integer" }, "object": { "$ref": "#/components/schemas/RDFTerm" } } }, "RDFTerm": { "type": "object", "required": [ "termType" ], "properties": { "resource": { "type": "string" }, "termType": { "type": "string", "enum": [ "RESOURCE", "BLANK_NODE", "LITERAL" ] }, "literal": { "$ref": "#/components/schemas/Literal" } } }, "ShaclGroup": { "type": "object", "properties": { "iri": { "type": "string" }, "depictionUri": { "type": "string" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "label": { "$ref": "#/components/schemas/TitleResolve" }, "order": { "format": "int32", "type": "integer" } } }, "Prefixes": { "type": "object", "properties": { "diPrefixesWithMultipleNamespaces": { "type": "array", "items": { "type": "string" } }, "catalogPrefixes": { "additionalProperties": { "type": "string" }, "type": "object" }, "catalogPrefixesWithMultipleNamespaces": { "type": "array", "items": { "type": "string" } }, "installedPrefixes": { "additionalProperties": { "type": "string" }, "type": "object" }, "installedPrefixesWithMultipleNamespaces": { "type": "array", "items": { "type": "string" } }, "userPrefixes": { "additionalProperties": { "type": "string" }, "type": "object" }, "diNamespacesWithMultiplePrefixes": { "type": "array", "items": { "type": "string" } }, "userPrefixesWithMultipleNamespaces": { "type": "array", "items": { "type": "string" } }, "diPrefixes": { "additionalProperties": { "type": "string" }, "type": "object" }, "catalogNamespacesWithMultiplePrefixes": { "type": "array", "items": { "type": "string" } }, "userNamespacesWithMultiplePrefixes": { "type": "array", "items": { "type": "string" } }, "installedNamespacesWithMultiplePrefixes": { "type": "array", "items": { "type": "string" } } } }, "StatementFilter": { "type": "object", "properties": { "subjectFilter": { "$ref": "#/components/schemas/Filter" }, "objectFilter": { "$ref": "#/components/schemas/Filter" }, "predicateFilter": { "$ref": "#/components/schemas/Filter" } } }, "GraphResourcePattern": { "type": "object", "properties": { "paths": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } }, "classFiltersOnVariable": { "additionalProperties": { "type": "array", "items": { "type": "string" } }, "type": "object" } } }, "Filter": { "type": "object", "properties": { "function": { "type": "string", "enum": [ "oneOf", "equals", "lessThan", "greaterThan", "contains", "startsWith", "endsWith", "language", "datatype", "isIri" ] }, "variable": { "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/RdfTermNode" } } } }, "ListResourceParams": { "type": "object", "properties": { "listOptions": { "$ref": "#/components/schemas/ListOptions" }, "pattern": { "$ref": "#/components/schemas/GraphResourcePattern" } } }, "ResourceStoreFramedSchema": { "type": "object", "required": [ "graph", "resource" ], "properties": { "resource": { "description": "A valid resource URI ", "type": "string", "example": "http://example.org/person/Mark_Twain" }, "graph": { "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "type": "string", "example": "http://example.org/graph" }, "frame": { "description": "An optional JSON-LD frame used to force a specific JSON-LD tree layout.", "type": "string" } } }, "ImportTree": { "type": "object", "properties": { "ignored": { "additionalProperties": { "type": "array", "items": { "type": "string" } }, "type": "object" }, "tree": { "additionalProperties": { "type": "array", "items": { "type": "string" } }, "type": "object" } } }, "SaveReport": { "type": "object", "properties": { "duration": { "format": "int64", "type": "integer" }, "versioningCount": { "format": "int32", "type": "integer" }, "resource": { "type": "string" }, "deletedCount": { "format": "int32", "type": "integer" }, "start": { "format": "int64", "type": "integer" }, "end": { "format": "int64", "type": "integer" }, "insertedCount": { "format": "int32", "type": "integer" }, "metadataCount": { "format": "int32", "type": "integer" } } }, "ReportList": { "type": "object", "properties": { "queries": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } } }, "NodeShapeListEntry": { "type": "object", "properties": { "iri": { "type": "string" }, "comment": { "$ref": "#/components/schemas/TitleResolve" }, "propertyCount": { "format": "int32", "type": "integer" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } }, "ReadableGraphDetailed": { "type": "object", "required": [ "iri", "label" ], "properties": { "iri": { "type": "string" }, "wellDefinedClassesCount": { "format": "int32", "type": "integer" }, "triplesCount": { "format": "int32", "type": "integer" }, "classesCount": { "format": "int32", "type": "integer" }, "instancesCount": { "format": "int32", "type": "integer" }, "label": { "$ref": "#/components/schemas/TitleResolve" } } } }, "responses": { "g204": { "description": "The request was processed successfully, but no information for the given parameters was found." }, "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)." }, "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." }, "sgs200Head": { "headers": { "ETag": { "schema": { "type": "string" }, "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." } }, "description": "The request was processed successfully." }, "sgs204": { "description": "The request was processed successfully, but the graph is empty." }, "sgs200Get": { "headers": { "ETag": { "schema": { "type": "string" }, "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." } }, "description": "The request was processed successfully.", "content": { "application/rdf+xml": {}, "text/turtle": { "examples": { "turtle-example": { "$ref": "#/components/examples/turtle-example" } } }, "application/n-triples": {} } }, "g400Params": { "description": "The request was malformed, check the parameters." }, "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": { "application/xml": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "application/ld+json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/rdf+xml": { "schema": { "type": "string" } }, "text/turtle": { "schema": { "type": "string" }, "examples": { "turtle-example": { "$ref": "#/components/examples/turtle-example" } } }, "application/sparql-results+xml": { "schema": { "type": "string" } }, "application/sparql-results+json": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string" } }, "application/rdf+json": { "schema": { "type": "string" } }, "text/csv": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } } } }, "g204NC": { "description": "The request was processed successfully, no content is returned." }, "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." }, "g403": { "description": "The current user is not authorized to access the given graph." } }, "securitySchemes": { "bearerAuth": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" } } }, "servers": [ { "description": "Generated server url", "url": "http://localhost:9091" } ], "openapi": "3.0.1", "paths": { "/api/explore/facets": { "get": { "summary": "List the properties of a class or query", "security": [ { "bearerAuth": [] } ], "operationId": "queryGet", "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" } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "description": "Single default graph", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "queryFragment", "description": "Query fragment for the WHERE clause (either queryFragment or classIri must be specified).", "required": false, "example": "{?resource a \u003chttp://example.com/MyClass\u003e}" }, { "schema": { "type": "string" }, "in": "query", "name": "classIri", "description": "IRI of the class the resource is an instance of (either queryFragment or classIri must be specified).", "required": false, "example": "http://example.com/MyClass" }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "incoming", "description": "Defines, if incoming or outgoing properties of are calculated. If \u0027true\u0027, the facets are calculated for incoming properties are returned", "required": false, "example": false }, { "schema": { "default": "resource", "type": "string" }, "in": "query", "name": "variableName", "description": "Used with query fragment: Defines the variable for which the facets are calculated.", "required": false, "example": "thing" }, { "schema": { "type": "string" }, "in": "query", "name": "sparqlQuery", "description": "sparqlQuery", "required": false, "example": "SELECT ?thing {?thing a \u003chttp://example.com/MyClass\u003e}" }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "langPrefences", "description": "Language preferences that override the system settings. Used for both shape and data", "required": false } ], "tags": [ "Facets" ] } }, "/api/statementmetadata/resource": { "get": { "security": [ { "bearerAuth": [] } ], "description": "Checks if the resource is annotated", "operationId": "isResourceAnnotated", "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "subject", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true } ], "tags": [ "Statement-Level Metadata" ] } }, "/api/statementmetadata/statement": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The statement to be searched for", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } }, "required": true }, "description": "Checks if the given statement is a annotated. HTTP POST is used, to enable safe RequestBody ", "operationId": "isStatementAnnotated", "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true } ], "tags": [ "Statement-Level Metadata" ] } }, "/graphs/graphs/{id}/read": { "head": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsReadDeprecated", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] }, "patch": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsReadDeprecated_5", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] }, "post": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsReadDeprecated_1", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] }, "options": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsReadDeprecated_4", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] }, "delete": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsReadDeprecated_3", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] }, "put": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsReadDeprecated_2", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] } }, "/proxy/{id}/update/manualedit": { "post": { "security": [ { "bearerAuth": [] } ], "operationId": "updateUrlEncodedPost", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "string" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "default": "", "minLength": 0, "type": "string", "maxLength": 1000000 }, "in": "query", "name": "inserts", "required": false }, { "schema": { "default": "", "minLength": 0, "type": "string", "maxLength": 1000000 }, "in": "query", "name": "deletes", "required": false }, { "schema": { "default": "", "minLength": 0, "type": "string", "maxLength": 1000000 }, "in": "query", "name": "queries", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "shape", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "primaryResource", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "comment", "required": false } ], "tags": [ "Manual Edit" ] }, "delete": { "security": [ { "bearerAuth": [] } ], "operationId": "deleteRequest", "responses": { "204": { "description": "default response" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "resource", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "comment", "required": false }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "includeAllStatementLvlMeta", "required": false } ], "tags": [ "Manual Edit" ] } }, "/api/prefixes": { "get": { "security": [ { "bearerAuth": [] } ], "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": "default response", "content": { "*/*": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } } } }, "tags": [ "Prefixes" ] } }, "/api/statementmetadata/connectableProperties": { "get": { "security": [ { "bearerAuth": [] } ], "description": "Fetches the properties that are enabled for ", "operationId": "getMetadataProperties", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConnectableProperties" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "required": true }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "langPref", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true } ], "tags": [ "Statement-Level Metadata" ] } }, "/graphs/importTree": { "get": { "security": [ { "bearerAuth": [] } ], "description": "The owl:import imports, determined by a breadth first graph traversal.", "operationId": "getImportTree", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportTree" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "graph", "required": true } ], "tags": [ "Accessible graphs" ] } }, "/api/statementmetadata/connectedStatementSubjectCand": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } }, "required": true }, "operationId": "getConnectedSubjectCandidate", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResource" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "searchTerm", "required": true }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "langPref", "required": false } ], "tags": [ "Statement-Level Metadata" ] } }, "/api/admin/currentQueries": { "get": { "security": [ { "bearerAuth": [] } ], "description": "Most recent queries.", "operationId": "getCurrentlyRunningQueries", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryExecutionStats" } } } } } }, "tags": [ "Admin QueryMonitor" ] } }, "/authorization/refresh": { "get": { "summary": "Authorization refresh", "security": [ { "bearerAuth": [] } ], "description": "Reloads the access conditions model following the internal configuration parameters.", "operationId": "authorizationGetRefresh", "responses": { "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." }, "204": { "description": "The access conditions were successfully reloaded." }, "403": { "description": "The user does not have permission to execute this action." } }, "tags": [ "Authorization Management API" ] } }, "/actuator/logger/{logger}": { "post": { "summary": "Change the configured logging level for the specified logger.", "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "configuredLevel" ], "properties": { "configuredLevel": { "description": "The explicit logging level to be configured.", "type": "string", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "OFF", "null" ] } } }, "examples": { "Example": { "value": "{\"configuredLevel\":\"TRACE\"}" } } } }, "required": true }, "description": "Change the configured logging level for the specified logger.", "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." } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "logger", "description": "The name of the logger to manage", "required": true } ], "tags": [ "Application Loggers" ] }, "get": { "summary": "Application loggers by name.", "security": [ { "bearerAuth": [] } ], "description": "Display the configured logging level for the specified logger.", "responses": { "200": { "description": "Successful response", "content": { "Example": { "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." } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "logger", "description": "The name of the logger to manage", "required": true } ], "tags": [ "Application Loggers" ] } }, "/api/queries/reports/performBulk": { "post": { "security": [ { "bearerAuth": [] } ], "operationId": "getBulkCsv", "responses": { "200": { "description": "default response" } }, "parameters": [ { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "queryIris", "description": "The identifier of the query", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "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" }, "in": "query", "name": "substitutions", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "example": { "placeholder2": "....", "placeholder": "substitution value" } }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "fileNames", "description": "The name of the download", "required": false } ], "tags": [ "Named Queries" ] }, "get": { "security": [ { "bearerAuth": [] } ], "operationId": "getBulkCsv_1", "responses": { "200": { "description": "default response" } }, "parameters": [ { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "queryIris", "description": "The identifier of the query", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "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" }, "in": "query", "name": "substitutions", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "example": { "placeholder2": "....", "placeholder": "substitution value" } }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "fileNames", "description": "The name of the download", "required": false } ], "tags": [ "Named Queries" ] } }, "/api/statementmetadata/connectableStatement": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } }, "required": true }, "operationId": "getConnectableStatements", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RichStatement" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true }, { "schema": { "format": "int64", "type": "integer" }, "in": "query", "name": "limit", "required": false }, { "schema": { "format": "int64", "type": "integer" }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "langPref", "required": false }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "inferPredicateFilter", "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 } ], "tags": [ "Statement-Level Metadata" ] } }, "/proxy/{id}/graph": { "head": { "summary": "SPARQL Graph Store HTTP HEAD", "security": [ { "bearerAuth": [] } ], "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", "responses": { "200": { "$ref": "#/components/responses/sgs200Head" }, "400": { "$ref": "#/components/responses/g400" }, "204": { "$ref": "#/components/responses/sgs204" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "503": { "$ref": "#/components/responses/g503" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "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, "example": "http://example.org" }, { "schema": { "type": "boolean" }, "in": "query", "name": "owlImportsResolution", "description": "Enable/disable OWL imports resolution for this query.", "required": false }, { "schema": { "format": "int64", "type": "integer" }, "in": "query", "name": "timeout", "description": "The maximal amount of time (in milliseconds) that a request should run until the execution is aborted.\n If none provided, the default timeout of the quad store applies.", "required": false }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "etag", "description": "If set to `true`, provide an ETag header in the response.\n The calculation of this value is time consuming.\n You should require it only if necessary.", "required": false } ], "tags": [ "Data Endpoints / SPARQL Graph Store" ] }, "post": { "summary": "SPARQL Graph Store HTTP POST", "security": [ { "bearerAuth": [] } ], "requestBody": { "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.", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "format": "binary", "type": "string" } } } } } }, "description": "Stores the given tuples in the underlying endpoint.\n If triples are provided, they are stored in the given graph.\n If a quad format is used, the graph URI be set as the target graph of the unnamed graph; all other quads will be stored as is.", "operationId": "sparqlGraphStorePostMultipartFormData", "responses": { "400": { "$ref": "#/components/responses/g400" }, "204": { "$ref": "#/components/responses/g204NC" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "415": { "$ref": "#/components/responses/sgs415" }, "503": { "$ref": "#/components/responses/sgs503" }, "409": { "$ref": "#/components/responses/sgs409" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "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, "example": "http://example.org" }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "replace", "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 } ], "tags": [ "Data Endpoints / SPARQL Graph Store" ] }, "get": { "summary": "SPARQL Graph Store HTTP GET", "security": [ { "bearerAuth": [] } ], "description": "A request that uses the HTTP GET method MUST retrieve an RDF payload that is a serialization of the named graph paired with the graph IRI in the Graph Store.", "operationId": "sparqlGraphStoreGet", "responses": { "200": { "$ref": "#/components/responses/sgs200Get" }, "400": { "$ref": "#/components/responses/g400" }, "204": { "$ref": "#/components/responses/sgs204" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "503": { "$ref": "#/components/responses/g503" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "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, "example": "http://example.org" }, { "schema": { "type": "boolean" }, "in": "query", "name": "owlImportsResolution", "description": "Enable/disable OWL imports resolution for this query.", "required": false }, { "schema": { "format": "int64", "type": "integer" }, "in": "query", "name": "timeout", "description": "The maximal amount of time (in milliseconds) that a request should run until the execution is aborted.\n If none provided, the default timeout of the quad store applies.", "required": false }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "etag", "description": "If set to `true`, provide an ETag header in the response.\n The calculation of this value is time consuming.\n You should require it only if necessary.", "required": false } ], "tags": [ "Data Endpoints / SPARQL Graph Store" ] }, "delete": { "summary": "SPARQL Graph Store HTTP DELETE", "security": [ { "bearerAuth": [] } ], "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", "responses": { "400": { "$ref": "#/components/responses/g400" }, "204": { "$ref": "#/components/responses/g204NC" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "503": { "$ref": "#/components/responses/g503" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "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, "example": "http://example.org" } ], "tags": [ "Data Endpoints / SPARQL Graph Store" ] }, "put": { "summary": "SPARQL Graph Store HTTP PUT", "security": [ { "bearerAuth": [] } ], "requestBody": { "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.", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "format": "binary", "type": "string" } } } } } }, "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", "responses": { "400": { "$ref": "#/components/responses/g400" }, "204": { "$ref": "#/components/responses/g204NC" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "415": { "$ref": "#/components/responses/sgs415" }, "503": { "$ref": "#/components/responses/sgs503" }, "409": { "$ref": "#/components/responses/sgs409" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "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, "example": "http://example.org" } ], "tags": [ "Data Endpoints / SPARQL Graph Store" ] } }, "/info": { "get": { "summary": "Shows arbitrary application.", "description": "Displays arbitrary application info, such as program version etc.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": "{\n \"name\": \"eccenca DataPlatform\",\n \"version\": \"v20.03-37-g6e8e94c83-dirty\"\n}" } } } }, "tags": [ "Application Health \u0026 Info (Legacy)" ] } }, "/proxy/{id}/sparql": { "get": { "summary": "SPARQL query via HTTP GET", "security": [ { "bearerAuth": [] } ], "description": "SPARQL query via HTTP GET and query parameters", "operationId": "sparqlQueryGet", "responses": { "200": { "$ref": "#/components/responses/sq200" }, "503": { "$ref": "#/components/responses/g503" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "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, "example": "CONSTRUCT ?class WHERE {?s a ?class}" }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "default-graph-uri", "description": "Zero or more default graph URIs", "required": false }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "named-graph-uri", "description": "Zero or more named graph URIs", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "owlImportsResolution", "description": "Enable/disable OWL imports resolution for this query", "required": false }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "base64encoded", "description": "If set to true, the query parameter is expected in base64 encoding", "required": false } ], "tags": [ "Data Endpoints / SPARQL Query" ] } }, "/userinfo": { "get": { "summary": "UserInfo GET", "security": [ { "bearerAuth": [] } ], "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": "https://ns.eccenca.com/USERNAME" } } } } }, "tags": [ "UserInfo API" ] } }, "/api/statementmetadata/resources": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The statement to be searched for", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } }, "required": true }, "description": "Fetches the list of rdf:Statements resources that contain the actual reification information", "operationId": "getReificationResources", "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatementLevelMetadata" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true } ], "tags": [ "Statement-Level Metadata" ] } }, "/graphs/{id}/write": { "get": { "summary": "Writable graphs", "security": [ { "bearerAuth": [] } ], "description": "A list of graph URIs the user is allowed to write.", "operationId": "graphsWriteGet", "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/json": { "example": [ "urn:writableGraphA", "urn:writableGraphB" ] } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "A specific SPARQL endpoint. Every endpoint is identified by an `endpointId` URI path parameter.", "required": true, "example": "default" }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "description": "A specific graph to check write access for, will return *true* if write is allowed, otherwise *false*", "required": false, "example": "http://example.org/graphA" } ], "tags": [ "Accessible graphs" ] } }, "/api/resources/shapedSave": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceChangeSet" } } }, "required": true }, "description": "Saves a changed resource and allows adding the resource as a reified statement.", "operationId": "saveShapedResource", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SaveReport" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true } ], "tags": [ "Resources" ] } }, "/proxy/{id}": { "get": { "summary": "Returns metadata of the endpoint.", "security": [ { "bearerAuth": [] } ], "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", "responses": { "200": { "description": "Successful response.", "content": { "application/json": {} } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "tags": [ "Data Endpoints" ] } }, "/proxy/{id}/update/manualedit/analyse": { "get": { "security": [ { "bearerAuth": [] } ], "operationId": "deleteRequestAnalysis", "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GraphCount" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "resource", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "required": true } ], "tags": [ "Manual Edit" ] } }, "/api/statementmetadata/connectableStatementCount": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } }, "required": true }, "operationId": "getConnectableStatementsCount", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "format": "int64", "type": "integer" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true }, { "schema": { "format": "int64", "type": "integer" }, "in": "query", "name": "limit", "required": false }, { "schema": { "format": "int64", "type": "integer" }, "in": "query", "name": "offset", "required": false }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "inferPredicateFilter", "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 } ], "tags": [ "Statement-Level Metadata" ] } }, "/proxy/{id}/update": { "post": { "summary": "The update operation is used to send a [SPARQL 1.1 update](https://www.w3.org/TR/sparql11-update/) request.", "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "SPARQL update query", "content": { "application/sparql-update": { "schema": { "type": "string" } } }, "required": true }, "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", "responses": { "202": { "description": "The update query was processed successfully, however not fully. This typically means that further tasks still have to be post-processed." }, "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)." }, "204": { "$ref": "#/components/responses/g204NC" }, "503": { "$ref": "#/components/responses/g503" }, "409": { "description": "Transaction aborted due to deadlock. Retrying should solve the problem." } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "using-graph-uri", "description": "default graph URI, may include zero or more.", "required": false }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "using-named-graph-uri", "description": "URL-encoded named graph URI, may include zero or more.", "required": false }, { "schema": { "format": "int64", "type": "integer" }, "in": "query", "name": "timeout", "required": false }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "base64encoded", "description": "Is the update param Base64-encoded?", "required": false } ], "tags": [ "Data Endpoints" ] } }, "/api/admin/backup/zip": { "get": { "security": [ { "bearerAuth": [] } ], "description": "Creates a full (or partial, see the graphsRequested Parameter) backup of the knowledge graph,", "operationId": "backupGraphs", "responses": { "200": { "description": "default response" } }, "parameters": [ { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "graphsRequested", "description": "If present, only the list of graphs given here, is included in the backup.", "required": false } ], "tags": [ "Admin Backup/Restore/Bootstrap" ] } }, "/graphs/list": { "get": { "summary": "User graphs list", "security": [ { "bearerAuth": [] } ], "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", "fromIri": false, "title": "Some title", "lang": "en", "when": "00:00:99.9", "graph": "https://someGraph/" } }, { "iri": "http://someOtherIri", "label": { "iri": "http://someOtherIri", "fromIri": false, "title": "Some other title", "lang": "en", "when": "00:00:99.9", "graph": "https://someOtherGraph/" } } ] } } }, "403": { "$ref": "#/components/responses/g403" } }, "parameters": [ { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "owlImportsResolution", "description": "Enable/disable OWL imports resolution.", "required": false } ], "tags": [ "Accessible graphs" ] } }, "/actions/{id}": { "get": { "summary": "Allowed actions", "security": [ { "bearerAuth": [] } ], "deprecated": true, "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": "actionsGet", "responses": { "200": { "description": "The response was successfully executed.", "content": { "application/json": {} } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "A specific SPARQL endpoint. Every endpoint is identified by an `endpointId` URI path parameter.", "required": true, "example": "default" }, { "schema": { "type": "string" }, "in": "query", "name": "actionUri", "description": "Check for a specific action, will return *true* if the user is allowed to perform the action, otherwise *false*.", "required": false, "example": "http://example.org/actionA" } ], "tags": [ "Actions" ] } }, "/api/shapes/cacheInvalidate": { "get": { "security": [ { "bearerAuth": [] } ], "description": "Invalidates the shapes cache", "operationId": "invalidateCache", "responses": { "200": { "description": "default response" } }, "tags": [ "Shapes" ] } }, "/proxy/{id}/resource": { "head": { "summary": "Equivalent to a GET request, but without a response body.", "security": [ { "bearerAuth": [] } ], "description": "Equivalent to a GET request, but without a response body.", "operationId": "resourceStoreHead", "responses": { "200": { "description": "The request was processed successfully." }, "400": { "$ref": "#/components/responses/g400" }, "204": { "$ref": "#/components/responses/g204" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "503": { "$ref": "#/components/responses/g503" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "A valid resource URI", "required": true, "example": "http://example.org/person/Mark_Twain" }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "required": true, "example": "http://example.org/graph" } ], "tags": [ "Data Endpoints / Resource store" ] }, "post": { "summary": "Adds the given statements to the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the given resource in the supplied graph.", "security": [ { "bearerAuth": [] } ], "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", "responses": { "204": { "$ref": "#/components/responses/g204NC" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "A valid resource URI", "required": true, "example": "http://example.org/person/Mark_Twain" }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "required": true, "example": "http://example.org/graph" }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "replace", "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 } ], "tags": [ "Data Endpoints / Resource store" ] }, "get": { "summary": "Returns the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the requested resource in the given graph.", "security": [ { "bearerAuth": [] } ], "description": "Returns the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the requested resource in the given graph.", "operationId": "resourceStoreGet", "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/ld+json": { "schema": { "type": "string" }, "example": "N/A" }, "application/rdf+xml": { "schema": { "type": "string" }, "example": "N/A" }, "text/turtle": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" }, "example": "N/A" } } }, "400": { "$ref": "#/components/responses/g400" }, "204": { "$ref": "#/components/responses/g204" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "503": { "$ref": "#/components/responses/g503" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "A valid resource URI", "required": true, "example": "http://example.org/person/Mark_Twain" }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "required": true, "example": "http://example.org/graph" } ], "tags": [ "Data Endpoints / Resource store" ] }, "delete": { "summary": "Deletes the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the provided resource contained by the provided graph.", "security": [ { "bearerAuth": [] } ], "description": "Deletes the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the provided resource contained by the provided graph.", "operationId": "resourceStoreDelete", "responses": { "204": { "$ref": "#/components/responses/g204" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "A valid resource URI", "required": true, "example": "http://example.org/person/Mark_Twain" }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "required": true, "example": "http://example.org/graph" } ], "tags": [ "Data Endpoints / Resource store" ] }, "put": { "summary": "Replaces the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the given resource contained in the supplied graph.", "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/ld+json": { "schema": { "type": "string" } }, "application/rdf+xml": { "schema": { "type": "string" } }, "text/turtle": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" }, "example": "\u003curn:Mark_Twain\u003e \u003curn:author\u003e \u003curn:Huckleberry_Finn\u003e ." } } }, "description": "Replaces the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the given resource contained in the supplied graph.", "operationId": "resourceStorePut", "responses": { "400": { "$ref": "#/components/responses/g400" }, "204": { "$ref": "#/components/responses/g204NC" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "503": { "$ref": "#/components/responses/g503" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "A valid resource URI", "required": true, "example": "http://example.org/person/Mark_Twain" }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "description": "The URI of the [graph](https://www.w3.org/TR/sparql11-http-rdf-update/#indirect-graph-identification) containing the resource.", "required": true, "example": "http://example.org/graph" } ], "tags": [ "Data Endpoints / Resource store" ] } }, "/api/resources/list": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResourceParams" } } }, "required": true }, "operationId": "listResources", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResource" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true } ], "tags": [ "Resources" ] } }, "/api/shapes/applicable": { "get": { "security": [ { "bearerAuth": [] } ], "description": "Given targets, what shapes could be applied?", "operationId": "listShapes", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NodeShapeListEntry" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "targetClass", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "subjectOfProperty", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "objectOfProperty", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "nodeTargetIri", "required": false } ], "tags": [ "Shapes" ] } }, "/health": { "get": { "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\"}" } } } }, "tags": [ "Application Health \u0026 Info (Legacy)" ] } }, "/api/statementmetadata/disconnect": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The statements to be disconnected from the resource", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } } }, "required": true }, "operationId": "disconnect", "responses": { "200": { "description": "default response" } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "the resource to be connected to the statements", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true } ], "tags": [ "Statement-Level Metadata" ] } }, "/api/custom/{slug}": { "post": { "security": [ { "bearerAuth": [] } ], "description": "Executes the query and returns a JSON result by evaluating a Jinjava Template", "operationId": "executePythonConversion", "responses": { "200": { "description": "A JSON response of the Framed Construct Result", "content": { "application/json": {} } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "slug", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "substitutions", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "example": { "placeholder2": "....", "placeholder": "substitution value" } } ], "tags": [ "Named Queries" ] }, "get": { "security": [ { "bearerAuth": [] } ], "description": "Executes the query and returns a JSON result by evaluating a Jinjava Template", "operationId": "executePythonConversion_1", "responses": { "200": { "description": "A JSON response of the Framed Construct Result", "content": { "application/json": {} } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "slug", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "substitutions", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "example": { "placeholder2": "....", "placeholder": "substitution value" } } ], "tags": [ "Named Queries" ] } }, "/api/queries/reports": { "get": { "security": [ { "bearerAuth": [] } ], "description": "Lists all executable queries and shows their potential parameters", "operationId": "getList", "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportList" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "vocabCatalog", "description": "The uri of the query catalog, in case not all queries shall be listed.", "required": false, "example": "https://ns.eccenca.com/data/queries/" } ], "tags": [ "Named Queries" ] } }, "/actuator/health": { "get": { "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\"}" } } } }, "tags": [ "Application Health \u0026 Info" ] } }, "/api/shapes/list": { "get": { "security": [ { "bearerAuth": [] } ], "description": "Returns NodeShape objects for the given IRIs", "operationId": "loadNodeShape", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NodeShape" } } } } } }, "parameters": [ { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "nodeShapes", "required": true } ], "tags": [ "Shapes" ] } }, "/authorization/conditions": { "post": { "summary": "Creates access conditions.", "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "Access condition to store.", "content": { "application/ld+json": { "schema": { "type": "string" }, "example": "N/A" }, "application/rdf+xml": { "schema": { "type": "string" }, "example": "N/A" }, "text/turtle": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" }, "example": "N/A" } }, "required": true }, "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", "responses": { "201": { "description": "Successful access condition creation. The response body contains the newly replaced access condition.", "content": { "application/ld+json": { "example": "N/A" }, "application/rdf+xml": { "example": "N/A" }, "text/turtle": {}, "application/n-triples": { "example": "N/A" } } }, "422": { "description": "The access condition is not valid." }, "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." } }, "tags": [ "Authorization Management API" ] }, "get": { "summary": "Retrieve all access conditions manageable by the user or a specific one (see the `resource` parameter description).", "security": [ { "bearerAuth": [] } ], "operationId": "getAccessConditions", "responses": { "200": { "description": "Successful access condition replacement. The response body contains the newly replaced access condition.", "content": { "application/ld+json": { "example": "N/A" }, "application/rdf+xml": { "example": "N/A" }, "text/turtle": {}, "application/n-triples": { "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." } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "Retrieve only the access condition identified by the given IRI.", "required": false, "example": "https://ns.eccenca.com/PublicAccessCondition" } ], "tags": [ "Authorization Management API" ] }, "delete": { "summary": "Delete an existing access condition with the given name.", "security": [ { "bearerAuth": [] } ], "description": "Delete an existing access condition with the given name.", "operationId": "deleteAccessCondition", "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." } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "The IRI of the access condition to be deleted.", "required": true, "example": "https://ns.eccenca.com/PublicAccessCondition" } ], "tags": [ "Authorization Management API" ] }, "put": { "summary": "Updates access conditions.", "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The new access condition.", "content": { "application/ld+json": { "schema": { "type": "string" }, "example": "N/A" }, "application/rdf+xml": { "schema": { "type": "string" }, "example": "N/A" }, "text/turtle": { "schema": { "type": "string" } }, "application/n-triples": { "schema": { "type": "string" }, "example": "N/A" } }, "required": true }, "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", "responses": { "200": { "description": "Successful access condition replacement. The response body contains the newly replaced access condition.", "content": { "application/ld+json": { "example": "N/A" }, "application/rdf+xml": { "example": "N/A" }, "text/turtle": {}, "application/n-triples": { "example": "N/A" } } }, "422": { "description": "The access condition was not stored because it is not valid." }, "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." } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "The IRI of the access condition to replace.", "required": true, "example": "https://ns.eccenca.com/PublicAccessCondition" } ], "tags": [ "Authorization Management API" ] } }, "/api/resources/usage": { "get": { "security": [ { "bearerAuth": [] } ], "operationId": "getResoureUsage", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResourceUsage" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "iri", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true } ], "tags": [ "Resources" ] } }, "/graphs/imports": { "get": { "security": [ { "bearerAuth": [] } ], "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", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "parameters": [ { "schema": { "default": true, "type": "boolean" }, "in": "query", "name": "owlImportsResolution", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "required": true } ], "tags": [ "Accessible graphs" ] } }, "/graphs/graphs/{id}/write": { "head": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsWriteDeprecated", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] }, "patch": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsWriteDeprecated_5", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] }, "post": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsWriteDeprecated_1", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] }, "options": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsWriteDeprecated_4", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] }, "delete": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsWriteDeprecated_3", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] }, "put": { "security": [ { "bearerAuth": [] } ], "deprecated": true, "operationId": "graphsWriteDeprecated_2", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "object" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "required": false } ], "tags": [ "Accessible graphs" ] } }, "/actuator/loggers": { "get": { "summary": "Displays all accepted logging levels and loggers.", "security": [ { "bearerAuth": [] } ], "description": "Displays all accepted logging levels as well as the currently configured loggers.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "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." } }, "tags": [ "Application Loggers" ] } }, "/api/statementmetadata/connectableStatementSubjectCand": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } }, "required": true }, "operationId": "getConnectableSubjectCandidate", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResource" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "searchTerm", "required": true }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "langPref", "required": false } ], "tags": [ "Statement-Level Metadata" ] } }, "/authorization/conditions/framed": { "post": { "summary": "Access conditions management with JSON-LD frame support.", "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/ld-frame+json": { "schema": { "type": "string" } } }, "required": true }, "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", "responses": { "200": { "description": "Successful retrieval of the requested access condition(s).", "content": { "application/ld+json": {} } }, "400": { "description": "The given JSON-LD frame is malformed." }, "204": { "description": "The access conditions 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." } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "Retrieve only the access condition identified by the given IRI.", "required": false, "example": "https://ns.eccenca.com/PublicAccessCondition" } ], "tags": [ "Authorization Management API" ] } }, "/proxy/{id}/sparql/framed": { "post": { "summary": "Framed SPARQL CONSTRUCT query via HTTP POST", "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SparqlQueryFramedSchema" } } }, "required": true }, "description": "Framed SPARQL CONSTRUCT query via HTTP POST with URL-encoded, ampersand-separated query parameters in the body.", "operationId": "sparqlQueryPostFramed", "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": {} } }, "400": { "$ref": "#/components/responses/g400" }, "503": { "$ref": "#/components/responses/g503" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true } ], "tags": [ "Data Endpoints / SPARQL Query" ] } }, "/graphs/{id}/read": { "get": { "summary": "Readable graphs", "security": [ { "bearerAuth": [] } ], "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", "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/json": { "schema": { "type": "string" }, "example": [ "urn:readableGraphA", "urn:readableGraphB", "urn:writableGraphC" ] } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "A specific SPARQL endpoint. Every endpoint is identified by an `endpointId` URI path parameter.", "required": true, "example": "default" }, { "schema": { "type": "string" }, "in": "query", "name": "graphUri", "description": "A specific graph to check read access for, will return *true* if read is allowed, otherwise *false*", "required": false, "example": "http://example.org/graphA" } ], "tags": [ "Accessible graphs" ] } }, "/api/admin/drop-all-graphs": { "post": { "security": [ { "bearerAuth": [] } ], "description": "Drops all graphs.", "operationId": "dropAllGraphs", "responses": { "200": { "description": "Graphs successfully dropped." } }, "tags": [ "Admin Backup/Restore/Bootstrap" ] } }, "/api/auth/actions": { "get": { "summary": "Allowed actions", "security": [ { "bearerAuth": [] } ], "description": "A list of action URIs the user is allowed to perform ", "operationId": "actionsGet_1", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "tags": [ "Actions" ] } }, "/api/queries/reports/perform": { "post": { "security": [ { "bearerAuth": [] } ], "description": "Executes the query and returns a CSV result", "operationId": "getCsv", "responses": { "200": { "description": "A csv representation of the query result", "content": { "text/csv": {} } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "queryIri", "description": "The identifier of the query", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "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" }, "in": "query", "name": "substitutions", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "example": { "placeholder2": "....", "placeholder": "substitution value" } }, { "schema": { "default": "report", "type": "string" }, "in": "query", "name": "fileName", "description": "The name of the download", "required": false } ], "tags": [ "Named Queries" ] }, "get": { "security": [ { "bearerAuth": [] } ], "description": "Executes the query and returns a CSV result", "operationId": "getCsv_1", "responses": { "200": { "description": "A csv representation of the query result", "content": { "text/csv": {} } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "queryIri", "description": "The identifier of the query", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "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" }, "in": "query", "name": "substitutions", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "example": { "placeholder2": "....", "placeholder": "substitution value" } }, { "schema": { "default": "report", "type": "string" }, "in": "query", "name": "fileName", "description": "The name of the download", "required": false } ], "tags": [ "Named Queries" ] } }, "/api/statementmetadata/applicableshapes": { "get": { "security": [ { "bearerAuth": [] } ], "description": "Fetches the list of suitable Shapes for a reification", "operationId": "getApplicableNodeShapes", "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NodeShapeListEntry" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "propertyShapeIri", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true } ], "tags": [ "Statement-Level Metadata" ] } }, "/api/explore/titles": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The list of iris to resolve", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "description": "@Beta, this api is subject to change without further notice \n. Finds a short-form description for a multiple IRIs.", "operationId": "getTitle_1", "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": { "additionalProperties": { "$ref": "#/components/schemas/TitleResolve" }, "type": "object" } } } } }, "parameters": [ { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "langPrefs", "description": "An ordered List of language preferences", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "description": "The context/graph, in which the lookup should take place", "required": false } ], "tags": [ "Label Resolution" ] } }, "/api/prefixesDetails": { "get": { "security": [ { "bearerAuth": [] } ], "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": "default response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Prefixes" } } } } }, "tags": [ "Prefixes" ] } }, "/api/vocabs": { "get": { "summary": "List vocabularies", "security": [ { "bearerAuth": [] } ], "description": "Lists all Vocabularies of the default endpoint.", "operationId": "vocabsGet", "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/json": { "example": "{\n \"totalCount\": \"1\",\n \"vocabularies\": [\n {\"iri\": \"http://exmaple.com/myvocab\", ....}\n\n ]\n}" } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "vocabGraph", "description": "The Vocabulary Catalog to query", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "searchTerm", "description": "A full text search term", "required": false }, { "schema": { "format": "int64", "type": "integer" }, "in": "query", "name": "limit", "description": "Max number of results", "required": false }, { "schema": { "format": "int64", "type": "integer" }, "in": "query", "name": "offset", "description": "skip the first results", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order-by", "description": "Either ASC ord DESC", "required": false }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "langPrefences", "required": false } ], "tags": [ "Vocabulary Management" ] } }, "/api/explore/title": { "get": { "security": [ { "bearerAuth": [] } ], "description": "This api is subject to change without further notice \n. Finds a short-form description for a single IRI.", "operationId": "getTitle", "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TitleResolve" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "The iri to resolve", "required": true }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "langPrefs", "description": "An ordered List of language preferences", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "description": "The context/graph, in which the lookup should take place", "required": false } ], "tags": [ "Label Resolution" ] } }, "/graphs/detailed": { "get": { "summary": "User graphs list with details", "security": [ { "bearerAuth": [] } ], "description": "A list of graph URIs the user is allowed to read, with details (classes counts, instances counts, etc.).", "operationId": "graphsListDetailed", "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" } }, "parameters": [ { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "owlImportsResolution", "description": "Enable/disable OWL imports resolution.", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "graphIri", "description": "The details fo the graph to fetch", "required": true } ], "tags": [ "Accessible graphs" ] } }, "/api/statementmetadata/connect": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The statements to be connected to the resource", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } } }, "required": true }, "operationId": "connect", "responses": { "200": { "description": "default response" } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "description": "the resource to be connected to the statements", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true } ], "tags": [ "Statement-Level Metadata" ] } }, "/actuator/info": { "get": { "summary": "Shows arbitrary application.", "description": "Displays arbitrary application info, such as program version etc.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": "{\n \"name\": \"eccenca DataPlatform\",\n \"version\": \"v20.03-37-g6e8e94c83-dirty\"\n}" } } } }, "tags": [ "Application Health \u0026 Info" ] } }, "/api/admin/showcase": { "post": { "security": [ { "bearerAuth": [] } ], "description": "Insert the showcase data", "operationId": "showcase", "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "parameters": [ { "schema": { "default": 10, "format": "int32", "type": "integer" }, "in": "query", "name": "scaleFactor", "required": false } ], "tags": [ "Admin Backup/Restore/Bootstrap" ] } }, "/proxy/{id}/resource/framed": { "post": { "summary": "Returns the [Concise Bound Description](https://www.w3.org/Submission/CBD/) of the requested resource in the given graph.", "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ResourceStoreFramedSchema" } } } }, "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", "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/ld+json": {} } }, "400": { "$ref": "#/components/responses/g400" }, "204": { "$ref": "#/components/responses/g204" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "503": { "$ref": "#/components/responses/g503" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true } ], "tags": [ "Data Endpoints / Resource store" ] } }, "/api/admin/bootstrap": { "post": { "security": [ { "bearerAuth": [] } ], "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": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "tags": [ "Admin Backup/Restore/Bootstrap" ] } }, "/api/statementmetadata/connectedStatement": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } }, "required": true }, "operationId": "getConnectedStatements", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RichStatement" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true }, { "schema": { "default": 100, "format": "int64", "type": "integer" }, "in": "query", "name": "limit", "required": false }, { "schema": { "format": "int64", "type": "integer" }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "langPref", "required": false }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "inferPredicateFilter", "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 } ], "tags": [ "Statement-Level Metadata" ] } }, "/api/statementmetadata/connectedStatementCount": { "post": { "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "The filters to be applied on the statement list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementFilter" } } }, "required": true }, "operationId": "getConnectedStatementsCount", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "format": "int64", "type": "integer" } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resource", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": true }, { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "inferPredicateFilter", "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 } ], "tags": [ "Statement-Level Metadata" ] } }, "/proxy/{id}/vowl": { "get": { "summary": "Visualization data for OWL data.", "security": [ { "bearerAuth": [] } ], "description": "This endpoint provides [WebVOWL](http://vowl.visualdataweb.org/webvowl.html) visualization data for OWL data in a specific graph.", "operationId": "vowlGet", "responses": { "200": { "description": "The request was processed successfully.", "content": { "application/vowl+json": {} } }, "400": { "$ref": "#/components/responses/g400" }, "403": { "$ref": "#/components/responses/g403" }, "404": { "$ref": "#/components/responses/g404" }, "503": { "$ref": "#/components/responses/g503" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "description": "Endpoint ID", "required": true, "example": "default" }, { "schema": { "type": "string" }, "in": "query", "name": "graph", "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, "example": "http://example.org" } ], "tags": [ "Data Endpoints" ] } }, "/api/queries/jsonld/perform": { "post": { "security": [ { "bearerAuth": [] } ], "description": "Executes the query and returns a CSV result", "operationId": "generateJsonLd", "responses": { "200": { "description": "A JSON response of the Framed Construct Result", "content": { "application/json": {} } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "queryIri", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "substitutions", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "example": { "placeholder2": "....", "placeholder": "substitution value" } } ], "tags": [ "Named Queries" ] }, "get": { "security": [ { "bearerAuth": [] } ], "description": "Executes the query and returns a CSV result", "operationId": "generateJsonLd_1", "responses": { "200": { "description": "A JSON response of the Framed Construct Result", "content": { "application/json": {} } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "queryIri", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "substitutions", "description": "A json encoded map of placeholder substitutions. Each variable of the query needs to be set.", "required": false, "example": { "placeholder2": "....", "placeholder": "substitution value" } } ], "tags": [ "Named Queries" ] } }, "/api/resources/shaped": { "post": { "security": [ { "bearerAuth": [] } ], "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", "responses": { "200": { "description": "default response", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceView" } } } } } }, "parameters": [ { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "resources", "description": "The list of resources to be shaped.", "required": false }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "nodeShapeIris", "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" } }, "in": "query", "name": "langPrefences", "description": "Language preferences that override the system settings. Used for both shape and data", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "contextGraph", "required": false } ], "tags": [ "Resources" ] } } }, "info": { "contact": { "url": "https://eccenca.com/", "email": "info@eccenca.com" }, "description": "eccenca DataPlatform Linked Data API", "title": "eccenca DataPlatform API", "version": "v21.04" }, "tags": [ { "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." }, { "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": "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": "Prefixes", "description": "Manages prefixes for shortening Resource-IRIs." }, { "name": "Statement-Level Metadata", "description": "Provides methods for listing, exploring and managing statement-level metadata." }, { "name": "Authorization Management API", "description": "API for authorization management. Access conditions can be managed using the provided methods. The requesting user must have the urn:elds-backend-actions-auth-access-control action granted to be able to use this API. Root users can manage any access condition." }, { "name": "Facets", "description": "Facets query" }, { "name": "UserInfo API", "description": "Returns user information" }, { "name": "Shapes", "description": "Manages shapes and controls the interaction of shapes with the data" }, { "name": "Actions", "description": "Get a list of action URIs the requesting user is allowed to perform." }, { "name": "Label Resolution", "description": "Resolves a iri to a short form label. If none can be found in the data, the iri itself is used to create one." }, { "name": "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": "Admin QueryMonitor", "description": "Allows monitoring of currently running \u0026 recently finished queries" }, { "name": "Named Queries", "description": "Allows the listing and execution of SELECT queries via their identifiers.Provides information about the required parameters" }, { "name": "Accessible graphs", "description": "Get a list of graph URIs the requesting user is allowed to read or write." }, { "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": "Data Endpoints", "description": "A collection of provided semantic data endpoints. Each endpoint is equipped with a set of APIs." }, { "name": "Application Health \u0026 Info (Legacy)", "description": "Provides application runtime information." }, { "name": "Application Health \u0026 Info", "description": "Provides application runtime information." }, { "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)." } ] }