Versions Compared

Key

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

...

MethodGET
Path








/search/schemaEntire 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 
ParametersParameter ValuesDescription
@flString: ex. ttlField name or comma-separated list of field names
@showDefaultsBoolean: ex. 1Include in the response all default property values from the associated field type
@includeDynamicBoolean: ex. 0If 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

...

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 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.

...