Version

Base definition

{
"kind": "version",
"tag": string,
"index": integer,
"label": string,
"url": string,
"uri": string,
"datasetUri": string,
"isReleased": bool
}

List definition

In addition to the base definition, any version resource returned by a list request will contain the following properties:

{
"createdAt": integer,
"updatedAt": integer,
"releasedAt": integer
}

Get definition

In addition to the base and list definition, any version resource returned by a get request will contain the following properties:

{
"releaseNotes": string,
"canRelease": boolean
}

Documentation

Fields

Base

kind

string

The resource type. Will always be "version".

tag

string

The version's tag, in the from v1.0. Will always be unique to the version's dataset. If the version is unreleased, the tag will always be next

index

integer

A zero based counter for the version's ordinality for its dataset.

label

string

A user-provided label for the version. May be null.

uri

string

The fully qualified reference to this version, for use in generating calls to this API.

For example, /datasets/imathews.ian_s_dataset:123/versions/v1.0

datasetUri

string

The fully qualified reference to the dataset at this version. For example, /datasets/imathews.ian_s_dataset:123:v1_0

isReleased

boolean

Whether this dataset has been released.

List

createdAt

integer

When the version was created. Stored as milliseconds since the epoch (1970-01-01).

updatedAt

integer

When the version was last modified. Stored as milliseconds since the epoch (1970-01-01).

releasedAt

integer

When the version was released. Stored as milliseconds since the epoch (1970-01-01).

Get

releaseNotes

string

User-provided release notes for the version. May be null.

status

string

An indicator for the status of a version's release. Will be one of:

queued | running | completed | failed

This field will be null before dataset.releaseVersion has been called.

releaseErrorMessage

string

If releaseStatus == "failed" , provides additional information on what caused the release to fail.

canRelease

boolean

Whether the version can be released. If no modifications have been made, or if some uploads are in progress and/or have failed, this will be false. Calling dataset.releaseVersion when this is false will return a 400 error.