Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
133 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
<html> | ||
<body> | ||
<div> | ||
<div class="modal-header"> | ||
<h3> | ||
CKAN Data API | ||
</h3> | ||
</div> | ||
<div class="modal-body"> | ||
<p><strong>Access resource data via a web API with powerful query | ||
support</strong>. Further information in the <a | ||
href="http://docs.ckan.org/en/latest/using-data-api.html" target="_blank">main | ||
CKAN Data API and DataStore documentation</a>.</p> | ||
|
||
<div class="accordion-group"> | ||
<div class="accordion-heading"> | ||
<a class="accordion-toggle" data-toggle="collapse" href=".collapse-endpoints">Endpoints »</a> | ||
</div> | ||
<div class="collapse-endpoints in accordion-body collapse"> | ||
<div class="accordion-inner"> | ||
<p>The Data API builds directly on ElasticSearch, with a resource API | ||
endpoint being equivalent to a single index 'type' in ElasticSearch. | ||
This means you can directly re-use <a | ||
href="http://www.elasticsearch.org/guide/appendix/clients.html" | ||
_target="blank">ElasticSearch | ||
client libraries</a> when connecting to the API endpoint.</p> | ||
<table class="table-condensed table-striped table-bordered"> | ||
<thead></thead> | ||
<tbody> | ||
<tr> | ||
<th>Base</th> | ||
<td><code>{{ datastore_root }}</code></td> | ||
</tr> | ||
<tr> | ||
<th>Query</th> | ||
<td> | ||
<code>{{ datastore_root }}/_search</code> | ||
</td> | ||
</tr> | ||
<tr> | ||
<th>Query example</th> | ||
<td> | ||
<code><a href="{{ datastore_root }}/_search?size=5&pretty=true" target="_blank">{{ datastore_root }}/_search?size=5&pretty=true</a></code> | ||
</td> | ||
</tr> | ||
<tr> | ||
<th>Schema (Mapping)</th> | ||
<td> | ||
<code><a href="{{ datastore_root }}/_mapping" target="_blank">{{ datastore_root }}/_mapping?pretty=true</a></code> | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
</div> | ||
</div> | ||
</div> | ||
|
||
<div class="accordion-group"> | ||
<div class="accordion-heading"> | ||
<a class="accordion-toggle" href=".collapse-querying" data-toggle="collapse">Querying | ||
»</a> | ||
</div> | ||
<div class="collapse-endpoints in accordion-body"> | ||
<div class="accordion-inner"> | ||
<strong>Query example (first 5 results)</strong> | ||
<p> | ||
<code><a href="{{ datastore_root }}/_search?size=5&pretty=true" target="_blank">{{ datastore_root }}/_search?size=5&pretty=true</a></code> | ||
</p> | ||
|
||
<strong>Query example (results with 'jones' in <code>title</code> field)</strong> | ||
<p> | ||
<code><a href="{{ datastore_root }}/_search?q=title:jones&size=5&pretty=true" | ||
target="_blank">{{ datastore_root }}/_search?q=title:jones&size=5&pretty=true</a></code> | ||
</p> | ||
|
||
<strong>Schema (Mapping)</strong> | ||
<p> | ||
<code><a href="{{ datastore_root }}/_mapping" target="_blank">{{ datastore_root }}/_mapping?pretty=true</a></code> | ||
</p> | ||
|
||
<strong>Endpoint (for clients)</strong> | ||
<p> | ||
<code>{{ datastore_root }}</code> | ||
</p> | ||
</div> | ||
</div> | ||
</div> | ||
|
||
<div class="accordion-group"> | ||
<div class="accordion-heading"> | ||
<a class="accordion-toggle" href=".collapse-javascript" data-toggle="collapse">Example: Javascript</a> | ||
</div> | ||
<div class="accordion-body collapse-javascript in"> | ||
<div class="accordion-inner"> | ||
<p>A simple ajax (JSONP) request to the data API using jQuery.</p> | ||
<pre> | ||
var data = { | ||
size: 5 // get 5 results | ||
q: 'title:jones' // query on the title field for 'jones' | ||
}; | ||
$.ajax({ | ||
url: '{{ datastore_root }}/_search', | ||
data: data, | ||
dataType: 'jsonp', | ||
success: function(data) { | ||
alert('Total results found: ' + data.hits.total) | ||
} | ||
});</pre> | ||
</div> | ||
</div> | ||
</div> | ||
|
||
<div class="accordion-group"> | ||
<div class="accordion-heading"> | ||
<a class="accordion-toggle" href=".collapse-javascript" data-toggle="collapse">Example: Python</a> | ||
</div> | ||
<div class="accordion-body collapse-javascript in"> | ||
<div class="accordion-inner"> | ||
<pre> | ||
import urllib | ||
url = '{{ datastore_root }}/_search?size=5&q=title:jones' | ||
fileobj = urllib.urlopen(url) | ||
print fileobj.read() | ||
</pre> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
|
||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters