This is the documentation for the Store status API. It provides access to the stores status which may be read-only or read-write.

URI Pattern

http://api.talis.com/stores/{storename}/config/access-status

Resource Operations

Request Parameters

Store Status

A store may be in two different statuses:

• read-only (http://schemas.talis.com/2006/bigfoot/statuses#read-only)
• read-write (http://schemas.talis.com/2006/bigfoot/statuses#read-write)

Currently a store may be put into read-only mode if it is being reindexed or a snapshot is being taken.

A typical response to a request for current status of a store might be:

 <rdf:RDF
     xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
     xmlns:j.0="http://schemas.talis.com/2006/bigfoot/configuration#" > 
   <rdf:Description rdf:about="http://api.talis.com/stores/mystore/config/access-status">
     <rdf:type rdf:resource="http://schemas.talis.com/2006/bigfoot/configuration#AccessStatus"/>
     <j.0:statusMessage></j.0:statusMessage>
     <j.0:retryInterval>0</j.0:retryInterval>
     <j.0:accessMode rdf:resource="http://schemas.talis.com/2006/bigfoot/statuses#read-write"/>
   </rdf:Description>
 </rdf:RDF>

If the store is in read only mode the result might be:

 <rdf:RDF
     xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
     xmlns:j.0="http://schemas.talis.com/2006/bigfoot/configuration#" > 
   <rdf:Description rdf:about="http://api.talis.com/stores/mystore/config/access-status">
     <rdf:type rdf:resource="http://schemas.talis.com/2006/bigfoot/configuration#AccessStatus"/>
     <j.0:statusMessage>Sorry, store is read only while backup is performed.</j.0:statusMessage>
     <j.0:retryInterval>60</j.0:retryInterval>
     <j.0:accessMode rdf:resource="http://schemas.talis.com/2006/bigfoot/statuses#read-only"/>
   </rdf:Description>
 </rdf:RDF>

The JSON output is in RDF JSON format :

 {
   "http:\/\/api.talis.com\/stores\/mystore\/config\/access-status" : {
     "http:\/\/www.w3.org\/1999\/02\/22-rdf-syntax-ns#type" : [ { 
       "value" : "http:\/\/schemas.talis.com\/2006\/bigfoot\/configuration#AccessStatus", "type" : "uri" } ],
     "http:\/\/schemas.talis.com\/2006\/bigfoot\/configuration#accessMode" : [ { 
       "value" : "http:\/\/schemas.talis.com\/2006\/bigfoot\/statuses#read-write", "type" : "uri" } ],
     "http:\/\/schemas.talis.com\/2006\/bigfoot\/configuration#retryInterval" : [ { "value" : "0", "type" : "literal" } ],
     "http:\/\/schemas.talis.com\/2006\/bigfoot\/configuration#statusMessage" : [ { "value" : "", "type" : "literal" } ]
   }
 }