openapi: 3.2.0 info: description: '

Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API. Depending on the database version and configuration, ORDS database APIs provide services such as manage pluggable databases, export data, and review database performance.

To install and configure Oracle REST Data Services refer to the Oracle® REST Data Services Installation and Configuration Guide.

An OpenAPI V3 document that describes the available ORDS database API services can be retrieved from a running ORDS instance. The API document can be imported into compatible development tools and invoked from there. The URL to retrieve the API document depends on the your configuration.

The pattern for the API document URL is:

https://<server>/<context root>/<my database>/<my schema>/_/db-api/stable/<service path>

Where, the <my database> and <my schema> variables can be optional, depending on the ORDS configuration and the service invoked.' version: 2026.03.26 title: Oracle REST Data Services RDF Graph API contact: name: Oracle REST Data Services url: https://www.oracle.com/database/technologies/appdev/rest.html x-summary: Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API. tags: - name: RDF Graph description: Services related to Oracle RDF Graph. Oracle RDF Graph provides functionality to manage knowledge graphs based on World Wide Web Consortium (W3C) standards such as RDF, OWL and SPARQL. paths: /database/rdf/networks/: get: tags: - RDF Graph summary: List RDF networks description: Returns a collection of RDF networks visible to the current user. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce. parameters: - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' responses: '200': description: Returns an array of network owner, network name pairs. content: application/json: schema: $ref: '#/components/schemas/NetworkElemCollection' example: "{\n \"items\": [\n {\n \"owner\": \"RDFUSER\",\n \"network_name\": \"NET1\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/\"\n }\n ]\n}\n" x-internal-id: database-rdf-networks--get x-filename-id: database-rdf-networks-get /database/rdf/networks/{network_owner},{network_name}: parameters: - $ref: '#/components/parameters/NetworkOwner' - $ref: '#/components/parameters/NetworkName' get: tags: - RDF Graph summary: RDF network information description: Returns metadata describing the specified network. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce. responses: '200': description: Returns metadata about the specified network. content: application/json: schema: $ref: '#/components/schemas/NetworkDetailElem' example: "{\n \"owner\": \"RDFUSER\",\n \"network_name\": \"NET1\",\n \"parameters\": [\n {\n \"namespace\": \"NETWORK\",\n \"attribute\": \"COMPRESSION\",\n \"value\": \"COMPRESS=RSCB\",\n \"description\": \"Compression setting for semantic network\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1\"\n }\n ]\n}\n" '404': description: RDF network does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-get x-filename-id: database-rdf-networks-network_owner-network_name-get put: tags: - RDF Graph summary: Create RDF network description: Creates an RDF network. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SEM_APIS.CREATE_RDF_NETWORK documentation url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-create_rdf_network.html requestBody: $ref: '#/components/requestBodies/createNetwork' parameters: [] responses: '201': description: Successful RDF network creation. content: application/json: schema: $ref: '#/components/schemas/NetworkDetailElem' example: "{\n \"owner\": \"RDFUSER\",\n \"network_name\": \"NET1\",\n \"parameters\": [\n {\n \"namespace\": \"NETWORK\",\n \"attribute\": \"COMPRESSION\",\n \"value\": \"COMPRESS=RSCB\",\n \"description\": \"Compression setting for semantic network\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1\"\n }\n ]\n}\n" '400': description: RDF network already exists x-internal-id: database-rdf-networks-{network_owner},{network_name}-put x-filename-id: database-rdf-networks-network_owner-network_name-put delete: tags: - RDF Graph summary: Drop RDF network description: Drops an RDF network. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SEM_APIS.DROP_RDF_NETWORK documentation url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-drop_rdf_network.html parameters: - in: query name: cascade required: false example: true description: true to drop all data in the RDF network. schema: type: string responses: '204': description: Successful drop RDF network operation. '400': description: Attempt to drop a non-empty RDF network without the cascade option x-internal-id: database-rdf-networks-{network_owner},{network_name}-delete x-filename-id: database-rdf-networks-network_owner-network_name-delete /database/rdf/networks/{network_owner},{network_name}/models/: get: tags: - RDF Graph summary: List RDF models description: Returns metadata describing all RDF models in the network. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce. parameters: - $ref: '#/components/parameters/NetworkOwner' - $ref: '#/components/parameters/NetworkName' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' responses: '200': description: Returns an array of elements containing metadata about all models in the specified network. content: application/json: schema: $ref: '#/components/schemas/ModelDetailCollection' example: "{\n \"items\": [\n {\n \"owner\": \"RDFUSER\",\n \"model_id\": \"1\",\n \"model_name\": \"M1\",\n \"table_name\": null,\n \"column_name\": null,\n \"model_tablespace_name\": \"DATA\",\n \"model_type\": \"M\",\n \"inmemory\": \"F\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/m1\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/\"\n }\n ]\n}\n" '404': description: RDF network does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-models--get x-filename-id: database-rdf-networks-network_owner-network_name-models-get /database/rdf/networks/{network_owner},{network_name}/models/{model_name}: parameters: - $ref: '#/components/parameters/NetworkOwner' - $ref: '#/components/parameters/NetworkName' - in: path name: model_name required: true example: M1 description: The name of the RDF model. schema: type: string get: tags: - RDF Graph summary: RDF model information description: Returns metadata describing the specified RDF model. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce. responses: '200': description: Returns metadata about the specified RDF model. content: application/json: schema: $ref: '#/components/schemas/ModelDetailSingle' example: "{\n \"owner\": \"RDFUSER\",\n \"model_id\": \"1\",\n \"model_name\": \"M1\",\n \"table_name\": null,\n \"column_name\": null,\n \"model_tablespace_name\": \"DATA\",\n \"model_type\": \"M\",\n \"inmemory\": \"F\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/m1\"\n }\n ]\n}\n" '404': description: RDF network or model does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-get x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-get put: tags: - RDF Graph summary: Create RDF model description: Creates an RDF model. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SEM_APIS.CREATE_RDF_GRAPH documentation url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-create_rdf_graph.html requestBody: $ref: '#/components/requestBodies/createModel' parameters: [] responses: '201': description: Successful RDF model creation. content: application/json: schema: $ref: '#/components/schemas/ModelDetailSingle' example: "{\n \"owner\": \"RDFUSER\",\n \"model_id\": \"1\",\n \"model_name\": \"M1\",\n \"table_name\": null,\n \"column_name\": null,\n \"model_tablespace_name\": \"DATA\",\n \"model_type\": \"M\",\n \"inmemory\": \"F\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/m1\"\n }\n ]\n}\n" '400': description: RDF model already exists '404': description: RDF network does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-put x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-put delete: tags: - RDF Graph summary: Drop RDF model description: Drops an RDF model. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SEM_APIS.DROP_RDF_GRAPH documentation url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-drop_rdf_graph.html parameters: [] responses: '204': description: Successful drop RDF network operation. '404': description: RDF network or model does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-delete x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-delete /database/rdf/networks/{network_owner},{network_name}/entailments/: get: tags: - RDF Graph summary: List entailments description: Returns metadata describing all entailments in the network. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce. parameters: - $ref: '#/components/parameters/NetworkOwner' - $ref: '#/components/parameters/NetworkName' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' responses: '200': description: Returns an array of elements containing metadata about all entailments in the specified network. content: application/json: schema: $ref: '#/components/schemas/EntailmentDetailCollection' example: "{\n \"items\": [\n {\n \"owner\": \"RDFUSER\",\n \"index_name\": \"M1OWL\",\n \"index_view_name\": \"NET1#RDFI_M1OWL\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/entailments/m1owl\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/entailments/\"\n }\n ]\n}\n" '404': description: RDF network does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-entailments--get x-filename-id: database-rdf-networks-network_owner-network_name-entailments-get /database/rdf/networks/{network_owner},{network_name}/entailments/{entailment_name}: parameters: - $ref: '#/components/parameters/NetworkOwner' - $ref: '#/components/parameters/NetworkName' - in: path name: entailment_name required: true example: M1OWL description: The name of the entailment. schema: type: string get: tags: - RDF Graph summary: Entailment information description: Returns metadata describing the specified entailment. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce. responses: '200': description: Returns an array of elements containing metadata about the specified entailment. content: application/json: schema: $ref: '#/components/schemas/EntailmentDetailSingle' example: "{\n \"owner\": \"RDFUSER\",\n \"index_name\": \"M1OWL\",\n \"index_view_name\": \"NET1#RDFI_M1OWL\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/entailments/m1owl\"\n }\n ]\n}\n" '404': description: RDF network or entailment does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-entailments-{entailment_name}-get x-filename-id: database-rdf-networks-network_owner-network_name-entailments-entailment_name-get put: tags: - RDF Graph summary: Create entailment description: Creates an entailment. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SEM_APIS.CREATE_INFERRED_GRAPH documentation url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-create_inferred_graph.html requestBody: $ref: '#/components/requestBodies/createEntailment' parameters: [] responses: '201': description: Successful entailment creation. content: application/json: schema: $ref: '#/components/schemas/EntailmentDetailSingle' example: "{\n \"owner\": \"RDFUSER\",\n \"index_name\": \"M1OWL\",\n \"index_view_name\": \"NET1#RDFI_M1OWL\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/entailments/m1owl\"\n }\n ]\n}\n" '400': description: A valid entailment already exists with the same name or with the same model-rulebase combination '404': description: RDF network does not exist or one of the referenced models or rulebases does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-entailments-{entailment_name}-put x-filename-id: database-rdf-networks-network_owner-network_name-entailments-entailment_name-put delete: tags: - RDF Graph summary: Drop entailment description: Drops an entailment. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SEM_APIS.DROP_INFERRED_GRAPH documentation url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-drop_inferred_graph.html responses: '204': description: Successful drop entailment operation. '404': description: RDF network or entailment does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-entailments-{entailment_name}-delete x-filename-id: database-rdf-networks-network_owner-network_name-entailments-entailment_name-delete /database/rdf/networks/{network_owner},{network_name}/virtual_models/: get: tags: - RDF Graph summary: List virtual models description: Returns metadata describing all virtual models in the network. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce. parameters: - $ref: '#/components/parameters/NetworkOwner' - $ref: '#/components/parameters/NetworkName' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' responses: '200': description: Returns an array of elements containing metadata about all virtual models in the specified network. content: application/json: schema: $ref: '#/components/schemas/VirtualModelDetailCollection' example: "{\n \"items\": [\n {\n \"owner\": \"RDUSER\",\n \"virtual_model_name\": \"VM1\",\n \"unique_view_name\": \"NET1#SEMU_VM1\",\n \"duplicate_view_name\": \"NET1#SEMV_VM1\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"rules_index_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME, RULEIDX M1OWL\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/virtual_models/vm1\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/virtual_models/\"\n }\n ]\n}\n" '404': description: RDF network does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-virtual_models--get x-filename-id: database-rdf-networks-network_owner-network_name-virtual_models-get /database/rdf/networks/{network_owner},{network_name}/virtual_models/{virtual_model_name}: parameters: - $ref: '#/components/parameters/NetworkOwner' - $ref: '#/components/parameters/NetworkName' - in: path name: virtual_model_name required: true example: VM1 description: The name of the virtual model. schema: type: string get: tags: - RDF Graph summary: Virtual model information description: Returns metadata describing the specified virtual model. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce. responses: '200': description: Returns an array of elements containing metadata about the specified virtual model. content: application/json: schema: $ref: '#/components/schemas/VirtualModelDetailSingle' example: "{\n \"owner\": \"RDUSER\",\n \"virtual_model_name\": \"VM1\",\n \"unique_view_name\": \"NET1#SEMU_VM1\",\n \"duplicate_view_name\": \"NET1#SEMV_VM1\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"rules_index_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME, RULEIDX M1OWL\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/virtual_models/vm1\"\n }\n ]\n}\n" '404': description: RDF network or virtual model does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-virtual_models-{virtual_model_name}-get x-filename-id: database-rdf-networks-network_owner-network_name-virtual_models-virtual_model_name-get put: tags: - RDF Graph summary: Create virtual model description: Creates a virtual model. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SEM_APIS.CREATE_RDF_GRAPH_COLLECTION documentation url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-create_rdf_graph_collection.html requestBody: $ref: '#/components/requestBodies/createVirtualModel' parameters: [] responses: '201': description: Successful virtual model creation. content: application/json: schema: $ref: '#/components/schemas/VirtualModelDetailSingle' example: "{\n \"owner\": \"RDUSER\",\n \"virtual_model_name\": \"VM1\",\n \"unique_view_name\": \"NET1#SEMU_VM1\",\n \"duplicate_view_name\": \"NET1#SEMV_VM1\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"rules_index_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME, RULEIDX M1OWL\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/virtual_models/vm1\"\n }\n ]\n}\n" '400': description: A virtual model with the same name or the same model-rulebase-entailment combination already exists or no entailment exists for the given model-rulebase combination '404': description: RDF network does not exist or one of the referenced models, rulebases, or entailments does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-virtual_models-{virtual_model_name}-put x-filename-id: database-rdf-networks-network_owner-network_name-virtual_models-virtual_model_name-put delete: tags: - RDF Graph summary: Drop virtual model description: Drops a virtual model. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SEM_APIS.DROP_RDF_GRAPH_COLLECTION documentation url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-drop_rdf_graph_collection.html parameters: [] responses: '204': description: Successful drop virtual model operation. '404': description: RDF network or virtual model does not exist x-internal-id: database-rdf-networks-{network_owner},{network_name}-virtual_models-{virtual_model_name}-delete x-filename-id: database-rdf-networks-network_owner-network_name-virtual_models-virtual_model_name-delete /database/rdf/networks/{network_owner},{network_name}/models/{model_name}/sparql/1.1: parameters: - $ref: '#/components/parameters/NetworkOwner' - $ref: '#/components/parameters/NetworkName' - $ref: '#/components/parameters/ModelName' - $ref: '#/components/parameters/DefaultGraphUri' - $ref: '#/components/parameters/NamedGraphUri' - $ref: '#/components/parameters/SparqlOptions' get: tags: - RDF Graph summary: Execute a SPARQL query description: Executes a SPARQL query and returns the result in JSON format (application/sparql-results+json) or XML format (application/sparql-results+xml) for SPARQL SELECT and ASK queries, or N-Triples format (application/n-triples) for CONSTRUCT and DESCRIBE queries. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce. externalDocs: description: SPARQL 1.1 Protocol url: https://www.w3.org/TR/2013/REC-sparql11-protocol-20130321/ parameters: - in: query name: query required: true example: SELECT%20%2A%0AWHERE%20%7B%20%3Fs%20%3Fp%20%3Fo%20%7D%0AORDER%20BY%20%3Fs%20%3Fp%20%3Fo%0ALIMIT%2010 description: A URL-encoded SPARQL query string. schema: type: string responses: '200': description: Successful query execution. content: application/sparql-results+xml: schema: $ref: '#/components/schemas/SparqlXmlResult' examples: select: value: "\n\n \n \n \n \n \n \n \n \n http://www.example.oracle.com/john\n \n \n http://www.example.oracle.com/dept\n \n \n http://www.example.oracle.com/sales\n \n \n \n \n http://www.example.oracle.com/john\n \n \n http://www.example.oracle.com/fname\n \n \n John\n \n \n \n\n" ask: value: "\n\n \n true\n\n" application/sparql-results+json: schema: $ref: '#/components/schemas/SparqlJsonResult' examples: select: value: "{\n \"head\": { \n \"vars\": [\"s\", \"p\", \"o\"] \n },\n \"results\": {\n \"bindings\": [\n { \n \"s\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/john\"},\n \"p\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/dept\"},\n \"o\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/sales\"}\n },\n {\n \"s\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/john\"},\n \"p\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/fname\"},\n \"o\": {\"type\": \"literal\", \"value\": \"John\", \"xml:lang\": \"en\"}\n }\n ]\n }\n}\n" ask: value: "{ \n \"head\": {}, \n \"boolean\": true \n}\n" application/n-triples: schema: externalDocs: description: RDF 1.1 N-Triples url: https://www.w3.org/TR/n-triples/ type: string examples: construct: value: ' . "John"@en . ' x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-sparql-1.1-get x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-sparql-1.1-get post: tags: - RDF Graph summary: Execute a SPARQL query or update description: Executes a SPARQL update or executes a SPARQL query and returns the result in JSON format (application/sparql-results+json) or XML format (application/sparql-results+xml) for SPARQL SELECT and ASK queries, or N-Triples format (application/n-triples) for CONSTRUCT and DESCRIBE queries. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SPARQL 1.1 Protocol url: https://www.w3.org/TR/2013/REC-sparql11-protocol-20130321/ parameters: - in: query name: using-graph-uri required: false description: A URL-encoded IRI identifying a named graph that should be included in the DEFAULT graph of the update dataset. schema: type: string example: http%3A%2F%2Fwww.example.oracle.com%2Fg1 - in: query name: using-named-graph-uri required: false description: A URL-encoded IRI identifying a named graph that should be included in the set of named graphs for the update dataset. schema: type: string example: http%3A%2F%2Fwww.example.oracle.com%2Fg1 - in: query name: match_model required: false description: The name of the model to evaluate the WHERE portion of a SPARQL update against. The default is the value of the modelName path parameter. schema: type: string example: M2 - in: query name: match_options required: false description: The options string to use when evaluating the WHERE portion of a SPARQL update. schema: type: string example: ALLOW_DUP=T requestBody: description: A POST request with URL-encoded, ampersand-separated query parameters for SPARQL query (exactly one query parameter, zero or more named-graph-uri parameters, and zero or more default-graph-uri parameters) or SPARQL update (exactly one update parameter, zero or more using-graph-uri parameters, and zero or more using-named-graph-uri parameters), or a direct POST request with an unencoded SPARQL query or update string in the message body to be used with optional default-graph-uri, named-graph-uri, using-graph-uri, and using-named-graph-uri query parameters in the request URL. content: application/x-www-form-urlencoded: schema: description: A POST request with URL-encoded, ampersand-separated query parameters for SPARQL query (exactly one query parameter, zero or more named-graph-uri parameters, and zero or more default-graph-uri parameters) or SPARQL update (exactly one update parameter, zero or more using-graph-uri parameters, and zero or more using-named-graph-uri parameters) type: string examples: query: value: 'query=SELECT%20%3Fs%20%3Fp%20%3Fo%0AWHERE%20%7B%20%3Fs%20%3Fp%20%3Fo%20%7D%0AORDER%20BY%20%3Fs%20%3Fp%20%3Fo%0ALIMIT%202 ' update: value: 'update=PREFIX%20%3A%20%3Chttp%3A%2F%2Fwww.example.oracle.com%2F%3E%0AINSERT%20DATA%20%7B%0A%20%20%3Ajohn%20%3Afname%20%22John%22%40en%20%3B%0A%20%20%20%20%20%20%20%20%20%20%20%3Alname%20%22Smith%22%40en%20%3B%0A%20%20%20%20%20%20%20%20%20%20%20%3Adept%20%3Asales%20%3B%0A%20%20%20%20%20%20%20%20%20%20%20%3Ajob%20%3Aconsultant%20.%0A%7D ' application/sparql-query: schema: description: An unencoded SPARQL query string type: string examples: select: value: 'SELECT ?s ?p ?o WHERE { ?s ?p ?o } ORDER BY ?s ?p ?o LIMIT 2 ' construct: value: "PREFIX : \nCONSTRUCT { ?s ?p ?o }\nWHERE {\n ?s ?p ?o\n FILTER (?s = :john)\n}\n" application/sparql-update: schema: description: An unencoded SPARQL update string type: string examples: insert data: value: "PREFIX : \nINSERT DATA {\n :john :fname \"John\"@en ;\n :lname \"Smith\"@en ;\n :dept :sales ;\n :job :consultant .\n}\n" delete insert where: value: 'PREFIX : DELETE { :john :job ?job } INSERT { :john :job :manager } WHERE { :john :job ?job } ' responses: '200': description: Successful query or update execution. content: application/sparql-results+xml: schema: $ref: '#/components/schemas/SparqlXmlResult' examples: select: value: "\n\n \n \n \n \n \n \n \n \n http://www.example.oracle.com/john\n \n \n http://www.example.oracle.com/dept\n \n \n http://www.example.oracle.com/sales\n \n \n \n \n http://www.example.oracle.com/john\n \n \n http://www.example.oracle.com/fname\n \n \n John\n \n \n \n\n" ask: value: "\n\n \n true\n\n" application/sparql-results+json: schema: $ref: '#/components/schemas/SparqlJsonResult' examples: select: value: "{\n \"head\": { \n \"vars\": [\"s\", \"p\", \"o\"] \n },\n \"results\": {\n \"bindings\": [\n { \n \"s\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/john\"},\n \"p\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/dept\"},\n \"o\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/sales\"}\n },\n {\n \"s\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/john\"},\n \"p\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/fname\"},\n \"o\": {\"type\": \"literal\", \"value\": \"John\", \"xml:lang\": \"en\"}\n }\n ]\n }\n}\n" ask: value: "{ \n \"head\": {}, \n \"boolean\": true \n}\n" application/n-triples: schema: externalDocs: description: RDF 1.1 N-Triples url: https://www.w3.org/TR/n-triples/ type: string examples: construct: value: ' . "John"@en . ' x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-sparql-1.1-post x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-sparql-1.1-post /database/rdf/networks/{network_owner},{network_name}/models/{model_name}/sparql2sql/1.1: parameters: - $ref: '#/components/parameters/NetworkOwner' - $ref: '#/components/parameters/NetworkName' - $ref: '#/components/parameters/ModelName' - $ref: '#/components/parameters/DefaultGraphUri' - $ref: '#/components/parameters/NamedGraphUri' - $ref: '#/components/parameters/SparqlOptions' get: tags: - RDF Graph summary: Translate SPARQL to SQL description: Returns the SQL translation for a SPARQL query. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce. externalDocs: description: SEM_APIS.SPARQL_TO_SQL url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-sparql_to_sql.html parameters: - in: query name: query required: true description: A URL-encoded SPARQL query string. example: SELECT%20%2A%0AWHERE%20%7B%20%3Fs%20%3Fp%20%3Fo%20%7D%0AORDER%20BY%20%3Fs%20%3Fp%20%3Fo%0ALIMIT%2010 schema: type: string responses: '200': description: Success content: text/plain: schema: description: The SQL translation of the submitted SPARQL query against the input RDF network and model. type: string example: "SELECT * FROM (\nSELECT /*+ NO_MERGE(R) */ R.S, R.S$RDFVID, R.S$_PREFIX, R.S$_SUFFIX, R.S$RDFVTYP, R.S$RDFCLOB, R.S$RDFLTYP, R.S$RDFLANG,\nR.P, R.P$RDFVID, R.P$_PREFIX, R.P$_SUFFIX, R.P$RDFVTYP, R.P$RDFCLOB, R.P$RDFLTYP, R.P$RDFLANG,\nR.O, R.O$RDFVID, R.O$_PREFIX, R.O$_SUFFIX, R.O$RDFVTYP, R.O$RDFCLOB, R.O$RDFLTYP, R.O$RDFLANG,\nR.SEM$ROWNUM AS SEM$ROWNUM\nFROM (SELECT /*+ NO_MERGE(R) */ R.P$RDFVID, R.P, R.P$RDFVTYP, R.P$_PREFIX, R.P$_SUFFIX, R.P$RDFLTYP, R.P$RDFLANG, R.P$RDFCLOB, R.S$RDFVID, R.S, R.S$RDFVTYP, R.S$_PREFIX, R.S$_SUFFIX, R.S$RDFLTYP, R.S$RDFLANG, R.S$RDFCLOB, R.O$RDFVID, R.O, R.O$RDFVTYP, R.O$_PREFIX, R.O$_SUFFIX, R.O$RDFLTYP, R.O$RDFLANG, R.O$RDFCLOB, ROWNUM AS SEM$ROWNUM\nFROM (\nSELECT V0.VNAME_PREFIX || V0.VNAME_SUFFIX AS P, V0.VALUE_ID AS P$RDFVID, V0.VNAME_PREFIX AS P$_PREFIX, V0.VNAME_SUFFIX AS P$_SUFFIX, (CASE WHEN V0.VALUE_TYPE IS NULL THEN NULL WHEN V0.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V0.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS P$RDFVTYP, TO_CLOB(NULL) AS P$RDFCLOB, V0.LITERAL_TYPE AS P$RDFLTYP, V0.LANGUAGE_TYPE AS P$RDFLANG,\nV1.VNAME_PREFIX || V1.VNAME_SUFFIX AS S, V1.VALUE_ID AS S$RDFVID, V1.VNAME_PREFIX AS S$_PREFIX, V1.VNAME_SUFFIX AS S$_SUFFIX, (CASE WHEN V1.VALUE_TYPE IS NULL THEN NULL WHEN V1.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V1.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS S$RDFVTYP, TO_CLOB(NULL) AS S$RDFCLOB, V1.LITERAL_TYPE AS S$RDFLTYP, V1.LANGUAGE_TYPE AS S$RDFLANG,\nV2.VNAME_PREFIX || V2.VNAME_SUFFIX AS O, V2.VALUE_ID AS O$RDFVID, V2.VNAME_PREFIX AS O$_PREFIX, V2.VNAME_SUFFIX AS O$_SUFFIX, (CASE WHEN V2.VALUE_TYPE IS NULL THEN NULL WHEN V2.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V2.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS O$RDFVTYP, V2.LONG_VALUE AS O$RDFCLOB, V2.LITERAL_TYPE AS O$RDFLTYP, V2.LANGUAGE_TYPE AS O$RDFLANG\nFROM (\nSELECT T0.P_VALUE_ID AS P$RDFVID,\nT0.START_NODE_ID AS S$RDFVID,\nT0.CANON_END_NODE_ID AS O$RDFVID,\nT0.START_NODE_ID AS BGP$1\nFROM (\nSELECT * FROM \"RDFUSER\".NET1#RDFM_M1) T0\nWHERE (1=1)\n) R\n, \"RDFUSER\".NET1#RDF_VALUE$ V0, \"RDFUSER\".NET1#RDF_VALUE$ V1, \"RDFUSER\".NET1#RDF_VALUE$ V2\nWHERE (1=1) AND (R.P$RDFVID = V0.VALUE_ID) AND (R.S$RDFVID = V1.VALUE_ID) AND (R.O$RDFVID = V2.VALUE_ID)\n ORDER BY V1.ORDER_TYPE ASC NULLS FIRST, V1.ORDER_NUM ASC NULLS FIRST, V1.ORDER_DATE ASC NULLS FIRST,\n(V1.VNAME_PREFIX || V1.VNAME_SUFFIX) ASC NULLS FIRST,\nV0.ORDER_TYPE ASC NULLS FIRST, V0.ORDER_NUM ASC NULLS FIRST, V0.ORDER_DATE ASC NULLS FIRST,\n(V0.VNAME_PREFIX || V0.VNAME_SUFFIX) ASC NULLS FIRST,\nV2.ORDER_TYPE ASC NULLS FIRST, V2.ORDER_NUM ASC NULLS FIRST, V2.ORDER_DATE ASC NULLS FIRST,\n(V2.VNAME_PREFIX || V2.VNAME_SUFFIX) ASC NULLS FIRST\n) R\nWHERE (1=1) AND ROWNUM <= 10) R\nWHERE (1=1) AND ROWNUM <= 10\n) WHERE (1=1)\n" x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-sparql2sql-1.1-get x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-sparql2sql-1.1-get post: tags: - RDF Graph summary: Translate SPARQL to SQL description: Returns the SQL translation for a SPARQL query. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SEM_APIS.SPARQL_TO_SQL url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-sparql_to_sql.html requestBody: description: A POST request with URL-encoded, ampersand-separated query parameters for SPARQL query (exactly one query parameter, zero or more named-graph-uri parameters, and zero or more default-graph-uri parameters), or a direct POST request with an unencoded SPARQL querystring in the message body to be used with optional default-graph-uri and named-graph-uri query parameters in the request URL. content: application/x-www-form-urlencoded: schema: description: A POST request with URL-encoded, ampersand-separated query parameters for SPARQL query (exactly one query parameter, zero or more named-graph-uri parameters, and zero or more default-graph-uri parameters) type: string examples: query: value: 'query=SELECT%20%3Fs%20%3Fp%20%3Fo%0AWHERE%20%7B%20%3Fs%20%3Fp%20%3Fo%20%7D%0AORDER%20BY%20%3Fs%20%3Fp%20%3Fo%0ALIMIT%202 ' application/sparql-query: schema: description: An unencoded SPARQL query string type: string examples: select: value: 'SELECT ?s ?p ?o WHERE { ?s ?p ?o } ORDER BY ?s ?p ?o LIMIT 2 ' construct: value: "PREFIX : \nCONSTRUCT { ?s ?p ?o }\nWHERE {\n ?s ?p ?o\n FILTER (?s = :john)\n}\n" responses: '200': description: Success content: text/plain: schema: description: The SQL translation of the submitted SPARQL query against the input RDF network and model. type: string example: "SELECT * FROM (\nSELECT /*+ NO_MERGE(R) */ R.S, R.S$RDFVID, R.S$_PREFIX, R.S$_SUFFIX, R.S$RDFVTYP, R.S$RDFCLOB, R.S$RDFLTYP, R.S$RDFLANG,\nR.P, R.P$RDFVID, R.P$_PREFIX, R.P$_SUFFIX, R.P$RDFVTYP, R.P$RDFCLOB, R.P$RDFLTYP, R.P$RDFLANG,\nR.O, R.O$RDFVID, R.O$_PREFIX, R.O$_SUFFIX, R.O$RDFVTYP, R.O$RDFCLOB, R.O$RDFLTYP, R.O$RDFLANG,\nR.SEM$ROWNUM AS SEM$ROWNUM\nFROM (SELECT /*+ NO_MERGE(R) */ R.P$RDFVID, R.P, R.P$RDFVTYP, R.P$_PREFIX, R.P$_SUFFIX, R.P$RDFLTYP, R.P$RDFLANG, R.P$RDFCLOB, R.S$RDFVID, R.S, R.S$RDFVTYP, R.S$_PREFIX, R.S$_SUFFIX, R.S$RDFLTYP, R.S$RDFLANG, R.S$RDFCLOB, R.O$RDFVID, R.O, R.O$RDFVTYP, R.O$_PREFIX, R.O$_SUFFIX, R.O$RDFLTYP, R.O$RDFLANG, R.O$RDFCLOB, ROWNUM AS SEM$ROWNUM\nFROM (\nSELECT V0.VNAME_PREFIX || V0.VNAME_SUFFIX AS P, V0.VALUE_ID AS P$RDFVID, V0.VNAME_PREFIX AS P$_PREFIX, V0.VNAME_SUFFIX AS P$_SUFFIX, (CASE WHEN V0.VALUE_TYPE IS NULL THEN NULL WHEN V0.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V0.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS P$RDFVTYP, TO_CLOB(NULL) AS P$RDFCLOB, V0.LITERAL_TYPE AS P$RDFLTYP, V0.LANGUAGE_TYPE AS P$RDFLANG,\nV1.VNAME_PREFIX || V1.VNAME_SUFFIX AS S, V1.VALUE_ID AS S$RDFVID, V1.VNAME_PREFIX AS S$_PREFIX, V1.VNAME_SUFFIX AS S$_SUFFIX, (CASE WHEN V1.VALUE_TYPE IS NULL THEN NULL WHEN V1.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V1.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS S$RDFVTYP, TO_CLOB(NULL) AS S$RDFCLOB, V1.LITERAL_TYPE AS S$RDFLTYP, V1.LANGUAGE_TYPE AS S$RDFLANG,\nV2.VNAME_PREFIX || V2.VNAME_SUFFIX AS O, V2.VALUE_ID AS O$RDFVID, V2.VNAME_PREFIX AS O$_PREFIX, V2.VNAME_SUFFIX AS O$_SUFFIX, (CASE WHEN V2.VALUE_TYPE IS NULL THEN NULL WHEN V2.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V2.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS O$RDFVTYP, V2.LONG_VALUE AS O$RDFCLOB, V2.LITERAL_TYPE AS O$RDFLTYP, V2.LANGUAGE_TYPE AS O$RDFLANG\nFROM (\nSELECT T0.P_VALUE_ID AS P$RDFVID,\nT0.START_NODE_ID AS S$RDFVID,\nT0.CANON_END_NODE_ID AS O$RDFVID,\nT0.START_NODE_ID AS BGP$1\nFROM (\nSELECT * FROM \"RDFUSER\".NET1#RDFM_M1) T0\nWHERE (1=1)\n) R\n, \"RDFUSER\".NET1#RDF_VALUE$ V0, \"RDFUSER\".NET1#RDF_VALUE$ V1, \"RDFUSER\".NET1#RDF_VALUE$ V2\nWHERE (1=1) AND (R.P$RDFVID = V0.VALUE_ID) AND (R.S$RDFVID = V1.VALUE_ID) AND (R.O$RDFVID = V2.VALUE_ID)\n ORDER BY V1.ORDER_TYPE ASC NULLS FIRST, V1.ORDER_NUM ASC NULLS FIRST, V1.ORDER_DATE ASC NULLS FIRST,\n(V1.VNAME_PREFIX || V1.VNAME_SUFFIX) ASC NULLS FIRST,\nV0.ORDER_TYPE ASC NULLS FIRST, V0.ORDER_NUM ASC NULLS FIRST, V0.ORDER_DATE ASC NULLS FIRST,\n(V0.VNAME_PREFIX || V0.VNAME_SUFFIX) ASC NULLS FIRST,\nV2.ORDER_TYPE ASC NULLS FIRST, V2.ORDER_NUM ASC NULLS FIRST, V2.ORDER_DATE ASC NULLS FIRST,\n(V2.VNAME_PREFIX || V2.VNAME_SUFFIX) ASC NULLS FIRST\n) R\nWHERE (1=1) AND ROWNUM <= 2) R\nWHERE (1=1) AND ROWNUM <= 2\n) WHERE (1=1)\n" x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-sparql2sql-1.1-post x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-sparql2sql-1.1-post /database/rdf/networks/{network_owner},{network_name}/models/{model_name}/graph_store/1.1: parameters: - $ref: '#/components/parameters/NetworkOwner' - $ref: '#/components/parameters/NetworkName' - in: path name: model_name required: true description: The name of the RDF model. schema: type: string example: M1 - in: query name: graph required: false description: A URL-encoded named graph URI schema: type: string example: http%3A%2F%2Fwww.example.oracle.com%2Fg1 - in: query name: default required: false allowEmptyValue: true description: An empty-valued parameter that signifies the default graph. schema: type: string get: tags: - RDF Graph summary: Get a graph description: Retrieves an RDF payload that is the serialization of the requested named graph or default graph. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce. externalDocs: description: SPARQL 1.1 Graph Store HTTP Protocol url: https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/ responses: '200': description: Success content: application/n-triples: schema: externalDocs: description: RDF 1.1 N-Triples url: https://www.w3.org/TR/n-triples/ type: string example: ' "John"@en . "Smith"@en . . . ' x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-graph_store-1.1-get x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-graph_store-1.1-get post: tags: - RDF Graph summary: Append a graph description: Appends the RDF content in the request payload to the target named graph or default graph. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SPARQL 1.1 Graph Store HTTP Protocol url: https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/ requestBody: description: An RDF payload content: application/n-triples: schema: externalDocs: description: RDF 1.1 N-Triples url: https://www.w3.org/TR/n-triples/ type: string example: ' "John"@en . "Smith"@en . . . ' text/turtle: schema: externalDocs: description: RDF 1.1 Turtle url: https://www.w3.org/TR/turtle/ type: string example: "@prefix : .\n:john :fname \"John\"@en ;\n :lname \"Smith\"@en ;\n :job :consultant ;\n :dept: :sales .\n" application/trig: schema: externalDocs: description: RDF 1.1 TriG url: https://www.w3.org/TR/trig/ type: string example: "@prefix : .\n{\n :john :fname \"John\"@en ;\n :lname \"Smith\"@en ;\n :job :consultant ;\n :dept: :sales .\n}\n" responses: '200': description: Success x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-graph_store-1.1-post x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-graph_store-1.1-post put: tags: - RDF Graph summary: Replace a graph description: Deletes all triples in the target named graph or defaut graph and replaces its content with the RDF content in the request payload. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SPARQL 1.1 Graph Store HTTP Protocol url: https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/ requestBody: description: An RDF payload content: application/n-triples: schema: externalDocs: description: RDF 1.1 N-Triples url: https://www.w3.org/TR/n-triples/ type: string example: ' "John"@en . "Smith"@en . . . ' text/turtle: schema: externalDocs: description: RDF 1.1 Turtle url: https://www.w3.org/TR/turtle/ type: string example: "@prefix : .\n:john :fname \"John\"@en ;\n :lname \"Smith\"@en ;\n :job :consultant ;\n :dept: :sales .\n" application/trig: schema: externalDocs: description: RDF 1.1 TriG url: https://www.w3.org/TR/trig/ type: string example: "@prefix : .\n{\n :john :fname \"John\"@en ;\n :lname \"Smith\"@en ;\n :job :consultant ;\n :dept: :sales .\n}\n" responses: '200': description: Success x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-graph_store-1.1-put x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-graph_store-1.1-put delete: tags: - RDF Graph summary: Delete a graph description: Deletes all triples in the target named graph or defaut graph. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: SPARQL 1.1 Graph Store HTTP Protocol url: https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/ responses: '204': description: Success x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-graph_store-1.1-delete x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-graph_store-1.1-delete /database/rdf/networks/{network_owner},{network_name}/models/{model_name}/search: parameters: - $ref: '#/components/parameters/NetworkOwner' - $ref: '#/components/parameters/NetworkName' - $ref: '#/components/parameters/ModelName' - in: query name: search_string required: true description: Full text search string schema: type: string example: software - in: query name: index_scan_limit required: false description: The number of results to return from the initial text index scan (note that this is a random set of the first N rows - not an ordered set of rows based on top N scores). The default value is 5000. Use a value of 0 for an unlimited number of results from the index scan. example: 1000 schema: type: integer format: int32 - in: query name: max_objs_per_search_string required: false description: The maximum number of distinct object values allowed to match the search string. The default value is 100. example: 50 schema: type: integer format: int32 - in: query name: max_results_per_pred_obj required: false description: The maximum number of results allowed for a single (predicate, object) combination. The default value is 25. example: 50 schema: type: integer format: int32 - in: query name: max_results_per_sub required: false description: The maximum number of results allowed for a single subject. The default value is 25. example: 50 schema: type: integer format: int32 - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' get: tags: - RDF Graph summary: Execute full text search description: Performs a full text search over RDF data. Finds subject resources with property values that match the search string. A full text index must be created on the target RDF network before this service can be used. A client requires SQL Developer or RDF Developer role to invoke this servce. externalDocs: description: RDF Full Text Search url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/using-sem_match-table-function-query-rdf-data.html#GUID-7001881A-9DE6-4F3D-8593-F31F2004FE37 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RDFTextSearchResultCollection' example: "{\n \"items\": [\n {\n \"sub\": \"http://example.oracle.com/oracle_corporation\",\n \"vals\": \"third largest software company in the world... a suite of enterprise software products\",\n \"score\": \"14\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/m1/sparql/1.1?query=DESCRIBE%20%3Chttp%3A%2F%2Fexample.oracle.com%2Foracle_corporation%3E\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/m1/search?search_string=software&index_scan_limit=5000&max_objs_per_search_string=100&max_results_per_pred_obj=25&max_results_per_sub=25&offset=0&limit=25\"\n }\n ]\n}\n" x-internal-id: database-rdf-networks-{network_owner},{network_name}-models-{model_name}-search-get x-filename-id: database-rdf-networks-network_owner-network_name-models-model_name-search-get components: parameters: DefaultGraphUri: in: query name: default-graph-uri required: false example: http%3A%2F%2Fwww.example.oracle.com%2Fg1 description: A URL-encoded IRI identifying a named graph that should be included in the DEFAULT graph of the query dataset. schema: type: string Limit: name: limit in: query description: The maximum number of records to return. required: false schema: type: integer format: int32 NetworkOwner: name: network_owner in: path required: true example: RDFUSER description: The owner of the RDF network. schema: type: string Offset: name: offset in: query description: The index of the first record to start returning results for. Used with pagination. required: false schema: type: integer format: int32 NamedGraphUri: in: query name: named-graph-uri required: false example: http%3A%2F%2Fwww.example.oracle.com%2Fg2 description: A URL-encoded IRI identifying a named graph that should be included in the set of named graphs for the query dataset. schema: type: string ModelName: name: model_name in: path required: true example: M1 description: The name of the RDF model. schema: type: string NetworkName: name: network_name in: path required: true example: NET1 description: The name of the RDF network. schema: type: string SparqlOptions: in: query name: options required: false description: A URL-encoded options string. example: ALLOW_DUP=T ALL_LINK_HASH schema: externalDocs: description: See the options argument of SEM_MATCH url: https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/using-sem_match-table-function-query-rdf-data.html#GUID-71464CC4-1C03-48A4-9A4C-0E671FF8F16E type: string schemas: EntailmentDetailCollection: description: A collection of RDF entailment metadata items. type: object properties: items: type: array items: $ref: '#/components/schemas/EntailmentDetailSingle' links: type: array items: $ref: '#/components/schemas/LinkRelation' SparqlXmlResult: externalDocs: description: SPARQL Query Results XML Format url: https://www.w3.org/TR/2013/REC-rdf-sparql-XMLres-20130321/ type: object xml: name: sparql properties: xmlns: type: string example: http://www.w3.org/2005/sparql-results# xml: attribute: true head: type: object xml: name: head properties: variable: type: object xml: name: variable properties: name: type: string example: s xml: attribute: true boolean: type: boolean example: true results: type: object xml: name: results properties: result: type: object xml: name: result properties: binding: type: object xml: name: binding properties: name: type: string example: s xml: attribute: true uri: type: string example: http://www.example.oracle.com/john literal: type: object xml: name: literal properties: xml:lang: type: string example: en xml: attribute: true datatype: type: string example: http://www.w3.org/2001/XMLSchema#integer xml: attribute: true example: John bnode: type: string example: bn1 NetworkElem: type: object description: This object represents a network owner, network name pair. properties: owner: type: string example: RDFUSER description: the owner of the RDF network network_name: type: string example: NET1 description: the name of the RDF network links: type: array items: $ref: '#/components/schemas/LinkRelation' NetworkElemCollection: description: A collection of RDF networks. type: object properties: items: type: array items: $ref: '#/components/schemas/NetworkElem' links: type: array items: $ref: '#/components/schemas/LinkRelation' NetworkDetailElem: description: Metadata for an RDF network. type: object properties: owner: type: string example: RDFUSER description: the owner of the RDF network network_name: type: string example: NET1 description: the name of the RDF network parameters: type: array items: $ref: '#/components/schemas/NetworkParameterElem' links: type: array items: $ref: '#/components/schemas/LinkRelation' RDFTextSearchResultElem: description: A single RDF text search result element. type: object properties: sub: type: string example: description: the subject resource vals: type: string example: third largest software company in the world... a suite of enterprise software products description: an aggregation of text snippets from object values that match the search string score: type: string example: 14 description: the maximum relevance score over all matched object values links: type: array items: $ref: '#/components/schemas/LinkRelation' LinkRelation: type: object properties: rel: type: string href: type: string required: - rel - href SparqlJsonResult: externalDocs: description: SPARQL Query Results JSON Format url: https://www.w3.org/TR/sparql11-results-json/ type: object properties: head: type: object properties: vars: type: array items: type: string boolean: type: boolean results: type: object properties: bindings: type: array items: type: object properties: var: type: object properties: type: type: string value: type: string xml:lang: type: string datatype: type: string RDFTextSearchResultCollection: description: A collection of RDF text search results. type: object properties: items: type: array items: $ref: '#/components/schemas/RDFTextSearchResultElem' links: type: array items: $ref: '#/components/schemas/LinkRelation' VirtualModelDetailCollection: description: A collection of RDF virtual model metadata items. type: object properties: items: type: array items: $ref: '#/components/schemas/VirtualModelDetailSingle' links: type: array items: $ref: '#/components/schemas/LinkRelation' NetworkParameterElem: type: object description: This object represents a metadata attribute and value. properties: namespace: type: string example: NETWORK description: the attribute category attribute: type: string example: COMPRESSION description: the attribute name value: type: string example: COMPRESS=RSCB description: the attribute value description: type: string example: Compression setting for semantic network description: a description of the attribute ModelDetailCollection: description: A collection of RDF model metadata items. type: object properties: items: type: array items: $ref: '#/components/schemas/ModelDetailSingle' links: type: array items: $ref: '#/components/schemas/LinkRelation' ModelDetailSingle: description: Metadata for a single RDF model. type: object properties: owner: type: string example: M1 description: the owner of the model model_id: type: string example: 1 description: the ID of the model model_name: type: string example: M1 description: the name of the model table_name: type: string example: null description: the name of the application table associated with the model (null for schema-private networks) column_name: type: string example: null description: the name of the SDO_RDF_TRIPLE_S column in the application table associated with the model (null for schema-private networks) model_tablespace_name: type: string example: DATA description: the tablespace used to store model data model_type: type: string example: M description: the type of model (M for regular model; V for virtual model; X for model created to store the contents of the semantic index; or D for model created on relational data) inmemory: type: string example: F description: indicates if the model is an in-memory virtual model (T for in-memory, or F for not in-memory) links: type: array items: $ref: '#/components/schemas/LinkRelation' EntailmentDetailSingle: type: object description: This object represents metadata about an RDF entailment. properties: owner: type: string example: RDFUSER description: the owner of the entailment index_name: type: string example: M1OWL description: the name of the entailment index_view_name: type: string example: NET1#RDFI_M1OWL description: the name of the database view that contains the entailed triples status: type: string example: VALID description: the status of the entailment (VALID if the entailment is valid, INVALID if the entailment is not valid, INCOMPLETE if the entailment is incomplete - similar to INVALID but requiring less time to re-create, INPROGRESS if the entailment is being created, or FAILED if a system failure occurred during the creation of the entailment) model_count: type: string example: 1 description: the number of models used to build the entailment rulebase_count: type: string example: 1 description: the number of rulebases used to build the entailment datasets: type: string example: MODEL M1, RULEBASE OWLPRIME description: a comma-delimited list of the names of models and rulebases used to build the entailment links: type: array items: $ref: '#/components/schemas/LinkRelation' VirtualModelDetailSingle: description: Metadata for a single virtual model. type: object properties: owner: type: string example: RDUSER description: owner of the virtual model virtual_model_name: type: string example: VM1 description: name of the virtual model unique_view_name: type: string example: NET1#SEMU_VM1 description: name of the view that contains unique triples in the virtual model, or null if the view was not created duplicate_view_name: type: string example: NET1#SEMV_VM1 description: name of the view that contains duplicate triples (if any) in the virtual model status: type: string example: VALID description: contains VALID if the associated entailment is valid, INVALID if the entailment is not valid, INCOMPLETE if the entailment is incomplete (similar to INVALID but requiring less time to re-create), INPROGRESS if the entailment is being created, FAILED if a system failure occurred during the creation of the entailment, or NORIDX if no entailment is associated with the virtual model. In the case of multiple entailments, the lowest status among all of the component entailments is used as the virtual model's status (INVALID < INCOMPLETE < VALID). model_count: type: string example: 1 description: number of models contained in the virtual model rulebase_count: type: string example: 1 description: number of rulebases contained in the virtual model rules_index_count: type: string example: 1 description: number of entailments contained in the virtual model datasets: type: string example: MODEL M1, RULEBASE OWLPRIME, RULEIDX M1OWL description: a comma-delimited list of the names of models, rulebases and entailments used to build the virtual model links: type: array items: $ref: '#/components/schemas/LinkRelation' requestBodies: createEntailment: content: application/json: schema: type: object properties: models: type: array items: type: string description: List of models to use for the entailment rulebases: type: array items: type: string example: OWLPRIME description: List of rulebases to use for the entailment inf_components: type: array items: type: string description: List of keywords representing inference components, for performing selective or component-based inferencing (the default is all components defined by the included rulebases) options: type: string description: A comma-delimited string of options to control the inference process by overriding the default inference behavior required: - models - rulebases examples: basic_entailment: summary: This is an example of creating an entailment using an ontology model (TBOX), a data model (ABOX), and the OWL2RL rulebase. value: models: - TBOX - ABOX rulebases: - OWL2RL entailment_with_options: summary: This is an example of creating an OWL2 RL entailment using a degree of parallelism of 16 and without generating extra assertions for individuals based on owl:sameAs. value: models: - M1 rulebases: - OWL2RL inf_components: - SAM- options: DOP=16 createNetwork: content: application/json: schema: type: object properties: tablespace_name: type: string description: The name of the tablespace in which to create the RDF network options: type: string description: Options to use when creating the RDF network examples: default: summary: This is an example of basic network creation. value: tablespace_name: DATA partitioned: summary: This is an example of creating a list-hash subpartitioned network with 16 subpartitions per model. value: tablespace_name: DATA options: MODEL_PARTITIONING=BY_HASH_P MODEL_PARTITIONS=16 createVirtualModel: content: application/json: schema: type: object properties: models: type: array items: type: string example: M1 description: List of models to use for the virtual model rulebases: type: array items: type: string description: List of rulebases to use for the virtual model entailments: type: array items: type: string description: List of entailments to use for the virtual model (only one of rulebases or entailments can be non-null) options: type: string description: options for virtual model creation required: - models examples: basic_mod_vm: summary: This is an example of creating a virtual model consisting of two models. Option REPLACE=T is used for CREATE OR REPLACE behavior. value: models: - M1 - M2 options: REPLACE=T basic_rb_vm: summary: This is an example of creating a virtual model with a set of models and a rulebase. Note that an entailment must be pre-created for the model-rulebase combination. value: models: - TBOX - ABOX rulebases: - OWL2RL baisc_ent_vm: summary: This is an example of creating a virtual model with a set of models and an entailment. Note that, unlike rulebases, there no constraints limiting model and entailment combinations. value: models: - SCHEMA_MODEL - DATA_MODEL entailments: - SCHEMA_ENTAILMENT createModel: content: application/json: schema: type: object properties: tablespace_name: type: string description: The name of the tablespace in which to create the RDF model options: type: string description: Options to use when creating the RDF model examples: supplied_tbs: summary: This is an example of creating a model in a specific tablespace (MY_TBS). By default a model is created in the tablespace used for network creation. value: tablespace_name: MY_TBS compression: summary: This is an example of creating a model with Advanced Row Compression (ROW STORE COMPRESS ADVANCED). value: options: COMPRESS=RSCA securitySchemes: BasicAuth: type: http scheme: basic BearerAuth: type: http scheme: bearer OAuth2: type: oauth2 flows: implicit: authorizationUrl: /oauth/auth scopes: {} authorizationCode: authorizationUrl: /oauth/auth tokenUrl: /oauth/token scopes: {} clientCredentials: tokenUrl: /oauth/token scopes: {} externalDocs: description: Oracle REST Data Services product documentation. url: https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/