Interface apiDataset

This Object contains many single objects.

Since

0.1.0

interface apiDataset {
    links: DatasetLinks;
    meta: DatasetMeta;
    results: apiObject[];
}

Index

Properties

links meta results

Properties

links

links: DatasetLinks

URLs used for paginated results.

Type Declaration

This set of URLs are used for navigating the paginated results.

first: URL

URL to the first page of the complete dataset
last: URL

URL of the last page of the complete dataset. Must default to the same value as first if there is only one page of results.
next: URL

URL to the next page of results in the complete dataset. Must default to null if there is only one page of results or there is no next page.
prev: URL

URL to the previous page of results in the complete dataset. Must default to null if the current page is the first page.

meta

meta: DatasetMeta

Definitions for dataset.

Type Declaration

pagination: DatasetMetaPagination

Pagination details.

results

results: apiObject[]

DataObjects part of this dataset.

Type Declaration

This object is a single row of a dataset.

[key: string]: any

Field data
_urls: APIDataObjectUrls

URLs for this objects relationships.
id: number

Unique ID from the database. Generally this will be the Primary Key.