Dataset
Base definition
1
{
2
"kind": "dataset",
3
"id": string,
4
"name": string,
5
"url": string,
6
"uri": string,
7
"doi": string,
8
"owner": {
9
"kind": string("organization" | "user"),
10
"name": string
11
}
12
}
Copied!
List definition
In addition to the base definition, any dataset resource returned by a
list request will contain the following properties:1
{
2
"description": string,
3
"createdAt": integer,
4
"updatedAt": integer,
5
"tableCount": integer,
6
"numBytes": integer,
7
"totalNumBytes": integer,
8
"temporalRange": [integer, integer],
9
"temporalPrecision": string,
10
"geoBBox": {
11
"westLongitude": number,
12
"eastLongitude": number,
13
"northLatitude": number,
14
"southLatitude": number
15
},
16
"publicAccessLevel": string("none"|"overview"|"metadata"|"sample"|"data"|"edit"),
17
"scopedAccessLevel": string("overview"|"metadata"|"sample"|"data"|"edit"),
18
"accessLevel": string("overview"|"metadata"|"sample"|"data"|"edit")
19
}
Copied!
Get definition
In addition to the base and list definition, any dataset resource returned by a
get request will contain the following properties:1
{
2
"methodologyMarkdown": string,
3
"usageMarkdown": string,
4
"contactInfo": string,
5
"links": [
6
{
7
"title": string,
8
"url": string
9
}
10
],
11
"supportingFiles": [
12
{
13
"name": string,
14
"url": string,
15
"accessLevel": string("overview"|"metadata"|"sample"|"data"),
16
"mimeType": string,
17
"size": int
18
}
19
],
20
"customDocumentationSections": [
21
{
22
"title": string,
23
"accessLevel": string("overview"|"metadata"|"sample"|"data"),
24
"markdownContent": string
25
}
26
],
27
"tags": [
28
{
29
"name": string
30
}
31
],
32
"version": object(version.base),
33
"currentVersion": object(version.base),
34
"nextVersion": object(version.base)
35
}
Copied!
Documentation
Fields
Text
​
Base
​
kind
string
The resource type.
id
string
A unique, persistent identifier for the dataset.
referenceId
string
A persistent, 4-character identifier for this dataset. Will always be unique across all datasets owned by the user / organization.
name
string
The name of the dataset
url
string
The table's url discoverable via the web interface.
uri
string
The fully qualified reference to the dataset, for use in generating calls to this API.
For example,
/datasets/imathews.some_dataset:abc123:v2_0doi
string
The permanent reference to the dataset, using the digital object identifier system. Will be of the form 10.1109/5.771073
Will currently only be present for datasets hosted by organizations that have a DOI registry configured.
owner
object
The owner of the dataset. Will either be an organization or a user
owner.kind
string
One of "organization" or "user"
owner.name
string
The name of the owner organization or user
​
List
​
createdAt
integer
When the dataset was created. Stored as milliseconds since the epoch (1970-01-01).
updatedAt
integer
When the dataset was updated. Stored as milliseconds since the epoch (1970-01-01).
description
string
A user-provided description of the dataset. Corresponds to the "abstract" show on the dataset overview.
tableCount
string
The number of tables on the dataset
numBytes
integer
The size of all tables stored across the current version of the dataset.
totalNumBytes
integer
The total storage size of this dataset, across all versions.
temporalRange
array(integer, integer)
Will be null if no range has been specified. A tuple representing the start and end values for the temporal range. Stored as milliseconds since the epoch (1970-01-01).
​
Note that in the case where
temporalPrecision is "year" or "date", the upper bound of this value will store one millisecond before the next offset. For example:[1980, 1982] =>
[1980-01-01 00:00:00.000, 1982-12-31 23:59:59.999][1990-09-19, 1990-09-24] =>
[1990-09-19 00:00:00.000, 1990-09-24 23:59:59.999]temporalPrecision
string
The precision of the temporal range. Will be one of
"year", "date", "dateTime"Last modified 1mo ago
Copy link