OpenAPI Specification
openapi: 3.0.1
info:
title: Stardog HTTP Checkpoints Transactions API
description: "# Overview\nStardog supports the standard SPARQL Protocol HTTP bindings, as well as additional functionality via HTTP.\nStardog also supports SPARQL 1.1’s Service Description format. See the [spec](https://www.w3.org/TR/sparql11-service-description/) if you want details.\n### Generating URLs\nIf you are running the HTTP server at\n\n ```http://localhost:12345```\n\nTo form the URI of a particular Stardog Database, the Database Short Name is the first URL path segment appended to the deployment URI. For example, for the Database called `cytwombly`, deployed in the above example HTTP server, the Database Network Name might be\n\n```http://localhost:12345/cytwombly```\n\nAll the resources related to this database are identified by URL path segments relative to the Database Network Name; hence:\n\n```http://localhost:12345/cytwombly/size```\n# Error Codes\nHere are explanations of what the various error codes mean:\n\nError Code | Category | Meaning\n-----------|----------|---------\n000012 | GENERIC |UNKNOWN\n000IA2 | GENERIC |ILLEGAL_ARGUMENT\n000SD4 | GENERIC |SHUTTING_DOWN\n00PCE2 | GENERIC |PROCESS_CANCELLED\n00PE2 | GENERIC |PROCESS_EXISTS\n00PNE2 | GENERIC |PROCESS_NOT_FOUND\n00UOE2 | GENERIC |UNSUPPORTED_OPERATION\n0D0012 | DATABASE |UNKNOWN_DATABASE_EXCEPTION\n0D0CE3 | DATABASE |DATABASE_CONSISTENCY_EXCEPTION\n0D0DC2 | DATABASE |DATABASE_CONFLICT\n0D0DE2 | DATABASE |DATABASE_EXISTS\n0D0DU2 | DATABASE |DATABASE_UNKNOWN\n0D0TU2 | DATABASE |TRANSACTION_UNKNOWN\n0DICC2 | DATABASE |INVALID_CONFIGURATION\n0DIDN2 | DATABASE |INVALID_DATABASE_NAME\n0DIDS2 | DATABASE |INVALID_DATABASE_STATE\nCLNIC3 | CLUSTER_ERROR |NOT_IN_CLUSTER\nCLOEF3 | CLUSTER_ERROR |EXPEL_FAILED\nHS0012 | HTTP |UNKNOWN_CONNECTION_EXCEPTION\nHSJSE2 | HTTP |JSON_SYNTAX_EXCEPTION\nHSJSO2 | HTTP |JSON_EXCEPTION\nHSSSL3 | HTTP |SSL_EXCEPTION\nQE0012 | QUERY_EXECUTION |UNKNOWN_QUERY_EXCEPTION\nQE0FE2 | QUERY_EXECUTION |FUNCTION_EXISTS\nQE0PE2 | QUERY_EXECUTION |PARSE_EXCEPTION\nQE0QE2 | QUERY_EXECUTION |QUERY_EXISTS\nQECTP2 | QUERY_EXECUTION |CANNOT_TRANSLATE_PLAN\nQEFNF2 | QUERY_EXECUTION |FUNCTION_NOT_FOUND\nQEIQT2 | QUERY_EXECUTION |INVALID_QUERY_TYPE\nQEIVR2 | QUERY_EXECUTION |INVALID_RDF\nQEMAQ2 | QUERY_EXECUTION |MALFORMED_QUERY\nQEONS2 | QUERY_EXECUTION |OPERATION_NOT_SUPPORTED\nQEQNF2 | QUERY_EXECUTION |QUERY_NOT_FOUND\nQEQOE2 | QUERY_EXECUTION |OPERATOR_EXCEPTION\nQEQPE2 | QUERY_EXECUTION |QUERY_PARSE_EXCEPTION\nQEWCE2 | QUERY_EXECUTION |WRITE_CONFLICT_EXCEPTION\nSE0012 | SECURITY |UNKNOWN_SECURITY_EXCEPTION\nSE0IP2 | SECURITY |ILLEGAL_PASSWORD\nSE0RE2 | SECURITY |SECURITY_RESOURCE_EXISTS\nSEAEE2 | SECURITY |AUTHENTICATION_EXCEPTION\nSEAOE2 | SECURITY |AUTHORIZATION_EXCEPTION\nSEIPT2 | SECURITY |INCORRECT_PRINCIPAL_TRANSACTION\nSERIU2 | SECURITY |SECURITY_RESOURCE_IN_USE\nSERNF2 | SECURITY |SECURITY_RESOURCE_NOT_FOUND\nSERNI2 | SECURITY |SECURITY_RESOURCE_NAME_INVALID\nSERTI2 | SECURITY |SECURITY_RESOURCE_TYPE_INVALID\nZK0013 | ZOOKEEPER_ERROR |ZOOKEEPER_UNKNOWN_EXCEPTION\nZK00U3 | ZOOKEEPER_ERROR |UNIMPLEMENTED\nZK0AE3 | ZOOKEEPER_ERROR |API_ERROR\nZK0AF3 | ZOOKEEPER_ERROR |AUTH_FAILED\nZK0BV3 | ZOOKEEPER_ERROR |BAD_VERSION\nZK0CE3 | ZOOKEEPER_ERROR |NO_CHILDREN_FOR_EPHEMERAL\nZK0CL3 | ZOOKEEPER_ERROR |CONNECTION_LOSS\nZK0CR3 | ZOOKEEPER_ERROR |ZOOKEEPER_CONNECTION_REFUSED\nZK0DI3 | ZOOKEEPER_ERROR |DATA_INCONSISTENCY\nZK0IA3 | ZOOKEEPER_ERROR |BAD_ARGUMENTS\nZK0ME3 | ZOOKEEPER_ERROR |MARSHALLING_ERROR\nZK0NA3 | ZOOKEEPER_ERROR |NO_AUTH\nZK0NE3 | ZOOKEEPER_ERROR |NODE_EXISTS\nZK0NN3 | ZOOKEEPER_ERROR |NO_NODE\nZK0OT3 | ZOOKEEPER_ERROR |OPERATION_TIMEOUT\nZK0RI3 | ZOOKEEPER_ERROR |RUNTIME_INCONSISTENCY\nZK0SE3 | ZOOKEEPER_ERROR |SYSTEM_ERROR\nZK0SM3 | ZOOKEEPER_ERROR |SESSION_MOVED\nZKEXS3 | ZOOKEEPER_ERROR |SESSION_EXPIRED\nZKIAL3 | ZOOKEEPER_ERROR |INVALIDACL\nZKICB3 | ZOOKEEPER_ERROR |INVALID_CALLBACK\nZKNEY3 | ZOOKEEPER_ERROR |NOT_EMPTY\nZKNRO3 | ZOOKEEPER_ERROR |NOT_READONLY\n"
contact:
url: https://stardog.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0
version: 12.0.3
x-logo:
url: https://d33wubrfki0l68.cloudfront.net/66e9dcff51317cfc11b9f3d4ce2917a11ba81681/543c1/img/stardog-logo-optimized.svg
servers:
- url: http://localhost:5820
tags:
- name: Transactions
description: Transactional operations
paths:
/{db}/transaction/begin:
post:
tags:
- Transactions
summary: Begin a transaction
operationId: beginTransaction
parameters:
- name: db
$ref: '#/components/parameters/db'
responses:
'200':
description: Operation successful
content:
text/plain:
example: 067e6162-3b6f-4ae2-a171-2470b63dff00
'404':
description: Database does not exist
content:
application/json:
schema:
required:
- message
- code
properties:
message:
type: string
example: Database does not exist
code:
type: string
example: 0D0DU2
x-sort-order:
group: '1'
order: '1'
/{db}/transaction/begin/{txid}:
post:
tags:
- Transactions
summary: Begin a transaction with specified txid
operationId: beginTx
parameters:
- name: db
$ref: '#/components/parameters/db'
- name: txid
$ref: '#/components/parameters/txid'
responses:
'200':
description: Transaction begun
content:
text/plain:
example: 067e6162-3b6f-4ae2-a171-2470b63dff00
'404':
description: Database/Transaction does not exist
content:
application/json:
schema:
required:
- message
- code
properties:
message:
type: string
example: Database does not exist
code:
type: string
example: 0D0DU2
x-sort-order:
group: '1'
order: '2'
/{db}/transaction/commit/{txid}:
post:
tags:
- Transactions
summary: Commit a transaction
operationId: commitTransaction
parameters:
- name: db
$ref: '#/components/parameters/db'
- name: txid
$ref: '#/components/parameters/txid'
responses:
'200':
description: Commit successful
content:
application/json:
schema:
$ref: '#/components/schemas/COMMIT_RESULT'
'404':
description: Database/Transaction does not exist
content:
application/json:
schema:
required:
- message
- code
properties:
message:
type: string
example: Database does not exist
code:
type: string
example: 0D0DU2
x-sort-order:
group: '1'
order: '3'
/{db}/transaction/rollback/{txid}:
post:
tags:
- Transactions
summary: Rollback a transaction
operationId: rollbackTransaction
parameters:
- name: db
$ref: '#/components/parameters/db'
- name: txid
$ref: '#/components/parameters/txid'
responses:
'200':
$ref: '#/components/responses/EMPTY_SUCCESS'
'404':
description: Database/Transaction does not exist
content:
application/json:
schema:
required:
- message
- code
properties:
message:
type: string
example: Database does not exist
code:
type: string
example: 0D0DU2
x-sort-order:
group: '1'
order: '4'
/{db}/{txid}/clear:
post:
tags:
- Transactions
summary: Clear database within a transaction
operationId: clearDatabasesInTx
parameters:
- name: db
$ref: '#/components/parameters/db'
- name: txid
$ref: '#/components/parameters/txid'
- $ref: '#/components/parameters/graph-uri'
responses:
'200':
$ref: '#/components/responses/EMPTY_SUCCESS'
'404':
description: Database/Transaction does not exist
content:
application/json:
schema:
required:
- message
- code
properties:
message:
type: string
example: Database does not exist
code:
type: string
example: 0D0DU2
/{db}/{txid}/remove:
post:
tags:
- Transactions
summary: Remove data within a transaction
operationId: removeDataInTx
parameters:
- name: db
$ref: '#/components/parameters/db'
- name: txid
$ref: '#/components/parameters/txid'
- $ref: '#/components/parameters/graph-uri'
requestBody:
content:
text/turtle:
schema:
type: String
examples:
GENERIC_TURTLE:
description: GENERIC_TURTLE
value: null
$ref: '#/components/examples/GENERIC_TURTLE'
application/trig:
schema:
type: String
examples:
GENERIC_TRIG:
description: GENERIC_TRIG
value: null
$ref: '#/components/examples/GENERIC_TRIG'
application/rdf+xml:
schema:
type: String
examples:
GENERIC_RDFXML:
description: GENERIC_RDFXML
value: null
$ref: '#/components/examples/GENERIC_RDFXML'
application/n-triples:
schema:
type: String
examples:
GENERIC_NTRIPLES:
description: GENERIC_NTRIPLES
value: null
$ref: '#/components/examples/GENERIC_NTRIPLES'
application/n-quads:
schema:
type: String
examples:
GENERIC_NQUADS:
description: GENERIC_NQUADS
value: null
$ref: '#/components/examples/GENERIC_NQUADS'
application/ld+json:
schema:
$ref: '#/components/schemas/GENERIC_JSONLD'
required: true
responses:
'200':
$ref: '#/components/responses/EMPTY_SUCCESS'
'404':
description: Database/Transaction does not exist
content:
application/json:
schema:
required:
- message
- code
properties:
message:
type: string
example: Database does not exist
code:
type: string
example: 0D0DU2
/{db}/{txid}/add:
post:
tags:
- Transactions
summary: Add data within a transaction
operationId: addDataInTx
parameters:
- name: db
$ref: '#/components/parameters/db'
- name: txid
$ref: '#/components/parameters/txid'
- $ref: '#/components/parameters/graph-uri'
- $ref: '#/components/parameters/header_content_encoding'
requestBody:
content:
text/turtle:
schema:
type: String
examples:
GENERIC_TURTLE:
description: GENERIC_TURTLE
value: null
$ref: '#/components/examples/GENERIC_TURTLE'
application/trig:
schema:
type: String
examples:
GENERIC_TRIG:
description: GENERIC_TRIG
value: null
$ref: '#/components/examples/GENERIC_TRIG'
application/rdf+xml:
schema:
type: String
examples:
GENERIC_RDFXML:
description: GENERIC_RDFXML
value: null
$ref: '#/components/examples/GENERIC_RDFXML'
application/n-triples:
schema:
type: String
examples:
GENERIC_NTRIPLES:
description: GENERIC_NTRIPLES
value: null
$ref: '#/components/examples/GENERIC_NTRIPLES'
application/n-quads:
schema:
type: String
examples:
GENERIC_NQUADS:
description: GENERIC_NQUADS
value: null
$ref: '#/components/examples/GENERIC_NQUADS'
application/ld+json:
schema:
$ref: '#/components/schemas/GENERIC_JSONLD'
required: true
responses:
'200':
$ref: '#/components/responses/EMPTY_SUCCESS'
'404':
description: Database/Transaction does not exist
content:
application/json:
schema:
required:
- message
- code
properties:
message:
type: string
example: Database does not exist
code:
type: string
example: 0D0DU2
/{db}/transaction:
get:
tags:
- Transactions
summary: List all open transactions on a database
operationId: listTransactions
parameters:
- name: db
$ref: '#/components/parameters/db'
responses:
'200':
description: Operation successful
content:
application/json:
schema:
$ref: '#/components/schemas/TRANSACTION'
'404':
description: Database does not exist
content:
application/json:
schema:
required:
- message
- code
properties:
message:
type: string
example: Database does not exist
code:
type: string
example: 0D0DU2
components:
parameters:
txid:
name: txid
in: path
description: Transaction ID
required: true
schema:
type: string
format: uuid
example: 4ea1ebac-48f0-459c-a9a7-6cad7189403d
header_content_encoding:
name: Content-Encoding
in: header
description: Allowable encodings for request body
schema:
type: string
enum:
- NONE
- GZIP
- BZIP2
- ZIP
db:
name: db
in: path
description: Database name
required: true
schema:
type: string
example: myDb
graph-uri:
name: graph-uri
in: query
description: Named Graph / Context
required: false
schema:
type: string
format: URI
example: https://stardog.com/graphs/myGraph
examples:
GENERIC_NQUADS:
value: '<urn:context> <urn:example:Entity1> a <urn:example:Entity> .
<urn:context> <urn:example:Entity1> <urn:example:hasProp> 42 .'
GENERIC_TURTLE:
value: "@prefix : <urn:example:> .\n@prefix owl: <http://www.w3.org/2002/07/owl#> .\n@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .\n@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .\n@prefix stardog: <tag:stardog:api:> .\n@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .\n\n<urn:example:Entity1> a <urn:example:Entity> ;\n\t<urn:example:hasProp> 42 ."
GENERIC_NTRIPLES:
value: '<urn:example:Entity1> a <urn:example:Entity> .
<urn:example:Entity1> <urn:example:hasProp> 42 .'
GENERIC_RDFXML:
value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<rdf:RDF\n\txmlns=\"http://api.stardog.com/\"\n\txmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\n\txmlns:owl=\"http://www.w3.org/2002/07/owl#\"\n\txmlns:rdfs=\"http://www.w3.org/2000/01/rdf-schema#\"\n\txmlns:stardog=\"tag:stardog:api:\"\n\txmlns:xsd=\"http://www.w3.org/2001/XMLSchema#\">\n\n<rdf:Description rdf:about=\"urn:example:Entity1\">\n\t<rdf:type rdf:resource=\"urn:example:Entity\"/>\n\t<hasProp xmlns=\"urn:example:\" rdf:datatype=\"http://www.w3.org/2001/XMLSchema#integer\">42</hasProp>\n</rdf:Description>\n\n</rdf:RDF>"
GENERIC_TRIG:
value: "@prefix : <urn:example:> .\n@prefix owl: <http://www.w3.org/2002/07/owl#> .\n@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .\n@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .\n@prefix stardog: <tag:stardog:api:> .\n@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .\n\n{ \t<urn:example:Entity1> a <urn:example:Entity> ;\n\t\t <urn:example:hasProp> 42 .\n}"
schemas:
COMMIT_RESULT:
required:
- added
- removed
properties:
added:
type: integer
description: Approximate number of triples added
format: int32
example: 42
removed:
type: integer
description: Approximate number of triples removed
format: int32
example: 29
TRANSACTION:
required:
- transactions
properties:
transactions:
type: array
items:
required:
- id
- db
- user
- startTime
properties:
id:
type: string
format: uuid
example: 4ea1ebac-48f0-459c-a9a7-6cad7189403d
db:
type: string
example: myDb
user:
type: string
example: admin
startTime:
type: integer
description: Unix timestamp when transaction started
format: int64
example: 1579812754096
status:
type: string
example: IDLE
GENERIC_JSONLD:
properties:
'@id':
type: string
example: urn:example:Entity1
'@type':
type: string
example: urn:example:Entity
urn:example:hasProp:
required:
- '@id'
type: array
items:
required:
- '@value'
properties:
'@type':
type: string
example: http://www.w3.org/2001/XMLSchema#integer
'@value':
type: string
example: '42'
responses:
EMPTY_SUCCESS:
description: Operation successful
externalDocs:
url: https://docs.stardog.com
x-tagGroups:
- name: Data Unification
tags:
- Data Sources
- Virtual Graphs
- name: Virtual Graphs External Compute
tags:
- Virtual Graphs External Compute
- name: Server
tags:
- Monitoring
- Stored Functions
- Server Status/Metrics
- Server Admin
- Queries
- Cluster Admin
- name: Database
tags:
- Checkpoints
- DB Admin
- Integrity Constraints / SHACL
- Data Caching
- Graph Store Protocol
- Matcher, aligning schemas from various data sources
- Reasoning
- Transactions
- GraphQL
- SPARQL
- EntityResolution
- name: Security
tags:
- Roles
- Permissions
- Users
- name: Knowledge Catalog
tags:
- Knowledge Catalog