HTTP Reference | AllegroGraph 8.4.0 (original) (raw)

Introduction

This document lists all HTTP services, along with some documentation. See REST/HTTP interface for further documentation.

URL Summary

Server based HTTP services

These services operate on the server itself. These include user and role management, general settings and starting sessions.

catalogs get
/ [CATNAME] put delete
/ protocol get
/ repositories get
/ [REPOSITORY] put delete
/ auto/optimize/message get
/ start put
/ status get
/ stop put
/ backup post
/ ensureNotLingering post
/ exists get
/ namespaces get delete
/ [PREFIX] post put get delete
/ query-options get delete
/ [NAME] post put get delete
/ repl/controllingInstance put
/ createCluster put
/ growCluster put
/ priority post
/ quiesce put
/ remove put
/ settings get post
/ start put
/ status get
/ stop put
/ retain put
/ scripts get
/ [NAME] get put delete
/ session post
/ shutdown post
/ warmstandby get put delete
/ jobnames get
/ registerJobname post
/ startServer post
/ switchRole post
/ unregisterJobname post
config/fti-stop-words get
configfile get
configfiles get
databricks/available-tables get
/ clean delete
/ download-csv put
/ export-table/cancel delete
/ exec put
/ result get
/ list-files get
/ profiles get
/ statement/cancel delete
/ exec put
/ result get
/ warehouses get
fedshard/define get put delete
/ delete-metadata delete
gruff/install put
/ list/available get
/ installed get
/ set-active put
/ uninstall delete
hostname get
initfile get put delete
job get
jobs get delete
jobsNumber get
largeOperationWarning get put
logfile get
lookup-embedder get
lookup-llm get
namespaces get
nd/computeSubtype get
processes get
/ [NAME] delete
/ pidName get
/ stacktrace get
/ telnet post
protocol get
queryPlanners get
reconfigure post
reopenLog post
repositories get
/ [REPOSITORY] put delete
/ auto/optimize/message get
/ start put
/ status get
/ stop put
/ backup post
/ ensureNotLingering post
/ exists get
/ namespaces get delete
/ [PREFIX] post put get delete
/ query-options get delete
/ [NAME] post put get delete
/ repl/controllingInstance put
/ createCluster put
/ growCluster put
/ priority post
/ quiesce put
/ remove put
/ settings get post
/ start put
/ status get
/ stop put
/ retain put
/ scripts get
/ [NAME] get put delete
/ session post
/ shutdown post
/ warmstandby get put delete
/ jobnames get
/ registerJobname post
/ startServer post
/ switchRole post
/ unregisterJobname post
requests get
roles get
/ [NAME] put delete
/ access get put delete
/ attributes get put delete
/ color get put delete
/ permissions get
/ [TYPE] get put delete
/ security-filters/ [TYPE] get post delete
scheduler/createEvent post
/ deleteEvents put
/ events get
/ log get put
scripts get
/ [NAME] get put delete
serverWarnings get post delete
session get post
systemstat.json get
token get delete
/ list get
users get put
/ [NAME] put delete
/ access get put delete
/ attributes get put delete
/ color get put delete
/ data get delete
/ [KEY] get put delete
/ effectiveAccess get
/ effectiveColors get
/ effectivePermissions get
/ gruff-queries get
/ [KEY] get put delete
/ loginTimeout get
/ password post
/ permissions get
/ [TYPE] get put delete
/ roles get
/ [ROLE] put delete
/ security-filters/ [TYPE] get post delete
uuids get
version get
/ date get
/ full get
/ revision get
webview/version get put
/ versions get

Repository based HTTP services

These services operate against a particular store or session.

catalogs/ [CATNAME] /repositories/ [REPONAME] get post
/ access get
/ add-object put
/ attributes/definitions get post delete
/ staticFilter get post delete
/ backup-stream post
/ begin post
/ blankNodes post
/ bulkMode get put delete
/ clusterings put
/ commit post
/ contexts get
/ convert-to-vts put
/ createSecondaryIndices get put delete
/ data-generator/patient post
/ phoneCall post
/ shacl get
/ delete-objects put
/ encodedIds post
/ prefixes get post delete
/ hasAny get
/ isInUse get
/ isRegistered get
/ eval post
/ exec-nl-query get
/ expected-store-size get
/ freetext get post
/ indices get
/ [INDEXNAME] get post put delete
/ borderChars get
/ graphs get
/ indexFields get
/ indexLiterals get
/ indexResources get
/ innerChars get
/ minimumWordSize get
/ predicates get
/ stopWords get
/ tokenizer get
/ types get
/ wordFilters get
/ functor post
/ geo/box get
/ circle get
/ haversine get
/ polygon get put
/ types get post
/ cartesian post
/ id get
/ spherical post
/ geosparql/buildGeohashIndex post
/ rebuildGeohashIndex post
/ getPreparedTransactions get
/ graphql post
/ indices get
/ [TYPE] put delete
/ chunks get
/ optimize post
/ jobs get
/ [JOB-ID] delete
/ purge-deleted-triples post delete
/ llm-index put
/ llm-list get
/ llm-split put
/ load-csv put
/ lock post delete
/ mapping get delete
/ all delete
/ predicate post put get delete
/ cartesian post
/ spherical post
/ type post put get delete
/ cartesian post
/ spherical post
/ materializeEntailed put delete
/ metadata get post
/ mongoParameters get post
/ namespaces get delete
/ [PREFIX] post put get delete
/ nd/geospatialDatatypeAutomation get put delete
/ nearest-neighbor get
/ needsCommit get
/ neighborMatrices/ [NAME] put
/ nl-queries get post delete
/ missing-fields get put
/ total get
/ nlq-vdb put delete
/ nlq-vdbs get
/ noCommit get put delete
/ object-embedding get
/ object-property-value get
/ object-text get
/ queries/ [NAME] get post delete
/ query-options get delete
/ [NAME] post put get delete
/ queryResultsCache get delete
/ rdf-star get put delete
/ reports get
/ rollback post
/ session/autoCommit get post
/ close post
/ description get
/ isActive get
/ ping get
/ settings/purge-rate-limit get post
/ shacl-shapes get put delete
/ shard-info get
/ shards get
/ [ID] /attributes/definitions get post delete
/ staticFilter get post delete
/ clusterings put
/ convert-to-vts put
/ data-generator/patient post
/ phoneCall post
/ getPreparedTransactions get
/ indices/optimize post
/ jobs/purge-deleted-triples post delete
/ lock post delete
/ metadata get post
/ nearest-neighbor get
/ noCommit get put delete
/ object-embedding get
/ object-property-value get
/ object-text get
/ reports get
/ rollback post
/ settings/purge-rate-limit get post
/ shard-info get
/ split-shard put
/ statements/duplicates get delete
/ storage-report get
/ storeID get put
/ tlog/locker get
/ uuid get
/ validate/shacl get
/ vector-store-import put
/ vector-store-p get
/ warmup put
/ size get
/ sna/paths get
/ snaGenerators/ [NAME] put
/ solrParameters get post
/ sparql get post
/ spin/function get
/ [URI] get put delete
/ magicproperty get
/ [URI] get put delete
/ split-shard put
/ statement put
/ statements post put get delete
/ delete post
/ duplicates get delete
/ id get
/ query get post
/ transform post put
/ storage-report get
/ storeID get put
/ string-table-size get
/ suppressDuplicates get put delete
/ tlog/locker get
/ tripleCache get put delete
/ unique/ [COLUMN] get post
/ useSecondaryIndices get put delete
/ uuid get
/ validate/shacl get
/ vector-store-import put
/ vector-store-p get
/ warmup put
close post

Front end

catalogs get

Returns a set of catalogs that are available on this server. For each catalog, id and uri properties are returned, giving respectively the name of the catalog and the URL under which it is found. Properties named readable and writable indicate, for each catalog, whether the current user has read or write access to at least one repository in it. When repoCount is true, also include the number of repositories for each catalog.

arguments

catalogs / [CATNAME] put

If dynamic catalogs are enabled for the server (see the DynamicCatalogs directive), this can be used to create a new catalog.

arguments

catalogs / [CATNAME] delete

Deletes a catalog. Only dynamic catalogs (those created through HTTP) can be deleted in this way.

catalogs / [CATNAME] / protocol get

Returns the protocol version of the Sesame interface. The protocol described in this document is 4.

catalogs / [CATNAME] / repositories get

Return a list of repositories available in the catalog.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] put

Creates a new, empty repository.

When a repository with the given name already exists, it is overwritten, unless a parameter override with value false is passed.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] delete

Delete the specified repository. This can fail if the repository is being accessed by another client.

catalogs / [CATNAME] / repositories / [REPOSITORY] / auto / optimize / message get

Return the last message written by the automatic optimizer

catalogs / [CATNAME] / repositories / [REPOSITORY] / auto / optimize / start put

Start automatic optimization on this repository

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / auto / optimize / status get

Return whether the auto optimizer is running or stopped

catalogs / [CATNAME] / repositories / [REPOSITORY] / auto / optimize / stop put

Stop automatic optimization on this repository

catalogs / [CATNAME] / repositories / [REPOSITORY] / backup post

Create a backup of the repository.

catalogs / [CATNAME] / repositories / [REPOSITORY] / ensureNotLingering post

