Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The CLAIMS Direct Index is created and maintained using Apache SOLR (http://lucene.apache.org/solr/) and hence, based on a schema definition, all functionality exposed by SOLR is available through this search web service, including the entire Apache Lucene query language, result set sorting, facet searching, grouping etc. SOLR is an extremely versatile and robust search platform and it is advised to fully familiarize yourself with SOLR and Lucene (http://lucene.apache.org/java/docs/index.html), upon which SOLR is built, before attempting to use this service.

 

/search/schema

The schema method returns the SOLR schema field definitions.  This service, like the search service below, is built directly on top of the SOLR Schema API and therefore exposes all read-only functionality available.

...

Code Block
{
   "status" : "success"
   "time" : "0.041030",
   "content" : {
      "responseHeader" : {
         "status" : 0,
         "QTime" : 5
      },
      "fields" : [
         {
            "indexed" : true,
            "uniqueKey" : true,
            "name" : "ucid",
            "required" : true,
            "stored" : true,
            "type" : "string"
         },
         {
            "name" : "ttl",
            "indexed" : true,
            "type" : "alexandria_text",
            "stored" : false,
            "multiValued" : true
         }
      ]
   },
}

 

/search/query

This service is built directly on top of the SOLR REST services and therefore, unless otherwise noted, accepts all parameters that SOLR REST services accept. For a comprehensive treatment, please see Solr SOLR Query Parameters.

Method(s)GET | POST 
Path/search/query 
 

Common Query Parameters:

ParameterValueDescription
@qString: ex. solarAny syntactically correct search string
@qtString: ex. attachmentsOptional parameter to specify attachment search
@flString: Ex. ucid,ttlComma-separated list of fields to return. Default is all stored fields. (NOTE: These fields must have the attribute stored="true")
@rowsInteger: Ex. 25Positive value indicating maximum number of documents to return. Default value is 10.
@startInteger: Ex. 0

0-based offset into result set. This parameter as well as the @rows parameter above can be used for paging. Default value is 0.

Maximum @start value is 30000. Values above 30000 will be reset to zero. This limit is in place to prevent SOLR "deep paging" which causes serious memory swapping on the SOLR servers.

@attachments (v2.5, JSON only)Boolean: Ex. 1|0Return attachment list per ucid when available
@family.simple (v2.5, JSON only)Boolean: Ex. 1|0Return the simple family per ucid when available
@family.extended (v2.5, JSON only)Boolean: Ex. 1|0Return the extended family per ucid when available

For a thorough treatment, please see Query Syntax and Parsing.

...