Talk:IDigBio API: Difference between revisions

break into sections
(move link to examples for elasticsearch)
(break into sections)
Line 196: Line 196:
== Searching iDigBio ==
== Searching iDigBio ==


At this time the recommended method for searching iDigBio is to use the Portal search, not the API. The portal also provides bulk download capabilities for aquiring larger sets of data.  See: https://www.idigbio.org/portal
=== Search Portal and Bulk Record Downloads ===
 
The recommended method for searching iDigBio is to use the Portal search, not the API. The portal also provides bulk download capabilities for aquiring larger sets of data.  See: https://www.idigbio.org/portal
 
=== Elasticsearch Overview ===


The iDigBio API does not currently (yet!) provide query/search capabilities.  However, the back-end Elasticsearch interface is public-facing and available for use by advanced users and programmers. This is the same interface that is used by the iDigBio Portal search.
The iDigBio API does not currently (yet!) provide query/search capabilities.  However, the back-end Elasticsearch interface is public-facing and available for use by advanced users and programmers. This is the same interface that is used by the iDigBio Portal search.
Line 202: Line 206:
'''Direct queries to the iDigBio Elasticsearch service should be considered an Advanced operation.'''
'''Direct queries to the iDigBio Elasticsearch service should be considered an Advanced operation.'''


An overview of Elasticsearch: http://www.elasticsearch.org/overview/elasticsearch/
According to the Elasticsearch project site, Elasticsearch is a "flexible and powerful open source, distributed, real-time search and analytics engine."  For more information, see http://www.elasticsearch.org/overview/elasticsearch/


The iDigBio search index provides two document types to query on: Records and Media Records. Search results are returned as JSON-formatted documents. Each type can be queried through the following respective URLs:
The iDigBio search index provides two document types to query on: Records and Media Records. Search results are returned as JSON-formatted documents. Each type can be queried through the following respective URLs:
Line 219: Line 223:
=== Elasticsearch - Records ===
=== Elasticsearch - Records ===


These are the terms currently available in the indexes for '''Records''' type of queries to Elasticsearch:
These following terms are currently available in the indexes for '''Records''' type of queries to Elasticsearch:


<pre>
<pre>
1,554

edits