Versions Compared

Key

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

...

  • query: search the index and return user-specified fields 
  • schema: return the field and field type definitions of the SOLR index

 

Info

Note: The CLAIMS

...

Direct™ SOLR index does not store all text. This means that although the entire index is searchable, only certain fields are available for inclusion in a result set. For a list of retrievable fields, see the schema where @stored="true"

...

, or use the schema

...

 method of the search service to inspect field attributes.

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.

...

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.

 

     
Method(s)GET 
Path








/search/schemaentire Entire schema
/search/schema/fields 
/search/schema/dynamicfields 
 /search/schema/fieldtypes 
/search/schema/copyfields 
/search/schema/name 
/search/schema/version 
 /search/schema/uniquekey 
 /search/schema/similarity 
 /search/schema/solrqueryparser/defaultoperator 
Parameters ValuesDescription
@flString: ex. ttlfield Field name or comma-separated list of field names
@showDefaultsBool: ex. 1include Include in the response all default property values from the associated field type
@includeDynamicBool: ex. 0if If the fl param is specified, matching dynamic fields are included in the response and identified with the dynamicBase property; if the fl param is not specified, the includeDynamic parameter is ignored

...

Code Block
{ "status" : "success",
   "time" : "0.853972"
   "content" : {
      "responseHeader" : {
         "status" : 0,
         "params" : {
            "qt" : "standard",
            "wt" : "json",
            "q" : "*:*",
            "rows" : "1",
            "timeAllowed" : "300000",
            "indent" : "true",
            "fl" : "ucid",
            "start" : "0"
         },
         "QTime" : 29,
         "pager" : {
            "lastPage" : 89565469,
            "firstPage" : 1,
            "totalEntries" : 89565469,
            "entriesOnThisPage" : 1,
            "currentPage" : 1,
            "entriesPerPage" : "1",
            "nextPage" : 2,
            "previousPage" : null
         }
      },
      "response" : {
         "maxScore" : 1,
         "start" : 0,
         "numFound" : 89565469,
         "docs" : [
            {
               "ucid" : "WO-2008080614-A1"
            }
         ]
}}}
Info
title

Note

: As of CDWS v2.4, a special HTTP header Accept type of text/x-solr returns the raw SOLR response. There is no paging block, nor response wrapper.

...