From n² wiki

This page is the main API reference for the web services exposed from the Talis Platform at api.talis.com.

The API adheres to the principles of REST, correctly using HTTP methods to read, create, update and search data and describing its formats using Internet media types.

The following sections include some recommended background reading on the basic design and features of the Platform as well as more detailed documentation on each of the services.

You may also want to refer to the Guides and Tutorials or the Platform FAQ.

Contents 1 Read Me First 2 Core Concepts 3 Response Formats 4 API 4.1 Stores 4.2 Orchestration 4.3 Additional Services

Read Me First

• Introduction To The Platform -- introduces the basic terms, features and model for the platform
• Use Of Rest -- some additional background on REST and use of HTTP
• Service Checklist -- some basic design principles we follow when designing new services for the Platform
• Store Naming -- a note on naming conventions and store URIs
• Authentication -- how authentication is implemented
• Access Control -- how access control is managed through user roles and capabilities
• Terms and Conditions

Core Concepts

• Field Predicate Map -- configuring simple labels for properties to supporting text searching
• Query Profile -- manage relevance ranking for full text searching
• Changesets -- a mechanism for updating RDF data

Response Formats

• Output Types -- general notes on output formats and content negotiation
• RDF/JSON Serialization -- specification for a JSON serialization of RDF

API

• API Site Map -- a quick reference to the URL structure of the API

Stores

• http://api.talis.com/stores/{store} - A store
• The Contentbox
  • http://api.talis.com/stores/{storename}/items - Store Contentbox, where binary content can be stored
  • http://api.talis.com/stores/{storename}/items/{id} - An item in the contentbox
• The Metabox
  • http://api.talis.com/stores/{storename}/meta - Store Metabox, where RDF metadata is stored for each store
  • http://api.talis.com/stores/{storename}/meta/changesets - The collection of Changesets belonging to a store's Metabox
  • http://api.talis.com/stores/{storename}/meta/graphs - private graphs collection
  • http://api.talis.com/stores/{storename}/meta/graphs/{id} - a private graph
  • http://api.talis.com/stores/{storename}/meta/graphs/{id}/changesets - the collection of Changesets belonging to a Private Graph
• SPARQL Endpoints
  • http://api.talis.com/stores/{storename}/services/sparql - SPARQL service that can be used to query the associated store's Metabox
  • http://api.talis.com/stores/{storename}/services/multisparql - SPARQL service that can be used to query the associated store's Metabox plus additional private graphs
• Store Services
  • http://api.talis.com/stores/{storename}/services/oai-pmh - OAI service
  • http://api.talis.com/stores/{storename}/services/augment - augment service
  • http://api.talis.com/stores/{storename}/services/facet - facet service
• Jobs
  • http://api.talis.com/stores/{storename}/jobs - scheduled job collection
  • http://api.talis.com/stores/{storename}/jobs/{id} - a scheduled job
• Snapshots
  • http://api.talis.com/stores/{storename}/snapshots - snapshot collection
• Store Configuration
  • http://api.talis.com/stores/{storename}/config/fpmaps/1 - store Field Predicate Map configuration
  • http://api.talis.com/stores/{storename}/config/queryprofiles/1 - store Query Profile configuration
• Groups an experimental feature
  • http://api.talis.com/groups -- The collection of groups on the platform
  • http://api.talis.com/groups/{groupname} -- A Store Group
  • http://api.talis.com/groups/{groupname}/items -- A Store group Contentbox
  • http://api.talis.com/groups/{groupname}/meta -- A Store Group Metabox

Orchestration

• http://api.talis.com/orch

Additional Services

• http://api.talis.com/tx - XSLT transformation service