...
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. Bulk downloads are not supported through shared services. Search is limited to 30K documents per batch because deep paging can produce odd resultsplace undue stress on the system.
| Method(s) | GET | POST |
|---|
| Path | /search/query |
| | Common Query Parameters: | Parameter | Value | Description |
|---|
| @q | String: ex. solar | Any syntactically correct search string | | @qt | String: ex. attachments | Optional parameter to specify attachment search | | @fl | String: ex. ucid,ttl | Comma-separated list of fields to return. Default is all stored fields. (Note: These fields must have the attribute stored="true") | | @rows | Integer: ex. 25 | Positive value indicating maximum number of documents to return. Default value is 10. | | @start | Integer: 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|0 | Return attachment list per ucid when available | | @family.simple (v2.5, JSON only) | Boolean: ex. 1|0 | Return the simple family per ucid when available | | @family.extended (v2.5, JSON only) | Boolean: ex. 1|0 | Return the extended family per ucid when available | | @ls (v3.4, JSON only) | Boolean: ex. 1|0 | Return all legal status information per ucid when available | | @ls.country (v3.4 JSON only) | String: ex. US | Return legal status information per ucid published by a particular country. Currently supported: US (PAIR) and EP (Inpadoc) |
For a thorough treatment, please see Query Syntax and Parsing. |
...