To conserve resources, makes the database instance and its child processes exit if the instance is unused. Takes no arguments, returns nothing.

Normally unused database instances linger for InstanceTimeout seconds to speed up subsequent open operations.

catalogs / [CATNAME] / repositories / [REPOSITORY] / exists get

Return true if the triple-store exists and is accessible to the current user.

Will return an HTTP 401 (Unauthorized) if the user is not authorized to read from the requested catalog and an HTTP 404 (Not Found) if the user is authorized but the store does not exist.

catalogs / [CATNAME] / repositories / [REPOSITORY] / namespaces get

Return the currently active namespaces for the current user in this repository.

The namespaces are returned as tuples with fields prefix and namespace (as well as type and shadowed if effective is false, where type is one of default, repository or user and shadowed indicates whether the option is shadowed by a higher priority definition.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / namespaces delete

Deletes all namespaces of the specified type.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / namespaces / [PREFIX] post put

Create or update a namespace.

The body of the request must contain the namespace for the prefix as plain text.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / namespaces / [PREFIX] get

Returns the namespace defined for the given prefix.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / namespaces / [PREFIX] delete

Delete a namespace.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / query-options get

Return the currently active query-options for the current user in this repository.

The query-options are returned as tuples with fields name and value (as well as type and shadowed if effective is false, where type is one of default, repository or user and shadowed indicates whether the option is shadowed by a higher priority definition.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / query-options delete

Deletes all query-options of the specified type.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / query-options / [NAME] post put

Create or update a query-option.

The body of the request must contain the value for the name as plain text.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / query-options / [NAME] get

Returns the value defined for the given name.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / query-options / [NAME] delete

Delete a query-option.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / repl / controllingInstance put

Specify the name of the new controlling instance. This command must be sent to the current controlling instance. If the current controlling instance is down then it can be sent to any instance if 'force' is specified as 'true'

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / repl / createCluster put

Create the first instance of a replication cluster.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / repl / growCluster put

add instance to cluster

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / repl / priority post

Set the priorities between instances and groups.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / repl / quiesce put

Control whether commits are permitted and whether to wait until the instance is up to date with commits

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / repl / remove put

Permanently remove an instance from the cluster. The command is sent to the controlling instance.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / repl / settings get

Return the current settings of repl parameters

catalogs / [CATNAME] / repositories / [REPOSITORY] / repl / settings post

Set the values of replication parameters and return all of the settings.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / repl / start put

Restart a stopped instance in the cluster. If the instanceName argument is given then that instance is started. If instanceName is not given then the instance started is the one to which the command is sent.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / repl / status get

Return the status of the instance.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / repl / stop put

Stops an instance. The instance will receive no commits from other instances and no commits can be done on this instance. This instance can be restarted unless undo-repl is true. The instance named by instanceName is stopped. If instanceName is not given the the instance to which the command is sent is stopped.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / retain put

Specify which transaction log files must be retained

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / scripts get

Return the list of scripts that have been added to this repository.

catalogs / [CATNAME] / repositories / [REPOSITORY] / scripts / [NAME] get

Return the contents of the script NAME in this repository.

catalogs / [CATNAME] / repositories / [REPOSITORY] / scripts / [NAME] put

Add or replace the script NAME in this repository with the contents of the body.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / scripts / [NAME] delete

Delete the script NAME in this repository.

catalogs / [CATNAME] / repositories / [REPOSITORY] / session post

Starts a new session for the repository.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / shutdown post

Closes respository. Sends close to each shared backend, but does not attempt to close open sessions.

If ensureNotLingering is passed it will first turn on the respective option in service-daemon so that closing the repository causes repository and its child processes to exit instantly.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / warmstandby get

Returns a representation of the current standby status for repository.

Only supports an application/json accept type.

catalogs / [CATNAME] / repositories / [REPOSITORY] / warmstandby put

Set up warm-standby on this repository.

Requires jobname, primary, primaryPort, user, and password parameters. Makes this repository start replicating the source store on the server primary:primaryPort, using the given credentials to gain access.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / warmstandby delete

Stops a replication job.

This command is sent to the client.

catalogs / [CATNAME] / repositories / [REPOSITORY] / warmstandby / jobnames get

Get a list of replication jobnames

catalogs / [CATNAME] / repositories / [REPOSITORY] / warmstandby / registerJobname post

Register a replication jobname

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / warmstandby / startServer post

Start a warm standby server.

catalogs / [CATNAME] / repositories / [REPOSITORY] / warmstandby / switchRole post

Sent to a repository that is currently functioning as a replication server (i.e., a primary). Causes a client (identified by the jobname parameter) to take over, making this repository a client of that new server.

The becomeClient boolean parameter, which defaults to true, determines whether the server will start replicating its old client. The enableCommit parameter, also defaulting to true, controls whether no-commit mode will be turned off in the client.

arguments

catalogs / [CATNAME] / repositories / [REPOSITORY] / warmstandby / unregisterJobname post

Unregister a replication jobname

arguments

config / fti-stop-words get

Returns list of default stop words for freetext indices

configfile get

Return the AllegroGraph configuration file

arguments

configfiles get

Return a JSON object with keys being known config types (main, cluster) and values indicating if they are present.

databricks / available-tables get

Returns a list of all available tables in the Databricks warehouse.

arguments

databricks / clean delete

Clean up temporary files created by databricks/* services

arguments

databricks / download-csv put

Download a CSV file from Databricks DBFS and returns the path to local CSV file and a sample data from it.

arguments

databricks / export-table / cancel delete

Cancels the job run.

arguments

databricks / export-table / exec put

Asynchronously executes a python notebook with 24h wait timeout. Returns run-id for further pulling the result of execution and status.

arguments

databricks / export-table / result get

Returned structure depends on the status of the job run:

arguments

databricks / list-files get

Returns a list of paths to downloaded files from Databricks.

arguments

databricks / profiles get

Returns a list of profiles from the .databrickscfg.

databricks / statement / cancel delete

Cancels the SQL statement execution.

arguments

databricks / statement / exec put

Asynchronously executes a SQL statement without a wait timeout. Returns statement-id for further pulling the result of execution and status.

arguments

databricks / statement / result get

Returns an path to the downloaded CSV file with sample on success or the original Databricks response for the SQL statement's status in other cases.

arguments

databricks / warehouses get

Returns a list of all available Databricks warehouses.

arguments

fedshard / define get

Return the compiled definitions of the given fedshard repo or of all repos

arguments

fedshard / define put

Define one or more of fedshard repos

arguments

fedshard / define delete

Delete the definition but not the files of the named repo in the fedshard catalog

arguments

fedshard / delete-metadata delete

Delete the metadata of the named repo in the fedshard catalog. The metadata are such things as query options and namespaces that are usually set using Webview.

arguments

gruff / install put

Download and install a given Gruff version from Franz Inc. website.

arguments

gruff / list / available get

List all Gruff versions available for installation. Contacts Franz Inc. website.

gruff / list / installed get

List all Gruff versions that are installed locally.

gruff / set-active put

Set given installed Gruff version as active. It will be used to run Gruff when invoked from AGWebView.

arguments

gruff / uninstall delete

Uninstall a given Gruff version. Returns an error if given version is an active one.

arguments

hostname get

Return the hostname or ip address of the server

arguments

initfile get

Retrieve the server's initialization file.

The initialization-file is a collection of Common Lisp code that is executed on every shared back-end when it starts (see [sessions] for more details).

initfile put

Replace the current initialization file with the body of the request.

arguments

initfile delete

Remove the server's initialization file.

job get

Returns the string, which represents a status of the job with JOB-ID.

jobs get

Returns lists of strings of the following form that describe all running jobs: ("kind" "port" "name" "catalog" "uuid" "description" "age" "status").

"kind" is a string, that's equal to either "session" or "backend"; "port" is either a session port or a backend port; "name" is a repo name of the job for backend jobs, nil otherwise; "catalog" is a catalog name of the job for backend jobs, nil otherwise; "uuid" is the job UUID; "description" is the query string; "ageInSeconds" is the time since the job was created, in seconds; "status" is the job's current status.

Only query jobs are returned.

jobs delete

Cancels the specified job.

jobsNumber get

Returns the number of session jobs and backend jobs in JSON.

largeOperationWarning get

Return the text used for the large operation warnings.

largeOperationWarning put

Set the text used for the large operation warnings.

logfile get

Return the AllegroGraph log file.

If specified, startAt and length override the all argument.

arguments

lookup-embedder get

Return the parameters of the embedder matching the arguments. If no embedder is specified then all embedders are returned

arguments

lookup-llm get

Return the parameters of the llm matching the arguments. If no vendor is specified then all llms are returned

arguments

namespaces get

Retrieve the standard namespaces AllegroGraph uses

nd / computeSubtype get

Compute a geospatial nD-datatype specification given either a datatype or a list of ordinates.

The list of ordinates is described using $-prefixed names for each of the ordinates (in order). Each name must have a type, a minimum and maximum, a resolution and, optionally, a strip width. For example, these names must be included to describe the ordinate named test: 

$test-type  
$test-resolution  
$test-width  
$test-min  
$test-max

The REST command returns a description of the nD-geospatial subtype specified by the parameters to the query. Currently, this can either be in text/plain or application/json.

arguments

processes get

Returns a list of tuples describing the server's currently running processes.

Each tuple has pid (the OS process ID), name (the process name), and displayName (a prettier name to use for display) properties.

processes / [NAME] delete

Kills the specified process.

This should only be done if absolutely necessary as it can have adverse effects on the functioning of the server.

processes / [NAME] / pidName get

Returns name of the process with pid PID. If no such process can be found the error will be reported.

processes / [NAME] / stacktrace get

Returns stack traces for the threads in the given process.

processes / [NAME] / telnet post

Start a telnet server for the specified process.

An arbitrary port will be assigned to the server and returned as the response.

Security Note: any process on the same machine as the AllegroGraph server will be able to connect to the telnet server.

protocol get

Returns the protocol version of the Sesame interface. The protocol described in this document is 4.

queryPlanners get

Return the planners that can be used to reorder Basic Graph patterns in a SPARQL query. These can be used in the clauseReorderer query plan option.

reconfigure post

Posting to this URL will cause the server to re-read its configuration file, and update itself to reflect the new configuration.

reopenLog post

Causes the server to re-open its log file. This is useful for log rotation.

repositories get

Return a list of repositories available in the catalog.

arguments

repositories / [REPOSITORY] put

Creates a new, empty repository.

When a repository with the given name already exists, it is overwritten, unless a parameter override with value false is passed.

arguments

repositories / [REPOSITORY] delete

Delete the specified repository. This can fail if the repository is being accessed by another client.

repositories / [REPOSITORY] / auto / optimize / message get

Return the last message written by the automatic optimizer

repositories / [REPOSITORY] / auto / optimize / start put

Start automatic optimization on this repository

arguments

repositories / [REPOSITORY] / auto / optimize / status get

Return whether the auto optimizer is running or stopped

repositories / [REPOSITORY] / auto / optimize / stop put

Stop automatic optimization on this repository

repositories / [REPOSITORY] / backup post

Create a backup of the repository.

repositories / [REPOSITORY] / ensureNotLingering post

To conserve resources, makes the database instance and its child processes exit if the instance is unused. Takes no arguments, returns nothing.

Normally unused database instances linger for InstanceTimeout seconds to speed up subsequent open operations.

repositories / [REPOSITORY] / exists get

Return true if the triple-store exists and is accessible to the current user.

Will return an HTTP 401 (Unauthorized) if the user is not authorized to read from the requested catalog and an HTTP 404 (Not Found) if the user is authorized but the store does not exist.

repositories / [REPOSITORY] / namespaces get

Return the currently active namespaces for the current user in this repository.

The namespaces are returned as tuples with fields prefix and namespace (as well as type and shadowed if effective is false, where type is one of default, repository or user and shadowed indicates whether the option is shadowed by a higher priority definition.

arguments

repositories / [REPOSITORY] / namespaces delete

Deletes all namespaces of the specified type.

arguments

repositories / [REPOSITORY] / namespaces / [PREFIX] post put

Create or update a namespace.

The body of the request must contain the namespace for the prefix as plain text.

arguments

repositories / [REPOSITORY] / namespaces / [PREFIX] get

Returns the namespace defined for the given prefix.

arguments

repositories / [REPOSITORY] / namespaces / [PREFIX] delete

Delete a namespace.

arguments

repositories / [REPOSITORY] / query-options get

Return the currently active query-options for the current user in this repository.

The query-options are returned as tuples with fields name and value (as well as type and shadowed if effective is false, where type is one of default, repository or user and shadowed indicates whether the option is shadowed by a higher priority definition.

arguments

repositories / [REPOSITORY] / query-options delete

Deletes all query-options of the specified type.

arguments

repositories / [REPOSITORY] / query-options / [NAME] post put

Create or update a query-option.

The body of the request must contain the value for the name as plain text.

arguments

repositories / [REPOSITORY] / query-options / [NAME] get

Returns the value defined for the given name.

arguments

repositories / [REPOSITORY] / query-options / [NAME] delete

Delete a query-option.

arguments

repositories / [REPOSITORY] / repl / controllingInstance put

Specify the name of the new controlling instance. This command must be sent to the current controlling instance. If the current controlling instance is down then it can be sent to any instance if 'force' is specified as 'true'

arguments

repositories / [REPOSITORY] / repl / createCluster put

Create the first instance of a replication cluster.

arguments

repositories / [REPOSITORY] / repl / growCluster put

add instance to cluster

arguments

repositories / [REPOSITORY] / repl / priority post

Set the priorities between instances and groups.

arguments

repositories / [REPOSITORY] / repl / quiesce put

Control whether commits are permitted and whether to wait until the instance is up to date with commits

arguments

repositories / [REPOSITORY] / repl / remove put

Permanently remove an instance from the cluster. The command is sent to the controlling instance.

arguments

repositories / [REPOSITORY] / repl / settings get

Return the current settings of repl parameters

repositories / [REPOSITORY] / repl / settings post

Set the values of replication parameters and return all of the settings.

arguments

repositories / [REPOSITORY] / repl / start put

Restart a stopped instance in the cluster. If the instanceName argument is given then that instance is started. If instanceName is not given then the instance started is the one to which the command is sent.

arguments

repositories / [REPOSITORY] / repl / status get

Return the status of the instance.

arguments

repositories / [REPOSITORY] / repl / stop put

Stops an instance. The instance will receive no commits from other instances and no commits can be done on this instance. This instance can be restarted unless undo-repl is true. The instance named by instanceName is stopped. If instanceName is not given the the instance to which the command is sent is stopped.

arguments

repositories / [REPOSITORY] / retain put

Specify which transaction log files must be retained

arguments

repositories / [REPOSITORY] / scripts get

Return the list of scripts that have been added to this repository.

repositories / [REPOSITORY] / scripts / [NAME] get

Return the contents of the script NAME in this repository.

repositories / [REPOSITORY] / scripts / [NAME] put

Add or replace the script NAME in this repository with the contents of the body.

arguments

repositories / [REPOSITORY] / scripts / [NAME] delete

Delete the script NAME in this repository.

repositories / [REPOSITORY] / session post

Starts a new session for the repository.

arguments

repositories / [REPOSITORY] / shutdown post

Closes respository. Sends close to each shared backend, but does not attempt to close open sessions.

If ensureNotLingering is passed it will first turn on the respective option in service-daemon so that closing the repository causes repository and its child processes to exit instantly.

arguments

repositories / [REPOSITORY] / warmstandby get

Returns a representation of the current standby status for repository.

Only supports an application/json accept type.

repositories / [REPOSITORY] / warmstandby put

Set up warm-standby on this repository.

Requires jobname, primary, primaryPort, user, and password parameters. Makes this repository start replicating the source store on the server primary:primaryPort, using the given credentials to gain access.

arguments

repositories / [REPOSITORY] / warmstandby delete

Stops a replication job.

This command is sent to the client.

repositories / [REPOSITORY] / warmstandby / jobnames get

Get a list of replication jobnames

repositories / [REPOSITORY] / warmstandby / registerJobname post

Register a replication jobname

arguments

repositories / [REPOSITORY] / warmstandby / startServer post

Start a warm standby server.

repositories / [REPOSITORY] / warmstandby / switchRole post

Sent to a repository that is currently functioning as a replication server (i.e., a primary). Causes a client (identified by the jobname parameter) to take over, making this repository a client of that new server.

The becomeClient boolean parameter, which defaults to true, determines whether the server will start replicating its old client. The enableCommit parameter, also defaulting to true, controls whether no-commit mode will be turned off in the client.

arguments

repositories / [REPOSITORY] / warmstandby / unregisterJobname post

Unregister a replication jobname

arguments

requests get

Returns a JSON object containing information about all pending and a limited number of finished requests for all AllegroServe instances running. This includes requests to the main AllegroGraph URL, the backends and sessions.

Each request contains the following information: - uri - the URL of the request - method - one of HTTP methods like 'get', 'post', etc. - statusCode - response status or null (if request not finished yet) - source - IP and port of the requester - started - Unix timestamp (in nanoseconds) of the moment the request was received by the server - finished - Unix timestamp (in nanoseconds) of the moment the server finished answering the request, or null if the request not finished yet. - duration - Duration of the request in nanoseconds. For pending requests, this is the duration of the request until now.

Requires superuser privileges.

roles get

Return a list of the roles defined on the server.

roles / [NAME] put

Add a new role to the server.

roles / [NAME] delete

Remove the role named name from the server.

roles / [NAME] / access get

Retrieve the read/write access for a user.

This returns a result set, each element of which has a read, write, catalog, and repository component as well as additional flags (e.g. query-results-limit). The first two (read and write) are booleans, the following two (catalog and repository) are strings. Additional flags are boolean. For permissions granted globally, catalog and repository will have a value of "*", for those granted per-catalog, only repository will be "*". catalog normally contains the catalog name, but "/" is used for the root catalog.

For example, read access to all repositories in the public catalog is specified (in JSON format) by: 

{read: true, write: false, catalog: "public", repository: "*",  
 query-results-limit: false}

Whereas read/write access to repository scratch in the root catalog would be: 

{read: true, write: true, catalog: "/", repository: "scratch",  
 query-results-limit: false}

roles / [NAME] / access put

Modify the read/write access of a user or role.

arguments

roles / [NAME] / access delete

Similar to PUT Access but this deletes the read/write access of a user or role.

arguments

roles / [NAME] / attributes get

Return the attributes specified for a user or role

roles / [NAME] / attributes put

Specify the attributes for a set of repos for a user or role

arguments

roles / [NAME] / attributes delete

Delete the attributes for a set of repos for a user or role

arguments

roles / [NAME] / color get

Return the color that has been assigned to a user or role.

roles / [NAME] / color put

Assigns the given color to this user or role.

roles / [NAME] / color delete

Unset the color for this user or role.

roles / [NAME] / permissions get

Return a list of permissions flags that have been assigned to a user or role.

Example flags include super, eval, session.

roles / [NAME] / permissions / [TYPE] get

Return the value of the permission type for a user or role.

roles / [NAME] / permissions / [TYPE] put

Assigns the given permission to this user. type should be super, eval, session or one of the other defined permission flags.

roles / [NAME] / permissions / [TYPE] delete

Revokes the given permission for this user.

roles / [NAME] / security-filters / [TYPE] get

Get list of security filters for a user.

Type may be allow or disallow. The returned items have keys s, p, o, and g as per the parameters for POST security-filters.

roles / [NAME] / security-filters / [TYPE] post

Create security-filter for the user or role.

type should be allow or disallow. The subject, predicate, object and graph fields are all optional. See the Security filters Documentation for more details.

arguments

roles / [NAME] / security-filters / [TYPE] delete

Delete a security-filter for the user or role.

type should be allow or disallow. The subject, predicate, object and graph fields are all optional. See the Security filters Documentation for more details.

arguments

scheduler / createEvent post

Add an Event to the calendar for the scheduler to process

arguments

scheduler / deleteEvents put

Delete all scheduler events that match either ID, eventName or owner. If no arguments are given then no events are deleted.

arguments

scheduler / events get

Return a user's events as an array of json objects. If user is superuser show everyone's events

arguments

scheduler / log get

Return user's log entries as an array of json objects. If user is a superuser then return everyone's log events

arguments

scheduler / log put

Set the number of recent log entries to retain in the scheduler.

arguments

scripts get

Return a list of the names of the scripts stored on the server.

scripts / [NAME] get

Return the sitescript NAME.

scripts / [NAME] put

Import a new sitescript NAME.

The body of the request should contain the new script. Scripts whose name ends in .fasl are assumed to be compiled Lisp code (you are responsible for ensuring that it is compatible with the server), scripts whose name ends on '.js' are assumed to be JavaScript (ECMAScript), anything else is assumed to be raw Common Lisp code, which the server will compile.

arguments

scripts / [NAME] delete

Delete the script at path*.

serverWarnings get

Retrieve any operational warnings from the AllegroGraph server as tuples consisting of a warning identifier tag and descriptive text.

serverWarnings post

Record a server warning.

Only a user with superuser access may record warnings.

arguments

serverWarnings delete

Dismiss the server warning identified by tag.

Only a user with superuser access may dismiss warnings.

session get

Retrieve information about the currently running sessions.

session post

Starts a new session.

The minilanguage used by the store parameter works as follows:

<store1>

Indicates the triple store named "store1" in the root catalog.

<catalog1:store2>

The triple store "store2" in the "catalog1" catalog.

<http://USER:PASSWORD@HOST:PORT/repositories/REPONAME> <http://USER:PASSWORD@HOST:PORT/catalog/CATNAME/repositories/REPONAME>

A remote store, by URL. If the URL points to the server itself, the store will be opened locally. USER and PASSWORD are not required if the remote server allows for anonymous access to the specified store.

<a> + <b>

The federation of stores "a" and "b".

<a>[rdfs++]

The store "a", with rdfs++ reasoning applied (restriction is also supported as a reasoner type). You can specify the context that inferred triples get using this syntax: <a>[rdfs++#<http://test.org/mycontext>]

<a>{null <http://example.com/graph1>}

Store "a", filtered to only contain the triples in the default graph (null) and the graph named http://example.com/graph1. Any number of graphs can be given between the braces.

This syntax can be composed to created federations of filtered and reasoning stores, for example <http://somehost:10035/repositories/a>{null} + <b>[rdfs++].

The service returns the URL of the new session. Any sub-URLs that were valid under a repository's URL will also work under this session URL. For example, if http://localhost:55555/sessions/7e8df8cd-26b8-26e4-4e83-0015588336ea is returned, you can use http://localhost:55555/sessions/7e8df8cd-26b8-26e4-4e83-0015588336ea/statements to retrieve the statements in the session.

arguments

systemstat.json get

Returns the current collected info history specified by the requestTree parameter in json.

arguments

token get

Generate an access token for a given user to be used for token authentication.

arguments

token delete

Destroy token, effectively invalidating all future requests with it.

arguments

token / list get

List all tokens registered for authenticated user.

arguments

users get

Returns either list of defined user names or the complete user and role definitions.

arguments

users put

uploads a set of user and role descriptions

users / [NAME] put

Create a new user.

arguments

users / [NAME] delete

Delete the user identified by name.

users / [NAME] / access get

Retrieve the read/write access for a user.

This returns a result set, each element of which has a read, write, catalog, and repository component as well as additional flags (e.g. query-results-limit). The first two (read and write) are booleans, the following two (catalog and repository) are strings. Additional flags are boolean. For permissions granted globally, catalog and repository will have a value of "*", for those granted per-catalog, only repository will be "*". catalog normally contains the catalog name, but "/" is used for the root catalog.

For example, read access to all repositories in the public catalog is specified (in JSON format) by: 

{read: true, write: false, catalog: "public", repository: "*",  
 query-results-limit: false}

Whereas read/write access to repository scratch in the root catalog would be: 

{read: true, write: true, catalog: "/", repository: "scratch",  
 query-results-limit: false}

users / [NAME] / access put

Modify the read/write access of a user or role.

arguments

users / [NAME] / access delete

Similar to PUT Access but this deletes the read/write access of a user or role.

arguments

users / [NAME] / attributes get

Return the attributes specified for a user or role

users / [NAME] / attributes put

Specify the attributes for a set of repos for a user or role

arguments

users / [NAME] / attributes delete

Delete the attributes for a set of repos for a user or role

arguments

users / [NAME] / color get

Return the color that has been assigned to a user or role.

users / [NAME] / color put

Assigns the given color to this user or role.

users / [NAME] / color delete

Unset the color for this user or role.

users / [NAME] / data get

Each user has a simple key-value store associated with it. This is mostly used by WebView to save settings, but can be useful in other applications.

This service returns a result set containing id and uri fields, listing the keys stored for this user, and the URL under which their data can be found (see below).

users / [NAME] / data delete

Bulk delete user data. /USER/data?key=foo&key=bar - delete keys "foo" and "bar". /USER/data?prefix=wv - delete keys starting with "wv". /USER/data?prefix=wv&key=baz - delete the key "baz" AND all keys starting with "wv". /USER/data?prefix= - delete all keys.

arguments

users / [NAME] / data / [KEY] get

Fetches the user-data under key. Returns a string.

users / [NAME] / data / [KEY] put

Stores data in a user's key-value store. The request body should contain the data to store.

users / [NAME] / data / [KEY] delete

Deletes data from a user's key-value store.

users / [NAME] / effectiveAccess get

Similar to access, but also includes the access granted to any of the user's roles.

users / [NAME] / effectiveColors get

Return a list of name/color tuples for the user and all of its roles that have a color.

users / [NAME] / effectivePermissions get

Return a list of permissions flags that have been assigned to a user or any of its roles.

Example flags include super, eval, session.

users / [NAME] / gruff-queries get

Provides the same API as /users/ /data but for queries created in Gruff.

users / [NAME] / gruff-queries / [KEY] get

Returns stringified JSON information about a query originally saved in Gruff.

users / [NAME] / gruff-queries / [KEY] put

Updates a query originally saved in Gruff. The endpoint expects a stringified JSON in the body in the same format as the response of GET /users/ /data/ .

users / [NAME] / gruff-queries / [KEY] delete

Removes a query originally saved in Gruff.

users / [NAME] / loginTimeout get

Get the login timeout for USER, in seconds.

If no there is no timeout -1 will be returned. Also note that timeouts are currently configured globally, not per-user.

users / [NAME] / password post

Update the password of the user name.

The new password must be included in the body of the HTTP request. The request must be authenticated with the actual password, not a token.

users / [NAME] / permissions get

Return a list of permissions flags that have been assigned to a user or role.

Example flags include super, eval, session.

users / [NAME] / permissions / [TYPE] get

Return the value of the permission type for a user or role.

users / [NAME] / permissions / [TYPE] put

Assigns the given permission to this user. type should be super, eval, session or one of the other defined permission flags.

users / [NAME] / permissions / [TYPE] delete

Revokes the given permission for this user.

users / [NAME] / roles get

Return a list of the user's roles

users / [NAME] / roles / [ROLE] put

users / [NAME] / roles / [ROLE] delete

Remove a role from a user.

users / [NAME] / security-filters / [TYPE] get

Get list of security filters for a user.

Type may be allow or disallow. The returned items have keys s, p, o, and g as per the parameters for POST security-filters.

users / [NAME] / security-filters / [TYPE] post

Create security-filter for the user or role.

type should be allow or disallow. The subject, predicate, object and graph fields are all optional. See the Security filters Documentation for more details.

arguments

users / [NAME] / security-filters / [TYPE] delete

Delete a security-filter for the user or role.

type should be allow or disallow. The subject, predicate, object and graph fields are all optional. See the Security filters Documentation for more details.

arguments

uuids get

Return all of the UUIDs of the repositories in all the catalogs

version / date get

Return the date on which the server was built.

version / revision get

Return the git hash of the revision that the server was built from.

webview / version get

Returns the current WebView version and its release date

webview / version put

Set given AGWebView version as active. It will be downloaded if necessary.

arguments

webview / versions get

List all AGWebView versions available for installation. Contacts Franz Inc. website.

Back end

catalogs / [CATNAME] / repositories / [REPONAME] get post

Execute a SPARQL or Prolog select query.

Arguments of the form $varname=value specify variable bindings. Variables appearing in the query can be bound to a specific value outside the actual query using this mechanism. The value must be an N-Triples encoded RDF value. For example, if the value is an IRI, it must be wrapped in angle brackets.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / access get

Return the access permissions the current user has for this repository.

catalogs / [CATNAME] / repositories / [REPONAME] / add-object put

add an object to the vector store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / attributes / definitions get

Returns a JSON array containing JSON objects representing attribute definitions. If NAME is supplied returns an array containing a single JSON object, if an attribute of the given name exists, otherwise returns an empty array.

Examples:

[{"minimum-number":0,"maximum-number":1152921504606846975,"name":"attr","allowed-values":[],"id":1,"ordered":false}]

[{"minimum-number":5,"maximum-number":10,"name":"attr1","allowed-values":[5, 7, 10],"id":1,"ordered":true}, {"minimum-number":0,"maximum-number":20,"name":"attr2","allowed-values":[],"id":2,"ordered":false}]

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / attributes / definitions post

Establishes or updates a triple attribute definition.

Attributes must be defined before they can be used. Defining an attribute establishes the name of an attribute and any constraints that should be placed on its use.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / attributes / definitions delete

Deletes an existing attribute definition.

If the named attribute definition was found and deleted, returns true.

If the named attribute definition was not found: If error is true (the default), throws an error. If error is false, returns false/nil.

Note that attribute definitions cannot be deleted if they are in use by the static attribute filter. An attempt to delete an attribute definition while it is in use will result in an error.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / attributes / staticFilter get

Returns the current static attribute filter for the triple store.

catalogs / [CATNAME] / repositories / [REPONAME] / attributes / staticFilter post

Sets the static attribute filter for the triple store.

When set, only triples which match the filter will be returned by any query against the store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / attributes / staticFilter delete

Deletes the current static attribute filter for the triple store (if any).

catalogs / [CATNAME] / repositories / [REPONAME] / backup-stream post

Create a backup of the repository. Stream the backup file as a response.

catalogs / [CATNAME] / repositories / [REPONAME] / begin post

catalogs / [CATNAME] / repositories / [REPONAME] / blankNodes post

Return one or more blank nodes.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / bulkMode get

Returns whether or not bulk-load mode is enabled for the repository.

catalogs / [CATNAME] / repositories / [REPONAME] / bulkMode put

Enable bulk-load mode for the repository.

catalogs / [CATNAME] / repositories / [REPONAME] / bulkMode delete

Disable bulk-load mode for the repository.

catalogs / [CATNAME] / repositories / [REPONAME] / clusterings put

Create clusterings in a vector database. These are used to speedup nearest neighbor search

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / commit post

Commit the current transaction

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / contexts get

Fetches a list of named graphs in the store.

Returns a set of tuples, each of which only has a contextID field, which is an N-triples string that names the graph.

catalogs / [CATNAME] / repositories / [REPONAME] / convert-to-vts put

Ensure that the given triple store that is the value of db (default *db*) contains a vector store. If db is already a vector triple store then it will not be modified if supersede is nil. If supersede is true then the existing vector store in db will be completely removed before creating a new vector store in db. Only vector store triples will be deleted, the other triples in the store will remain. The embedder, model and api-key arguments are the same as for create-triple-store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / createSecondaryIndices get

Return whether or not the store should create secondary indices (UPI-maps) at query time.

catalogs / [CATNAME] / repositories / [REPONAME] / createSecondaryIndices put

Update the automatic secondary indices creation (UPI-maps) setting.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / createSecondaryIndices delete

Turn off automatic secondary indices creation (UPI-maps).

catalogs / [CATNAME] / repositories / [REPONAME] / data-generator / patient post

Adds and commits sample patient triples to the database.
Returns the number of triples added.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / data-generator / phoneCall post

Adds and commits sample phone call triples to the database.
Returns the number of triples added.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / data-generator / shacl get

Generate SHACL shapes for the current repository. The generated shapes are returned in JSON-LD format. IMPORTANT NOTE: SHACL shapes are generated based on the current state of the repository. Therefore resulting shapes MUST NOT be used to validate triple store data. If triple store data is semantically invalid then generated SHACL shapes constrains are semantically incorrect.

catalogs / [CATNAME] / repositories / [REPONAME] / delete-objects put

delete objects from a vector store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / encodedIds post

Return the next amount encoded IDs for prefix

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / encodedIds / prefixes get

Return information on any registered encoded IDs.

Returns a set of tuples with keys: prefix, format, and id.

catalogs / [CATNAME] / repositories / [REPONAME] / encodedIds / prefixes post

Register encoded IDs for the repository.

Use either the prefix and format arguments to specify a single encoded ID or encode a collection of registrations into a JSON array of form and include this in the body of the request.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / encodedIds / prefixes delete

Removes the encoded ID associated with prefix.

Note that it is an error if the encoded ID has been already been used in the triple-store.

catalogs / [CATNAME] / repositories / [REPONAME] / encodedIds / prefixes / hasAny get

Returns whether or not the repository has any encoded IDs registered.

catalogs / [CATNAME] / repositories / [REPONAME] / encodedIds / prefixes / isInUse get

Returns whether or not any triples have been added using the encoded ID associated with prefix.

catalogs / [CATNAME] / repositories / [REPONAME] / encodedIds / prefixes / isRegistered get

Returns whether or not a prefix is registered as an encoded ID.

catalogs / [CATNAME] / repositories / [REPONAME] / eval post

Evaluates the request body in the server.

By default, it is evaluated as Common Lisp code, with *package* set to the db.agraph.user package. If you specify a Content-Type of text/javascript, however, the code will be interpreted as JavaScript.

Makes an attempt to return the result in a sensible format, falling back to printing it (as per prin1) and returning it as a string.

catalogs / [CATNAME] / repositories / [REPONAME] / exec-nl-query get

Convert a natural language query (NLQ) in a SPARQL SELECT/ASK/DESCRIBE query. If the conversion is successful, the query and execution results are included in the response. If the prompt exactly matches an existing example, the result is returned directly. If the conversion fails, the response includes failed attempts of SPARQL queries generation and information on why the backend treated them as failures. Also, the response may include referenced SHACL shapes and examples with NLQ and SPARQL queries.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / expected-store-size get

Return the expected size of the store in number of triples.

catalogs / [CATNAME] / repositories / [REPONAME] / freetext get post

Query the repository using a free-text index

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices get

Return a list of freetext indices defined on the store

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] get

Return information on the freetext-index named indexName.

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] post

Modify the freetext-index named indexName.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] put

Create or modify a freetext-index named indexName.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] delete

Delete the free-text index indexName.

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / borderChars get

Return the border characters for the text index

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / graphs get

Return the graphs on which the text index is defined

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / indexFields get

Return the triple-fields that the index indexes

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / indexLiterals get

Return whether or not the index indexes literals

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / indexResources get

Return whether or not the index indexes resources

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / innerChars get

Return the inner characters for the text index

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / minimumWordSize get

Return the minimum word size of the text index

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / predicates get

Return the predicates on which the text index is defined

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / stopWords get

Return the stop words defined for the text index

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / tokenizer get

Return the tokenizer for the text index

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / types get

Return the RDF types for which the text index is defined

catalogs / [CATNAME] / repositories / [REPONAME] / freetext / indices / [INDEXNAME] / wordFilters get

Return the word filters specified for the text index

catalogs / [CATNAME] / repositories / [REPONAME] / functor post

Define one or more Prolog functors.

The body should contain the functors to be defined.

catalogs / [CATNAME] / repositories / [REPONAME] / geo / box get

Fetch all triples with a given predicate whose object is a geospatial value inside the given box.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / geo / circle get

Retrieve triples whose object falls inside a circle.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / geo / haversine get

Retrieve triples whose object lies within a circle in a spherical system.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / geo / polygon get

Retrieve triples whose object lies inside a polygon.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / geo / polygon put

Add a new polygon to the repository.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / geo / types get

Retrieve a list of geospatial types defined in the store.

catalogs / [CATNAME] / repositories / [REPONAME] / geo / types post

Add a new geospatial sub-type to the triple-store. Returns the external index of the subtype.

catalogs / [CATNAME] / repositories / [REPONAME] / geo / types / cartesian post

Define a new Cartesian geospatial type.

Returns the type resource which can be used as the type argument in other geospatial services. The xmin, xmax, ymin, and ymax arguments determine the size of the Cartesian plane that is modelled by this type.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / geo / types / id get

Returns the internal index of a geospatial subtype based on its UUID.

catalogs / [CATNAME] / repositories / [REPONAME] / geo / types / spherical post

Define a spherical geospatial type.

Returns the type resource which can be used as the type argument in other geospatial services. The latmin, longmin, latmax, and longmax can be used to limit the size of the region modelled by this type. The default is to span the entire sphere.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / geosparql / buildGeohashIndex post

Incrementally build Geohash index. It only build for triples that do NOT have geohash index. If the building process finishes successfully, it will return a JSON object 1}; otherwise, it returns 2}.

catalogs / [CATNAME] / repositories / [REPONAME] / geosparql / rebuildGeohashIndex post

Forcefully rebuild Geohash index. It will delete all the current Geohash index and then rebuild. If the rebuilding process finishes successfully, it will return a JSON object 3}; otherwise, it returns 4}.

catalogs / [CATNAME] / repositories / [REPONAME] / getPreparedTransactions get

Returns a list of XIDs for transactions that have been prepared but not yet committed or rolled back.

catalogs / [CATNAME] / repositories / [REPONAME] / graphql post

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / indices get

Return a list of indices defined on the triple-store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / indices / [TYPE] put

Add an index of type to the triple-store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / indices / [TYPE] delete

Drop the index type from the triple-store.

catalogs / [CATNAME] / repositories / [REPONAME] / indices / [TYPE] / chunks get

Visualize chunks of an index and return an image.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / indices / optimize post

Optimize the indices in the repository at the given effort level.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / jobs get

Returns job information for the current store.

Returns lists of strings of the form ("uuid" "age" "description" [unused]), where "uuid" is the job UUID; "age" is the number of seconds since the job was created; and "description" is the query string. Only query jobs are returned. The fourth element of the list will also be a string but is not currently used and so is not meaningful.

catalogs / [CATNAME] / repositories / [REPONAME] / jobs / [JOB-ID] delete

Cancels the specified job (if it exists) for the current store.

catalogs / [CATNAME] / repositories / [REPONAME] / jobs / purge-deleted-triples post

Schedules a background operation to purge deleted triples from the specified indices.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / jobs / purge-deleted-triples delete

Cancels purge deleted triple job for the specified indices.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / llm-index put

do an llm index of the current repo according to the given spec

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / llm-list get

Return a list of available vector databases for a given repository.

catalogs / [CATNAME] / repositories / [REPONAME] / llm-split put

using the split-config convert file attached to the body into triples in the current store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / load-csv put

Load a CSV file into the store. The CSV file is uploaded as the request body or by reading file passed via csv-name parameter. Parameters are used from the agtool load command except for print-load-command. The print-load-command parameter returns the appropriate agtool command based on your parameters but does NOT import the CSV file.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / lock post

Attempts to page in and lock the specified indices or the string table into memory. String or index data added after this call will not be locked.

The ability to lock is limited by the 'memlock' rlimit and available memory. Increasing the 'memlock' limit requires Systems Administrator intervention.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / lock delete

Removes the specified index or string table locks.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / mapping get

Return the datatype and predicate mappings for the repository.

catalogs / [CATNAME] / repositories / [REPONAME] / mapping delete

Remove any user-defined datatype and predicate mappings.

catalogs / [CATNAME] / repositories / [REPONAME] / mapping / all delete

Remove all datatype and predicate mappings (included the default ones).

catalogs / [CATNAME] / repositories / [REPONAME] / mapping / predicate post put

Add a new predicate mapping between predicate and encoding.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / mapping / predicate get

Return the predicate mapping for predicate.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / mapping / predicate delete

Remove any predicate mapping on predicate.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / mapping / predicate / cartesian post

Define a Cartesian type-mapping between predicate and the geospatial subtype specified by uuid.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / mapping / predicate / spherical post

Define a spherical type-mapping between predicate and the geospatial subtype specified by uuid.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / mapping / type post put

Add a new datatype mapping between type and encoding.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / mapping / type get

Return the datatype mapping for type.

catalogs / [CATNAME] / repositories / [REPONAME] / mapping / type delete

Remove the datatype mapping between type and encoding.

catalogs / [CATNAME] / repositories / [REPONAME] / mapping / type / cartesian post

Define a Cartesian datatype mapping between the datatype type and the geospatial subtype specified by uuid.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / mapping / type / spherical post

Define a spherical datatype mapping between the datatype type and the geospatial subtype specified by uuid.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / materializeEntailed put

Use materialization to add inferred triples to the store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / materializeEntailed delete

Delete any materialized triples

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / metadata get

Returns a subset of the store's metadata. Currently it returns the attribute definitions and static filter definition. The value may be saved or passed later to set-metadata; it must not be modified.

catalogs / [CATNAME] / repositories / [REPONAME] / metadata post

Merge the metadata in the metadata argument into the current metadata for the database. It is not currently permitted to change an attribute definition and doing so will result in an error. The metadata value must have come from an earlier call to get-metadata. After calling this function a commit-triple-store must be done to make the changes persistent.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / mongoParameters get

Return the mongoDB settings for the repository.

The settings include:

Note, the mongoDB password is not returned. Use the POST request to change the parameters.

catalogs / [CATNAME] / repositories / [REPONAME] / mongoParameters post

Update the triple-store's MongoDB setting. See MongoDB interface for additional details.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / namespaces get

Return the currently active namespaces for your user in this repository

Namespaces are returned as tuples with prefix and namespace (the URI) fields.

catalogs / [CATNAME] / repositories / [REPONAME] / namespaces delete

Deletes all namespaces in this repository for the current user.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / namespaces / [PREFIX] post put

Associate prefix with the uri as a namespace abbreviation.

catalogs / [CATNAME] / repositories / [REPONAME] / namespaces / [PREFIX] get

Returns the namespace URI defined for the given prefix.

catalogs / [CATNAME] / repositories / [REPONAME] / namespaces / [PREFIX] delete

Remove any namespace abbreviation associated with prefix.

catalogs / [CATNAME] / repositories / [REPONAME] / nd / geospatialDatatypeAutomation get

Returns whether or not automatic geospatial datatype recognition is enabled for this store.

catalogs / [CATNAME] / repositories / [REPONAME] / nd / geospatialDatatypeAutomation put

Turns on automatic geospatial datatype recognition so that 2, 3 and n-dimensional data can be easily loaded.

catalogs / [CATNAME] / repositories / [REPONAME] / nd / geospatialDatatypeAutomation delete

Turns off automatic geospatial datatype recognition.

catalogs / [CATNAME] / repositories / [REPONAME] / nearest-neighbor get

compute the semantically closest top N (top-n) strings from a vector triple store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / needsCommit get

Returns whether or not the whether the current transaction has any changes that require a commit.

catalogs / [CATNAME] / repositories / [REPONAME] / neighborMatrices / [NAME] put

Create a neighbor-matrix, which is a pre-computed generator.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / nl-queries get

Retrieve NLQ and SPARQL queries from the vector store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / nl-queries post

Add pairs of natural language and SPARQL queries to the vector store. Natural language queries are embedded in the vector store to be used in the nearest neighbor search.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / nl-queries delete

Remove natural language and SPARQL query examples from the vector store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / nl-queries / missing-fields get

Checks for query examples with missing fields due to updates in AG internal logic.

catalogs / [CATNAME] / repositories / [REPONAME] / nl-queries / missing-fields put

Updates query examples with missing fields due to updates in AG internal logic.

catalogs / [CATNAME] / repositories / [REPONAME] / nl-queries / total get

Retrieve the total number of NLQ and SPARQL queries in the NLQ vector store.

catalogs / [CATNAME] / repositories / [REPONAME] / nlq-vdb put

Register VDB specification as NLQ VDB for the store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / nlq-vdb delete

Unregister VDB specification as NLQ VDB for the store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / nlq-vdbs get

Returns all registered NLQ VDB specifications for the store.

catalogs / [CATNAME] / repositories / [REPONAME] / noCommit get

Return true if given repository is currently in read-only (no-commit) mode, false otherwise.

When this mode is active, all commits from any clients will return an error which effectively prevents writing to the store. This is used to enforce read-only stores.

catalogs / [CATNAME] / repositories / [REPONAME] / noCommit put

Enable read-only (no-commit) mode. Requires superuser privileges.

catalogs / [CATNAME] / repositories / [REPONAME] / noCommit delete

Disable read-only (no-commit) mode. Requires superuser privileges.

catalogs / [CATNAME] / repositories / [REPONAME] / object-embedding get

return the embedding for the object object-id from a vector store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / object-property-value get

return the value of a given property for the object object-id in the vector store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / object-text get

return the text for the object object-id from a vector store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / queries / [NAME] get post

Execute a saved query

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / queries / [NAME] delete

Remove a prepared query

catalogs / [CATNAME] / repositories / [REPONAME] / query-options get

Return the currently set query options for your user in this repository

Query options are returned as tuples with name and value (the URI) fields.

catalogs / [CATNAME] / repositories / [REPONAME] / query-options delete

Deletes all query options set in this repository for the current user.

catalogs / [CATNAME] / repositories / [REPONAME] / query-options / [NAME] post put

Set query option name to the value value.

catalogs / [CATNAME] / repositories / [REPONAME] / query-options / [NAME] get

Returns the value of the given query option.

catalogs / [CATNAME] / repositories / [REPONAME] / query-options / [NAME] delete

Delete query option name.

catalogs / [CATNAME] / repositories / [REPONAME] / queryResultsCache get

Returns the size (in bytes) of query results cache directory.

catalogs / [CATNAME] / repositories / [REPONAME] / queryResultsCache delete

Delete query results cache directory.

catalogs / [CATNAME] / repositories / [REPONAME] / rdf-star get

RDF-star mode status for a given repository.

catalogs / [CATNAME] / repositories / [REPONAME] / rdf-star put

Enable RDF-star mode for a given repository. Triggers an error if RDF-star mode is not supported.

catalogs / [CATNAME] / repositories / [REPONAME] / rdf-star delete

Disable RDF-star mode for a given repository. Triggers an error if RDF-star is not supported or the repository contains quoted triples and RDF-star mode cannot be disabled.

catalogs / [CATNAME] / repositories / [REPONAME] / reports get

Returns the report with specified path as a JSON object

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / rollback post

Discards any local repository changes, then synchronize to the latest committed repository version on the server. Starts a new transaction.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / session / autoCommit get

Return whether or not auto-commit is currently active for this session.

Deprecated with Sesame 2.7; see isActive instead.

catalogs / [CATNAME] / repositories / [REPONAME] / session / autoCommit post

Change the auto-commit behavior for the session.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / session / close post

Stop a session.

catalogs / [CATNAME] / repositories / [REPONAME] / session / description get

Return a description of the session.

catalogs / [CATNAME] / repositories / [REPONAME] / session / isActive get

Return whether or not there is an open transaction.

catalogs / [CATNAME] / repositories / [REPONAME] / session / ping get

Send a message to a session in order to keep it alive.

catalogs / [CATNAME] / repositories / [REPONAME] / settings / purge-rate-limit get

Returns the deleted triple purge operation rate limit (read IOs per second). 0 means no limit.

catalogs / [CATNAME] / repositories / [REPONAME] / settings / purge-rate-limit post

Sets the deleted triple purge operation rate limit (read IOs per second). Note that this setting is not persistent. It will revert to 0 the next time the database instance is started.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shacl-shapes get

Retrieve SHACL shapes from the store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shacl-shapes put

Import SHACL shape(s) in JSON-LD format in the store. Optionally removes a shape specified by the subj parameter.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shacl-shapes delete

Delete a SHACL shape from the store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shard-info get

Returns a string that is the contents of the shard-info file for the repo, or the string "nil" if there is no shard-info file.

catalogs / [CATNAME] / repositories / [REPONAME] / shards get

List triple store shards as named pairs of shard's identifier and spec strings: 

  { id: <id>, spec: <spec> }

in either JSON or plaintext representation.

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / attributes / definitions get

Returns a JSON array containing JSON objects representing attribute definitions. If NAME is supplied returns an array containing a single JSON object, if an attribute of the given name exists, otherwise returns an empty array.

Examples:

[{"minimum-number":0,"maximum-number":1152921504606846975,"name":"attr","allowed-values":[],"id":1,"ordered":false}]

[{"minimum-number":5,"maximum-number":10,"name":"attr1","allowed-values":[5, 7, 10],"id":1,"ordered":true}, {"minimum-number":0,"maximum-number":20,"name":"attr2","allowed-values":[],"id":2,"ordered":false}]

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / attributes / definitions post

Establishes or updates a triple attribute definition.

Attributes must be defined before they can be used. Defining an attribute establishes the name of an attribute and any constraints that should be placed on its use.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / attributes / definitions delete

Deletes an existing attribute definition.

If the named attribute definition was found and deleted, returns true.

If the named attribute definition was not found: If error is true (the default), throws an error. If error is false, returns false/nil.

Note that attribute definitions cannot be deleted if they are in use by the static attribute filter. An attempt to delete an attribute definition while it is in use will result in an error.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / attributes / staticFilter get

Returns the current static attribute filter for the triple store.

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / attributes / staticFilter post

Sets the static attribute filter for the triple store.

When set, only triples which match the filter will be returned by any query against the store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / attributes / staticFilter delete

Deletes the current static attribute filter for the triple store (if any).

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / clusterings put

Create clusterings in a vector database. These are used to speedup nearest neighbor search

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / convert-to-vts put

Ensure that the given triple store that is the value of db (default *db*) contains a vector store. If db is already a vector triple store then it will not be modified if supersede is nil. If supersede is true then the existing vector store in db will be completely removed before creating a new vector store in db. Only vector store triples will be deleted, the other triples in the store will remain. The embedder, model and api-key arguments are the same as for create-triple-store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / data-generator / patient post

Adds and commits sample patient triples to the database.
Returns the number of triples added.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / data-generator / phoneCall post

Adds and commits sample phone call triples to the database.
Returns the number of triples added.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / getPreparedTransactions get

Returns a list of XIDs for transactions that have been prepared but not yet committed or rolled back.

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / indices / optimize post

Optimize the indices in the repository at the given effort level.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / jobs / purge-deleted-triples post

Schedules a background operation to purge deleted triples from the specified indices.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / jobs / purge-deleted-triples delete

Cancels purge deleted triple job for the specified indices.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / lock post

Attempts to page in and lock the specified indices or the string table into memory. String or index data added after this call will not be locked.

The ability to lock is limited by the 'memlock' rlimit and available memory. Increasing the 'memlock' limit requires Systems Administrator intervention.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / lock delete

Removes the specified index or string table locks.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / metadata get

Returns a subset of the store's metadata. Currently it returns the attribute definitions and static filter definition. The value may be saved or passed later to set-metadata; it must not be modified.

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / metadata post

Merge the metadata in the metadata argument into the current metadata for the database. It is not currently permitted to change an attribute definition and doing so will result in an error. The metadata value must have come from an earlier call to get-metadata. After calling this function a commit-triple-store must be done to make the changes persistent.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / nearest-neighbor get

compute the semantically closest top N (top-n) strings from a vector triple store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / noCommit get

Return true if given repository is currently in read-only (no-commit) mode, false otherwise.

When this mode is active, all commits from any clients will return an error which effectively prevents writing to the store. This is used to enforce read-only stores.

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / noCommit put

Enable read-only (no-commit) mode. Requires superuser privileges.

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / noCommit delete

Disable read-only (no-commit) mode. Requires superuser privileges.

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / object-embedding get

return the embedding for the object object-id from a vector store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / object-property-value get

return the value of a given property for the object object-id in the vector store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / object-text get

return the text for the object object-id from a vector store

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / reports get

Returns the report with specified path as a JSON object

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / rollback post

Discards any local repository changes, then synchronize to the latest committed repository version on the server. Starts a new transaction.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / settings / purge-rate-limit get

Returns the deleted triple purge operation rate limit (read IOs per second). 0 means no limit.

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / settings / purge-rate-limit post

Sets the deleted triple purge operation rate limit (read IOs per second). Note that this setting is not persistent. It will revert to 0 the next time the database instance is started.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / shard-info get

Returns a string that is the contents of the shard-info file for the repo, or the string "nil" if there is no shard-info file.

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / split-shard put

Split a shard into two shards

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / statements / duplicates get

Returns a cursor of all duplicate triples visible in db inside the current transaction.

In case db is a distributed repository, this will look for and return duplicate triples across shards. The knowledge base repositores are ignored.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / statements / duplicates delete

Deletes duplicate triples in repository.

The MODE argument determines the test used to determine equality when testing for duplicates. Options are quad-based equality (spog, the default) or triple-based equality (spo).

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / storage-report get

Returns a report on db's storage usage, detailing its total disk size, number of triples and active indices, as well as more detailed information about its flavors, memory chunks and obsolete chunks.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / storeID get

Returns the ID of the triple-store. The ID is generated randomly when the triple-store is created. It is an array of four octets.

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / storeID put

Update the triple-store-id of DB to NEW-ID. For internal use only. NEW-ID must be an (unsigned-byte 8) array as would be returned by a call to TRIPLE-STORE-ID.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / tlog / locker get

Returns the process id of the process which is holding the transaction log lock. If the lock is unlocked, returns 0

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / uuid get

Returns a string representing the UUID of the triple-store.

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / validate / shacl get

Perform validation of the specified repository according to the SHACL rules.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / vector-store-import put

Import objects from a vector store. If the source-repo is the empty string and supersede is true then simply delete the vector store inside the repo.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / vector-store-p get

return true if store in a vector store

catalogs / [CATNAME] / repositories / [REPONAME] / shards / [ID] / warmup put

Preloads portions of the repository into RAM for faster access.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / size get

Returns the number of statements in the repository, as an integer.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / sna / paths get

Execute an SNA path search from start to end.

The searchMode controls whether breadthFirst, depthFirst, or bidirectional search is used (breadthFirst is the default). A generator can be built dynamically from the predicate, predicateTo and predicateFrom parameters. Each of these can be specified multiple times. Each URI in the predicate list will be used to find undirected paths whereas each URI in the predicateTo and predicateFrom lists will be used to find objects and subjects (respectively).

The graph parameter, which can be specified multiple times, can be used to restrict path searching to triples in only the specified graphs.

If timeout is supplied, it must be a floating point number and it will be used to limit the duration of the path searching.

If limit is supplied, it must be a positive integer and at most this many paths will be returned.

Lastly, the maximumDepth parameter can be used to limit the total search depth.

The return value depends on the version parameter. If the version is 1, then it will be JSON list of lists where each sublist contains the nodes along a path including the starting and ending nodes. If version is 2, then the result will be a JSON object with two keys: "paths" and "status". "paths" will be a list of the paths found (as in version 1). Each node will be either a subject or object of the triples that created the path. "status" indicates the reason the search stopped and can be one of "complete", "limit-reached", or "timeout". If version is not supplied or is anything other than 2, then the version 1 format will be used in order to be backwards compatible. Version 1 support is deprecated and will be phased out in the future.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / snaGenerators / [NAME] put

Creates a new SNA generator under the given name.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / solrParameters get

Return the Solr settings for the repository.

catalogs / [CATNAME] / repositories / [REPONAME] / solrParameters post

Set the Solr settings for the repository

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / sparql get post

Execute a SPARQL or Prolog select query.

Arguments of the form $varname=value specify variable bindings. Variables appearing in the query can be bound to a specific value outside the actual query using this mechanism. The value must be an N-Triples encoded RDF value. For example, if the value is an IRI, it must be wrapped in angle brackets.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / spin / function get

Return information about any defined SPIN functions

catalogs / [CATNAME] / repositories / [REPONAME] / spin / function / [URI] get

Return information about the SPIN function associated with uri.

catalogs / [CATNAME] / repositories / [REPONAME] / spin / function / [URI] put

Associate a SPIN function with uri.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / spin / function / [URI] delete

Remove the SPIN function associated with uri.

catalogs / [CATNAME] / repositories / [REPONAME] / spin / magicproperty get

Return a list of SPIN magic properties defined for the store.

catalogs / [CATNAME] / repositories / [REPONAME] / spin / magicproperty / [URI] get

Return information about the SPIN magic property associated with uri.

catalogs / [CATNAME] / repositories / [REPONAME] / spin / magicproperty / [URI] put

Associate a SPIN magic property with uri.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / spin / magicproperty / [URI] delete

Remove the SPIN magic property associated with uri.

catalogs / [CATNAME] / repositories / [REPONAME] / split-shard put

Split a shard into two shards

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / statement put

Add a triple to the repository.

The subj, pred, and obj arguments must be supplied and are used to fill in the subject, predicate and object parts of the triple. The context argument is used to fill in the triple's graph but may be left off. In this case, the triple's graph will be the default graph of the repository.

The subj, pred, obj, and context (if supplied) arguments must all be in URI encoded N-Triples notation.

The service returns the triple-ID of the newly added triple.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / statements post put

Add triples to the triple-store.

This service can add triples in several ways:

When the PUT method is used, triples in the supplied contexts are first deleted (if no context is supplied, then the store is completely emptied), whereas the POST method just adds triples. The value returned is an integer indicating the number of triples loaded.

The Content-Type header determines the way the given data is interpreted. The following formats are supported:

Small data sources are best loaded via the direct facility whereas large data sources should be loaded via agload.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / statements get

Retrieves statements (triples) by matching against their components.

All parameters are optional -- when none are given, every statement in the store is returned. The patterns to match come in pairs for _s_ubject, _p_redicate, _o_bject, and _g_raph. When given, they should be specified in N-triples notation. subj, pred, obj and context can be given multiple times. The subjEnd, predEnd, objEnd and contextEnd can only by specified if exactly one of their matching entries is supplied. At most one end parameter may be supplied.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / statements delete

Delete statements (triples) by matching against their components.

All parameters are optional -- when none are given, every statement in the store is deleted. The patterns to match come in pairs for _s_ubject, _p_redicate, _o_bject, and _g_raph. When given, they should be specified in N-triples notation.The subjEnd, predEnd, objEnd and contextEnd can only by specified if their matching entries is also supplied. At most one end parameter may be supplied.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / statements / delete post

Delete a set of triples from the store.

Expects a JSON-encoded array of statements as the posted data, and deletes the first triple found that matches each statement.

The Content-Type must be application/json.

Returns the number of deletes that succeeded.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / statements / duplicates get

Returns a cursor of all duplicate triples visible in db inside the current transaction.

In case db is a distributed repository, this will look for and return duplicate triples across shards. The knowledge base repositores are ignored.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / statements / duplicates delete

Deletes duplicate triples in repository.

The MODE argument determines the test used to determine equality when testing for duplicates. Options are quad-based equality (spog, the default) or triple-based equality (spo).

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / statements / id get

Return triples by their triple IDs

catalogs / [CATNAME] / repositories / [REPONAME] / statements / query get post

Retrieves statements (triples) by matching against their components.

All parameters are optional -- when none are given, every statement in the store is returned. The patterns to match come in pairs for _s_ubject, _p_redicate, _o_bject, and _g_raph. When given, they should be specified in N-triples notation. subj, pred, obj and context can be given multiple times. The subjEnd, predEnd, objEnd and contextEnd can only by specified if exactly one of their matching entries is supplied. At most one end parameter may be supplied.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / statements / transform post put

Similar to /statements/ but is used for loading documents that don't represent RDF data directly and should therefore be pre-processed according to format-specific rules. The data to load is obtained from the request body.

In addition to specific rule parameters like TR-ID, TR-PREFIX, etc., the TRANSFORM-RULES parameter may be used to specify transformation rules.

If submitted as an HTTP POST request, then the new triples are added to the CONTEXT graph. If a PUT is used, then any existing triples in that graph are first removed.

Currently handles (TYPE or CONTENT-TYPE) JSON, JSONL, and CSV documents.

The special parameters for each content-type are prefixed accordingly. For example, CSV-COLUMNS, JSON-STORE-SOURCE, etc.

The HTTP response body contains the number of triples added.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / storage-report get

Returns a report on db's storage usage, detailing its total disk size, number of triples and active indices, as well as more detailed information about its flavors, memory chunks and obsolete chunks.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / storeID get

Returns the ID of the triple-store. The ID is generated randomly when the triple-store is created. It is an array of four octets.

catalogs / [CATNAME] / repositories / [REPONAME] / storeID put

Update the triple-store-id of DB to NEW-ID. For internal use only. NEW-ID must be an (unsigned-byte 8) array as would be returned by a call to TRIPLE-STORE-ID.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / string-table-size get

Return the size of the string table in bytes.

catalogs / [CATNAME] / repositories / [REPONAME] / suppressDuplicates get

Returns the store's current duplicate suppression strategy.

Duplicate suppression controls if and how AllegroGraph checks triples that are about to be committed against triples that already exist in the triple-store.

It can be:

catalogs / [CATNAME] / repositories / [REPONAME] / suppressDuplicates put

Sets the duplicate suppression strategy for the store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / suppressDuplicates delete

Disable duplicate suppression for the store.

This is the equivalent of using PUT /repositories/(name)/suppressDuplicates with false as the type argument.

catalogs / [CATNAME] / repositories / [REPONAME] / tlog / locker get

Returns the process id of the process which is holding the transaction log lock. If the lock is unlocked, returns 0

catalogs / [CATNAME] / repositories / [REPONAME] / tripleCache get

Returns the size of the triple-cache (SPOGI cache).

Returns zero if the cache is disabled.

catalogs / [CATNAME] / repositories / [REPONAME] / tripleCache put

Sets the size of the triple-cache (SPOGI cache).

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / tripleCache delete

Disable the triple-cache (SPOGI cache).

catalogs / [CATNAME] / repositories / [REPONAME] / unique / [COLUMN] get post

Return the unique values for the specified column.

column must be one of:

Use the subj, pred, obj and context arguments to limit the triples that are examined.

This can be very expensive in time and space on a large triple-store.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / useSecondaryIndices get

Return whether or not the store should use secondary indices (UPI-maps).

catalogs / [CATNAME] / repositories / [REPONAME] / useSecondaryIndices put

Change the secondary indices (UPI-maps) usage setting.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / useSecondaryIndices delete

Turn off secondary indices (UPI-maps) usage.

catalogs / [CATNAME] / repositories / [REPONAME] / uuid get

Returns a string representing the UUID of the triple-store.

catalogs / [CATNAME] / repositories / [REPONAME] / validate / shacl get

Perform validation of the specified repository according to the SHACL rules.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / vector-store-import put

Import objects from a vector store. If the source-repo is the empty string and supersede is true then simply delete the vector store inside the repo.

arguments

catalogs / [CATNAME] / repositories / [REPONAME] / vector-store-p get

return true if store in a vector store

catalogs / [CATNAME] / repositories / [REPONAME] / warmup put

Preloads portions of the repository into RAM for faster access.

arguments

close post

Tell the server to close a triple-store

arguments