new DataEndpoint()
OO wrapper around data views endpoint.
- Source:
Properties:
Name | Type | Argument | Default | Description |
---|---|---|---|---|
name |
String | |||
instanceName |
String | |||
query |
Object | |||
excluded_fields |
String | |||
order_by |
String | |||
page_size |
Number | |||
expand |
String | |||
class |
String | |||
description |
String |
<optional> |
null | |
links |
String |
<optional> |
{} |
Methods
-
fetchData(cache_key, filters)
-
Fetches Data Objects matching the Data View properties.
Parameters:
Name Type Description cache_key
String the cache key for the result
filters
Object object containing the filters for the query.
- Source:
Returns:
- Type
- Promise
Example
DataEndpoint.please().fetchData({name: 'dataViewName', instanceName: 'test-one'}).then(function(dataObjects) {});