Linked Data API Vocabulary
Configuration vocabulary for the Linked Data API
API
SPARQL endpoint
The endpoint used to serve up the results that are exposed by the API. This should not include the query parameters within the URI.
Base URI
The base URI of the API, which is distinct from the URI of the SPARQL endpoint that it queries or the base URI of the instances that it returns. This base URI is stripped from the request URI before any matching is done against the endpoints defined for the API.
Content Negotiation
The mechanism used within the URI to override normal content negotiation and deliver a particular results format.
Vocabulary
A vocabulary that should be used by the configuration to provide labels for properties. To be recognised for filtering, a property must be defined either within this vocabulary or in the configuration file itself.
Maximum Page Size
The maximum size of lists that will be returned by the API.
Default Page Size
The default size of lists that will be returned by the API or endpoint.
Content negotiation type
Suffix-Based Content Negotiation
This content negotiation strategy uses the suffix used on the last segment within the request URI to indicate the formatter that should be used to format the results of the request.
Parameter-Based Content Negotiation
This content negotiation strategy uses the _format parameter within the URI to indicate the formatter that should be used to format the results of the request.
Endpoint
An endpoint specified by the API, against which requests can be made.
An endpoint exposed by the API.
Item Endpoint
An endpoint that returns information about a single instance.
List Endpoint
An endpoint that returns information about a list of instances.
URI template
A template that can be used to match against request URIs. This template can contain variable names within {}s; when the URI is matched then the substrings that appear in these locations are bound to the named variable.
Item template
A template for the URI of the item that the item endpoint should return. Any instances of {varName} within the string are replaced by the value of the relevant variable.
Selector
The selector that should be used to generate the list of items.
Viewer
A viewer that can be used with the endpoint.
Default Viewer
The default viewer used if none is explicitly selected within the request URI.
Formatter
A formatter that can be used with the endpoint.
Default Formatter
The default formatter used if none is explicitly selected within the request URI.
A specification of an ordered list of resources.
Parent
The parent selector, from which filters and sort specifications may be inherited.
Select
A SPARQL WHERE and ORDER BY clause that can be used to select an ordered list of resources. It should include the binding of an ?item variable for the selected items.
Where
A GroupGraphPattern suitable for embedding within a SPARQL WHERE clause. This is used for filtering the set of items that the selector selects.
Order By
A space separated sequence of OrderConditions suitable for using in a SPARQL ORDER BY clause. This is used to order the sequence of items that the selector selects.
Filter
A set of parameter bindings in the same format as is used within the query of a URI, used to provide a simple way of filtering the sequence of items that the selector selects.
Sort
A sequence of comma-separated sort specifications indicating the sorting of the items in the sequence that the selector selects. A leading hyphen indicates a reverse sort.
A specification of a view of a particular item.
DESCRIBE Viewer
A viewer that returns a graph created from a DESCRIBE query.
Labelled DESCRIBE Viewer
A viewer that returns the graph created from a DESCRIBE query, supplemented by labels for linked resources.
Basic Viewer
A viewer that returns the type and label of the item.
Name
The name of the resource.
Include
Other viewers that describe properties that should be incorporated into this view.
Template
SPARQL that can be used to construct a graph based on an item (identified in the SPARQL as ?item).
Property
A property chain (which may be a single property) that indicates information that should be included in the view.
Properties
A comma-separated list of property paths that indicate the information that should be included in the view.
A formatter that creates a representation from an RDF graph.
Mime Type
The mime type that the formatter returns and that it should be used with.
RDF/XML Formatter
A formatter that generates an RDF/XML representation of an RDF graph
Default RDF/XML Formatter
A formatter that gives the default RDF/XML representation of an RDF graph
Turtle Formatter
A formatter that generates an Turtle representation of an RDF graph
Default Turtle Formatter
A formatter that gives the default Turtle representation of an RDF graph
JSON Formatter
A formatter that generates a simple JSON representation of an RDF graph
Default JSON Formatter
A formatter that gives the default simple JSON representation of an RDF graph
XML Formatter
A formatter that generates a simple XML representation of an RDF graph
Default XML Formatter
A formatter that gives the default simple XML representation of an RDF graph
CSV Formatter
A formatter that generates a simple CSV representation of an RDF graph
Default CSV Formatter
A formatter that gives the default simple CSV representation of an RDF graph
XSLT Formatter
A formatter that uses an XSLT stylesheet to generates a representation of an RDF graph
Stylesheet
The XSLT stylesheet that should be used by an XSLT formatter to generate a representation of the RDF graph
Definition
The API Endpoint
Items
The list of resources described by the page that are in the List the page is part of.
List
a List represents the full set of resources that match the request against the Endpoint; a Page lists a subset of the List.
Page
A page returned in response to a request to an Endpoint.
Extended Metadata Version
a document containing the same data, plus extra document-centric metadata.