{ "openapi": "3.0.1", "info": { "title": "Catena-X Knowledge Agents SPARQL Endpoint Specification", "description": "# Usage\n\nThis endpoint is designed after [W3C SparQL 1.1](https://www.w3.org/TR/sparql11-protocol/)\n\nIt is used in three places:\n- As the consumer-oriented entrypoint of a Matchmaking Agent into the dataspace\n- As the provider-oriented looking entrypoint of a Binding Agent to a backend system\n- As the \"transfer\" protocol between the transfer proxies as built by the EDC infrastructure\n\n### Examples\n\n1. Invoke a Parameterized Skill\n\n```\nPREFIX l0: \nPREFIX cis: \nSELECT ?event ?eventName ?culturalProperty ?culturalPropertyLabel\nWHERE{\n ?event cis:involvesCulturalEntity ?culturalProperty ;\n l0:name ?eventName .\n ?culturalProperty rdfs:label ?culturalPropertyLabel\n}\n```\n\n2. Invoke a Dataspace Query\n\n```\nPREFIX arco-catalogue: \nPREFIX roapit: \nSELECT *\nWHERE{\n ?entity arco-catalogue:hasCatalogueRecordVersion ?record . \n ?record arco-catalogue:hasCatalogueRecordVersionRiT ?rit . \n ?rit roapit:withRole ?role ;\n roapit:isRoleInTimeOf ?agent\n}\n\n3. Sub-Skill of 2. that is transferred to the Binding Agent\n\n```\nPREFIX arco-catalogue: \nPREFIX roapit: \nSELECT *\nWHERE{\n ?entity arco-catalogue:hasCatalogueRecordVersion ?record . \n ?record arco-catalogue:hasCatalogueRecordVersionRiT ?rit . \n ?rit roapit:withRole ?role ;\n roapit:isRoleInTimeOf ?agent\n}\n\n```\n", "termsOfService": "http://catenax.io", "contact": { "email": "info@catenax.io" }, "license": { "name": "Eclipse Public License", "url": "https://www.eclipse.org/legal/epl-2.0/" }, "version": "1.9.5" }, "servers": [ { "url": "https://knowledge.dev.demo.catena-x.net/conforming-agent/bind", "description": "Development Conforming Agent for KA-BIND Profile" }, { "url": "https://knowledge.dev.demo.catena-x.net/conforming-agent/match", "description": "Development Conforming Agent for KA-MATCH Profile" }, { "url": "https://knowledge.dev.demo.catena-x.net/conforming-agent/transfer", "description": "Development Conforming Agent for KA-TRANSFER Profile" }, { "url": "https://knowledge.dev.demo.catena-x.net/tiera-remoting-agent/rdf4j-server/repositories/prognosis", "description": "Development Remoting Agent Prognosis Example" }, { "url": "https://knowledge.dev.demo.catena-x.net/tiera-remoting-agent/rdf4j-server/repositories/rul", "description": "Development Remoting Agent Remaining Useful Life Example" }, { "url": "https://knowledge.dev.demo.catena-x.net/tiera-remoting-agent/rdf4j-server/repositories/health", "description": "Development Remoting Agent Health Indicator Example" }, { "url": "https://knowledge.dev.demo.catena-x.net/oem-provider-agent/sparql", "description": "Development Provisioning Agent Endpoint 1" }, { "url": "https://knowledge.dev.demo.catena-x.net/oem-provider-agent2/sparql", "description": "Development Provisioning Agent Endpoint 2" }, { "url": "https://knowledge.dev.demo.catena-x.net/oem-provider-agent3/sparql", "description": "Development Provisioning Agent Endpoint 3" }, { "url": "https://knowledge.dev.demo.catena-x.net/oem-provider-agent4/sparql", "description": "Development Provisioning Agent Endpoint 4" }, { "url": "https://knowledge.dev.demo.catena-x.net/oem-provider-agent5/sparql", "description": "Development Provisioning Agent Endpoint 5" }, { "url": "https://knowledge.dev.demo.catena-x.net/tiera-edc-data/BPNL00000003CPIY/api/agent", "description": "Development Matchmaking Agent" } ], "tags": [ { "name": "agent", "description": "Perform a SPARQL query against the dataspace" } ], "paths": { "/": { "get": { "tags": [ "agent" ], "summary": "Invoke a Skill or Query (Simple)", "operationId": "getAgent", "parameters": [ { "name": "asset", "in": "query", "description": "The Target Asset of the Query (targets the complete dataspace if empty)", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "LifetimeSkill": { "$ref": "#/components/examples/LifetimeSkill" }, "NullSkill": { "$ref": "#/components/examples/NullSkill" }, "DataspaceSkill": { "$ref": "#/components/examples/DataspaceSkill" } } }, { "name": "runMode", "in": "query", "description": "Determines the preferred execution location which may be \"consumer\" (in the computing environment of the endpoint agent), \"provider\" (in the computing environment of the remote agent providing the targetted asset) or \"all\" (the agent will choose the best computing environment based on contracts and policies, this is the default mode).", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "consumer": { "$ref": "#/components/examples/RunModeConsumer" }, "provider": { "$ref": "#/components/examples/RunModeProvider" }, "all": { "$ref": "#/components/examples/RunModeAll" } } }, { "name": "queryLn", "in": "query", "description": "Determines the query language. Currently only \"SPARQL\" is supported.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "sparql": { "$ref": "#/components/examples/QuerySparql" } } }, { "name": "query", "in": "query", "description": "The SPARQL query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "Null": { "$ref": "#/components/examples/NullText" }, "Dataspace": { "$ref": "#/components/examples/Dataspace" } } }, { "name": "(vin", "in": "query", "description": "A sample bound parameter 'vin' which opens a new input tuple", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "Vehicle1": { "$ref": "#/components/examples/Vehicle1" }, "NoVehicle": { "$ref": "#/components/examples/NoVehicle" } } }, { "name": "troubleCode", "in": "query", "description": "A sample multi-bound parameter 'troubleCode' which closes the tuple", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "TroubleCodeClose": { "$ref": "#/components/examples/TroubleCodeClose" }, "NoTroubleCode": { "$ref": "#/components/examples/NoTroubleCode" } } } ], "responses": { "200": { "description": "The SparQL query has been processed successfully.", "content": { "application/sparql-results+json": { "schema": { "type": "object" }, "example": { "head": { "vars": [ "connector", "asset", "name", "description", "type", "version", "contentType", "isDefinedBy", "shape" ] }, "results": { "bindings": [ { "connector": { "type": "uri", "value": "edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN" }, "asset": { "type": "uri", "value": "GraphAsset?oem=Quality" }, "name": { "type": "literal", "value": "Quality Data." }, "description": { "type": "literal", "value": "A graph asset/offering mounting Quality data." }, "type": { "type": "uri,", "value": "https://w3id.org/catenax/ontology/common#GraphAsset" }, "version": { "type": "literal,", "value": "v0.7.2" }, "contentType": { "type": "literal,", "value": "application/json, application/xml" }, "isDefinedBy": { "type": "literal,", "value": "" }, "shape": { "type": "literal,", "value": "@prefix : ." } } ] } } }, "application/sparql-results+xml": { "schema": { "$ref": "#/components/schemas/XmlResultset" }, "example": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN\n \n \n GraphAsset?oem=Quality\n \n \n Quality Data.\n \n \n A graph asset/offering mounting Quality data.\n \n \n https://w3id.org/catenax/ontology/common#GraphAsset\n \n \n v0.7.2\n \n \n application/json, application/xml\n \n \n <https://w3id.org/catenax/ontology/reliability>\n \n \n @prefix : <GraphAsset?oem=Quality#> .\n \n \n \n" }, "text/csv": { "schema": { "type": "string", "example": "\"subject\",\"predicate\",\"object\"\n\"foo\",\"meets\",\"bar\"\n\"one\",\"meets\",\"two\"" } }, "text/tab-separated-values": { "schema": { "type": "string", "example": "?subject ?predicate ?object" } }, "application/x-binary-rdf-results-table": { "schema": { "type": "string", "format": "binary" } } } }, "203": { "description": "The SparQL query has been processed successfully but warnings did occur.", "headers": { "cx_warnings": { "description": "A data structure listing problems when processing the query.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CxWarning" } } } }, "content": { "application/sparql-results+json": { "schema": { "type": "object" }, "example": { "head": { "vars": [ "connector", "asset", "name", "description", "type", "version", "contentType", "isDefinedBy", "shape" ] }, "results": { "bindings": [ { "connector": { "type": "uri", "value": "edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN" }, "asset": { "type": "uri", "value": "GraphAsset?oem=Quality" }, "name": { "type": "literal", "value": "Quality Data." }, "description": { "type": "literal", "value": "A graph asset/offering mounting Quality data." }, "type": { "type": "uri,", "value": "https://w3id.org/catenax/ontology/common#GraphAsset" }, "version": { "type": "literal,", "value": "v0.7.2" }, "contentType": { "type": "literal,", "value": "application/json, application/xml" }, "isDefinedBy": { "type": "literal,", "value": "" }, "shape": { "type": "literal,", "value": "@prefix : ." } } ] } } }, "application/sparql-results+xml": { "schema": { "$ref": "#/components/schemas/XmlResultset" }, "example": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN\n \n \n GraphAsset?oem=Quality\n \n \n Quality Data.\n \n \n A graph asset/offering mounting Quality data.\n \n \n https://w3id.org/catenax/ontology/common#GraphAsset\n \n \n v0.7.2\n \n \n application/json, application/xml\n \n \n <https://w3id.org/catenax/ontology/reliability>\n \n \n @prefix : <GraphAsset?oem=Quality#> .\n \n \n \n" }, "text/csv": { "schema": { "type": "string", "example": "\"subject\",\"predicate\",\"object\"\n\"foo\",\"meets\",\"bar\"\n\"one\",\"meets\",\"two\"" } }, "text/tab-separated-values": { "schema": { "type": "string", "example": "?subject ?predicate ?object" } }, "application/x-binary-rdf-results-table": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad request or malformed SPARQL" }, "500": { "description": "Fatal error" } } }, "post": { "tags": [ "agent" ], "summary": "Invoke a Skill or Query (Flexible)", "operationId": "postAgent", "parameters": [ { "name": "asset", "in": "query", "description": "The Target Asset of the Query (targets the complete dataspace if empty)", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "LifetimeSkill": { "$ref": "#/components/examples/LifetimeSkill" }, "NullSkill": { "$ref": "#/components/examples/NullSkill" }, "DataspaceSkill": { "$ref": "#/components/examples/DataspaceSkill" } } }, { "name": "runMode", "in": "query", "description": "Determines the preferred execution location which may be \"consumer\" (in the computing environment of the endpoint agent), \"provider\" (in the computing environment of the remote agent providing the targetted asset) or \"all\" (the agent will choose the best computing environment based on contracts and policies, this is the default mode).", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "consumer": { "$ref": "#/components/examples/RunModeConsumer" }, "provider": { "$ref": "#/components/examples/RunModeProvider" }, "all": { "$ref": "#/components/examples/RunModeAll" } } }, { "name": "queryLn", "in": "query", "description": "Determines the query language. Currently only \"SPARQL\" is supported.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "sparql": { "$ref": "#/components/examples/QuerySparql" } } }, { "name": "query", "in": "query", "description": "The SPARQL query (in case that the body contains a tuple set)", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "Null": { "$ref": "#/components/examples/NullText" }, "Dataspace": { "$ref": "#/components/examples/Dataspace" } } }, { "name": "(vin", "in": "query", "description": "A sample bound parameter 'vin' which opens a new input tuple", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "Vehicle1": { "$ref": "#/components/examples/Vehicle1" }, "NoVehicle": { "$ref": "#/components/examples/NoVehicle" } } }, { "name": "troubleCode", "in": "query", "description": "A sample multi-bound parameter 'troubleCode' which closes the tuple", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "TroubleCodeClose": { "$ref": "#/components/examples/TroubleCodeClose" }, "NoTroubleCode": { "$ref": "#/components/examples/NoTroubleCode" } } } ], "requestBody": { "description": "The body either contains the query or a binding data set when a skill is invoked", "content": { "application/sparql-results+json": { "schema": { "type": "object" }, "example": { "head": { "vars": [ "vin", "troubleCode" ] }, "results": { "bindings": [ { "vin": { "type": "literal", "value": "WBAAL31029PZ00001" }, "troubleCode": { "type": "literal", "value": "P0746" } }, { "vin": { "type": "literal", "value": "WBAAL31029PZ00001" }, "troubleCode": { "type": "literal", "value": "P0745" } }, { "vin": { "type": "literal", "value": "WBAAL31029PZ00002" }, "troubleCode": { "type": "literal", "value": "P0744" } }, { "vin": { "type": "literal", "value": "WBAAL31029PZ00003" }, "troubleCode": { "type": "literal", "value": "P0743" } } ] } } }, "application/sparql-results+xml": { "schema": { "$ref": "#/components/schemas/XmlResultset" }, "example": "\n\n \n \n \n \n \n \n \n WBAAL31029PZ00001\n \n \n P0746\n \n \n \n \n WBAAL31029PZ00001\n \n \n P0745\n \n \n \n \n WBAAL31029PZ00002\n \n \n P0744\n \n \n \n " }, "application/sparql-query": { "schema": { "type": "string" }, "examples": { "Dataspace": { "$ref": "#/components/examples/Dataspace" } } } }, "required": true }, "responses": { "200": { "description": "The SparQL query has been processed successfully.", "content": { "application/sparql-results+json": { "schema": { "type": "object" }, "example": { "head": { "vars": [ "connector", "asset", "name", "description", "type", "version", "contentType", "isDefinedBy", "shape" ] }, "results": { "bindings": [ { "connector": { "type": "uri", "value": "edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN" }, "asset": { "type": "uri", "value": "GraphAsset?oem=Quality" }, "name": { "type": "literal", "value": "Quality Data." }, "description": { "type": "literal", "value": "A graph asset/offering mounting Quality data." }, "type": { "type": "uri,", "value": "https://w3id.org/catenax/ontology/common#GraphAsset" }, "version": { "type": "literal,", "value": "v0.7.2" }, "contentType": { "type": "literal,", "value": "application/json, application/xml" }, "isDefinedBy": { "type": "literal,", "value": "" }, "shape": { "type": "literal,", "value": "@prefix : ." } } ] } } }, "application/sparql-results+xml": { "schema": { "$ref": "#/components/schemas/XmlResultset" }, "example": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN\n \n \n GraphAsset?oem=Quality\n \n \n Quality Data.\n \n \n A graph asset/offering mounting Quality data.\n \n \n https://w3id.org/catenax/ontology/common#GraphAsset\n \n \n v0.7.2\n \n \n application/json, application/xml\n \n \n <https://w3id.org/catenax/ontology/reliability>\n \n \n @prefix : <GraphAsset?oem=Quality#> .\n \n \n \n" }, "text/csv": { "schema": { "type": "string", "example": "\"subject\",\"predicate\",\"object\"\n\"foo\",\"meets\",\"bar\"\n\"one\",\"meets\",\"two\"" } }, "text/tab-separated-values": { "schema": { "type": "string", "example": "?subject ?predicate ?object" } }, "application/x-binary-rdf-results-table": { "schema": { "type": "string", "format": "binary" } } } }, "203": { "description": "The SparQL query has been processed successfully but warnings did occur.", "headers": { "cx_warnings": { "description": "A data structure listing problems when processing the query.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CxWarning" } } } }, "content": { "application/sparql-results+json": { "schema": { "type": "object" }, "example": { "head": { "vars": [ "connector", "asset", "name", "description", "type", "version", "contentType", "isDefinedBy", "shape" ] }, "results": { "bindings": [ { "connector": { "type": "uri", "value": "edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN" }, "asset": { "type": "uri", "value": "GraphAsset?oem=Quality" }, "name": { "type": "literal", "value": "Quality Data." }, "description": { "type": "literal", "value": "A graph asset/offering mounting Quality data." }, "type": { "type": "uri,", "value": "https://w3id.org/catenax/ontology/common#GraphAsset" }, "version": { "type": "literal,", "value": "v0.7.2" }, "contentType": { "type": "literal,", "value": "application/json, application/xml" }, "isDefinedBy": { "type": "literal,", "value": "" }, "shape": { "type": "literal,", "value": "@prefix : ." } } ] } } }, "application/sparql-results+xml": { "schema": { "$ref": "#/components/schemas/XmlResultset" }, "example": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN\n \n \n GraphAsset?oem=Quality\n \n \n Quality Data.\n \n \n A graph asset/offering mounting Quality data.\n \n \n https://w3id.org/catenax/ontology/common#GraphAsset\n \n \n v0.7.2\n \n \n application/json, application/xml\n \n \n <https://w3id.org/catenax/ontology/reliability>\n \n \n @prefix : <GraphAsset?oem=Quality#> .\n \n \n \n" }, "text/csv": { "schema": { "type": "string", "example": "\"subject\",\"predicate\",\"object\"\n\"foo\",\"meets\",\"bar\"\n\"one\",\"meets\",\"two\"" } }, "text/tab-separated-values": { "schema": { "type": "string", "example": "?subject ?predicate ?object" } }, "application/x-binary-rdf-results-table": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad request or malformed SPARQL" }, "500": { "description": "Fatal error" } } } }, "/skill": { "post": { "tags": [ "agent" ], "summary": "Register a Skill", "operationId": "postSkill", "parameters": [ { "name": "asset", "in": "query", "description": "The Target Asset of the Query (targets the complete dataspace if empty)", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "DataspaceSkill": { "$ref": "#/components/examples/DataspaceSkill" }, "LifetimeSkill": { "$ref": "#/components/examples/LifetimeSkill" } } }, { "name": "distributionMode", "in": "query", "description": "The distribution mode under which to publish the skill", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "Provider": { "$ref": "#/components/examples/DistributionModeProvider" }, "Consumer": { "$ref": "#/components/examples/DistributionModeConsumer" }, "All": { "$ref": "#/components/examples/DistributionModeAll" } } }, { "name": "contract", "in": "query", "description": "The contract under which the skill should be published", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "Provider": { "$ref": "#/components/examples/Contract" } } }, { "name": "isFederated", "in": "query", "description": "Whether the skill should be visible in the Federated Catalogue", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "ontology", "in": "query", "description": "Multiple references to ontologies which are referenced in the skill", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "examples": { "Provider": { "$ref": "#/components/examples/Ontology" } } } ], "requestBody": { "description": "The body either contains the parameterized query", "content": { "application/sparql-query": { "schema": { "type": "string" }, "examples": { "Dataspace": { "$ref": "#/components/examples/Dataspace" } } } }, "required": true }, "responses": { "200": { "description": "Skill has been registered" }, "204": { "description": "Skill has been updated" }, "400": { "description": "Bad request or malformed SPARQL" }, "500": { "description": "Fatal error" } } } } }, "components": { "schemas": { "CxWarning": { "type": "object", "properties": { "source-tenant": { "type": "string" }, "source-asset": { "type": "string" }, "target-tenant": { "type": "string" }, "target-asset": { "type": "string" }, "problem": { "type": "string" }, "context": { "type": "string" } } }, "XmlResultset": { "type": "object", "properties": { "head": { "$ref": "#/components/schemas/XmlResultset_head" }, "results": { "$ref": "#/components/schemas/XmlResultset_results" } }, "xml": { "name": "sparql" } }, "XmlResultset_head_variable": { "type": "object", "properties": { "name": { "type": "string", "xml": { "attribute": true } } }, "xml": { "name": "variable" } }, "XmlResultset_head": { "type": "object", "properties": { "variable": { "$ref": "#/components/schemas/XmlResultset_head_variable" } }, "xml": { "name": "head" } }, "XmlResultset_results_result_binding": { "type": "object", "properties": { "name": { "type": "string", "xml": { "attribute": true } }, "literal": { "type": "string" }, "uri": { "type": "string" } }, "xml": { "name": "binding" } }, "XmlResultset_results_result": { "type": "object", "properties": { "binding": { "$ref": "#/components/schemas/XmlResultset_results_result_binding" } }, "xml": { "name": "result" } }, "XmlResultset_results": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/XmlResultset_results_result" } }, "xml": { "name": "results" } } }, "responses": { "200": { "description": "The SparQL query has been processed successfully.", "content": { "application/sparql-results+json": { "schema": { "type": "object" }, "example": { "head": { "vars": [ "connector", "asset", "name", "description", "type", "version", "contentType", "isDefinedBy", "shape" ] }, "results": { "bindings": [ { "connector": { "type": "uri", "value": "edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN" }, "asset": { "type": "uri", "value": "GraphAsset?oem=Quality" }, "name": { "type": "literal", "value": "Quality Data." }, "description": { "type": "literal", "value": "A graph asset/offering mounting Quality data." }, "type": { "type": "uri,", "value": "https://w3id.org/catenax/ontology/common#GraphAsset" }, "version": { "type": "literal,", "value": "v0.7.2" }, "contentType": { "type": "literal,", "value": "application/json, application/xml" }, "isDefinedBy": { "type": "literal,", "value": "" }, "shape": { "type": "literal,", "value": "@prefix : ." } } ] } } }, "application/sparql-results+xml": { "schema": { "$ref": "#/components/schemas/XmlResultset" }, "example": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN\n \n \n GraphAsset?oem=Quality\n \n \n Quality Data.\n \n \n A graph asset/offering mounting Quality data.\n \n \n hhttps://w3id.org/catenax/ontology/common#GraphAsset\n \n \n v0.7.2\n \n \n application/json, application/xml\n \n \n <https://w3id.org/catenax/ontology/reliability>\n \n \n @prefix : <GraphAsset?oem=Quality#> .\n \n \n \n" }, "text/csv": { "schema": { "type": "string", "example": "\"subject\",\"predicate\",\"object\"\n\"foo\",\"meets\",\"bar\"\n\"one\",\"meets\",\"two\"" } }, "text/tab-separated-values": { "schema": { "type": "string", "example": "?subject ?predicate ?object" } }, "application/x-binary-rdf-results-table": { "schema": { "type": "string", "format": "binary" } } } }, "203": { "description": "The SparQL query has been processed successfully but warnings did occur.", "headers": { "cx_warnings": { "description": "A data structure listing problems when processing the query.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CxWarning" } } } }, "content": { "application/sparql-results+json": { "schema": { "type": "object" }, "example": { "head": { "vars": [ "connector", "asset", "name", "description", "type", "version", "contentType", "isDefinedBy", "shape" ] }, "results": { "bindings": [ { "connector": { "type": "uri", "value": "edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN" }, "asset": { "type": "uri", "value": "GraphAsset?oem=Quality" }, "name": { "type": "literal", "value": "Quality Data." }, "description": { "type": "literal", "value": "A graph asset/offering mounting Quality data." }, "type": { "type": "uri,", "value": "https://w3id.org/catenax/ontology/common#GraphAsset" }, "version": { "type": "literal,", "value": "v0.7.2" }, "contentType": { "type": "literal,", "value": "application/json, application/xml" }, "isDefinedBy": { "type": "literal,", "value": "" }, "shape": { "type": "literal,", "value": "@prefix : ." } } ] } } }, "application/sparql-results+xml": { "schema": { "$ref": "#/components/schemas/XmlResultset" }, "example": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n edcs://knowledge.dev.demo.catena-x.net/oem-edc-control/BPNL00000003COJN\n \n \n GraphAsset?oem=Quality\n \n \n Quality Data.\n \n \n A graph asset/offering mounting Quality data.\n \n \n https://w3id.org/catenax/ontology/common#GraphAsset\n \n \n v0.7.2\n \n \n application/json, application/xml\n \n \n <https://w3id.org/catenax/ontology/reliability>\n \n \n @prefix : <GraphAsset?oem=Quality#> .\n \n \n \n" }, "text/csv": { "schema": { "type": "string", "example": "\"subject\",\"predicate\",\"object\"\n\"foo\",\"meets\",\"bar\"\n\"one\",\"meets\",\"two\"" } }, "text/tab-separated-values": { "schema": { "type": "string", "example": "?subject ?predicate ?object" } }, "application/x-binary-rdf-results-table": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad request or malformed SPARQL" }, "500": { "description": "Fatal error" } }, "examples": { "NullSkill": { "summary": "No Predefined Skill", "value": null }, "DataspaceSkill": { "summary": "Predefined Skill to List Federated Data Catalogue", "value": "SkillAsset?consumer=Dataspace" }, "LifetimeSkill": { "summary": "Predefined Skill to Perform a Lifetime Prognosis", "value": "SkillAsset?consumer=RemainingUsefulLife" }, "Vehicle1": { "summary": "Vehicle Parameter", "value": "WBAAL31029PZ00001" }, "NoVehicle": { "summary": "No Vehicle Parameter", "value": null }, "TroubleCodeClose": { "summary": "Multiple Trouble Codes (and Tuple End)", "value": [ "P0746", "P0745)" ] }, "SingleTroubleCode": { "summary": "A Single Trouble Code", "value": "P0746" }, "NoTroubleCode": { "summary": "No Trouble Code", "value": null }, "NullText": { "summary": "No Skill", "value": null }, "Dataspace": { "summary": "Skill to List Federated Data Catalogue", "value": "SELECT ?connector ?asset \n ?name\n (MIN(?adescription) AS ?description) \n ?type\n (MAX(?aversion) AS ?version) \n (GROUP_CONCAT(DISTINCT ?acontentType;SEPARATOR=\",\") AS ?contentType) \n (CONCAT(\"<\",GROUP_CONCAT(?aontology;SEPARATOR=\">,<\"),\">\") AS ?isDefinedBy) \n (MIN(?ashape) AS ?shape)\n WHERE { \n ?connector ?asset. \n ?asset ?acontentType; \n ?name; \n ?type; \n ?aontology; \n ?aversion; \n ?adescription.\n\n OPTIONAL {\n ?asset ?ashape\n }\n} GROUP BY ?connector ?asset ?name ?type" }, "Resultset": { "summary": "Sample Json-Based Resultset" }, "AuthorsWithLimits": { "summary": "First 10 authors", "value": "SELECT DISTINCT \n ?author_url \n (GROUP_CONCAT(?author_label; SEPARATOR=\";\") AS ?author_names)\n{ \n\n ?author_url a-cd:pseudonym ?x .\n ?author_url rdfs:label ?author_label\n} LIMIT 10" }, "CulturalPlacesInVinci": { "summary": "Cultural places in Latina", "value": "SELECT DISTINCT ?luogo ?indirizzo ?comune WHERE {\n ?x a cis:CulturalInstituteOrSite ;\n cis:institutionalCISName ?luogo ;\n cis:hasSite ?site .\n ?site cis:siteAddress ?address .\n ?address clvapit:fullAddress ?indirizzo ;\n clvapit:hasCity [rdfs:label ?comune] .\n FILTER regex(str(?comune), \"Vinci\", \"i\")\n} ORDER BY ?luogo LIMIT 100\nLifetimeSkill:" }, "RunModeConsumer": { "summary": "Local Consumer Execution", "value": "consumer" }, "RunModeProvider": { "summary": "Remote Provider Execution", "value": "provider" }, "RunModeAll": { "summary": "Best Possible Execution", "value": "all" }, "DistributionModeConsumer": { "summary": "Local Consumer Execution", "value": "CONSUMER" }, "DistributionModeProvider": { "summary": "Remote Provider Execution", "value": "PROVIDER" }, "DistributionModeAll": { "summary": "Best Possible Execution", "value": "ALL" }, "QuerySparql": { "summary": "SPARQL Query Language", "value": "SPARQL" }, "Contract": { "summary": "An example contract name", "value": "Contract?oem=Skill" }, "Ontology": { "summary": "An example reference to an ontology", "value": "https://w3id.org/catenax/ontology/behaviour" } } } }