Datasets Endpoint
The datasets endpoint returns a list of datasets available for consuming and publishing data within the Streaming API.
The responses from these endpoints also include the URLs necessary to get changes and push changes to Pure Farming.
All Datasets
The datasets endpoint gets a list of all known datasets, including metadata about each one.
GET /data/streaming/datasets
[
{
"name": "holdings",
...
},
...
]
This response is an array of individual dataset responses.
Individual Dataset
The dataset endpoint returns metadata about a single dataset.
GET /data/streaming/datasets/{datasetid}
Where {datasetId}
is the name of the dataset.
Response
{
"name": "holdings",
"url": "https://api.purefarming.com/data/streaming/datasets/holdings",
"changes": "https://api.purefarming.com/data/streaming/datasets/holdings/changes",
"updates": "https://api.purefarming.com/data/streaming/datasets/holdings/resources",
"containedTypes": [ "holdingResource" ]
}
Property | Description | Data Type |
---|---|---|
Name | The name of the dataset (also called the dataset id) | string |
URL | A link to the dataset metadata | URI |
Changes | A link to get the latest changes to the resources within the dataset | URI |
Updates | A link publish updates for a resource | URI |
Contained Types | An array of resource types contained in this dataset | Array of Strings |