Cal Enviro Screen Data Dictionary

Endpoints

The Data API provides these actions. Creating or updating records requires appropriate permissions; the query actions read public DataStore records.

Query examples

"https://ckan.cdt.dev.datopian.com/api/3/action/datastore_search?resource_id=cb5fe61f-a1af-4e53-83e2-fd3e19d0e707&limit=5"

"https://ckan.cdt.dev.datopian.com/api/3/action/datastore_search?resource_id=cb5fe61f-a1af-4e53-83e2-fd3e19d0e707&q=jones"

"https://ckan.cdt.dev.datopian.com/api/3/action/datastore_search_sql?sql=SELECT%20%2A%20FROM%20%22cb5fe61f-a1af-4e53-83e2-fd3e19d0e707%22%20LIMIT%205"

SQL queries depend on whether SQL search is enabled by the portal.

OData query

Use the resource's OData URL and its field names for paging, selecting columns, or filtering rows.

ODATA_RESOURCE_URL?$top=5
ODATA_RESOURCE_URL?$skip=5&$top=5
ODATA_RESOURCE_URL?$select=FIELD_NAME&$filter=FIELD_NAME eq 'VALUE'

Replace ODATA_RESOURCE_URL, FIELD_NAME, and VALUE with the details for the selected resource. See the OData query options guide (opens in a new tab) for more examples.

Use the API in code

JavaScript (JSONP)

var data = { resource_id: 'cb5fe61f-a1af-4e53-83e2-fd3e19d0e707', limit: 5, q: 'jones' };
$.ajax({
  url: 'https://ckan.cdt.dev.datopian.com/api/3/action/datastore_search',
  data: data,
  dataType: 'jsonp',
  success: function (response) {
    console.log(response.result.total, response.result.records);
  }
});

Python

import json
from urllib.request import urlopen

url = 'https://ckan.cdt.dev.datopian.com/api/3/action/datastore_search?resource_id=cb5fe61f-a1af-4e53-83e2-fd3e19d0e707&limit=5'
with urlopen(url) as response:
    result = json.load(response)['result']
print(result['total'], result['records'])

For parameters and response fields, see the CKAN DataStore documentation (opens in a new tab).