get

/datasets/{owner}/{id}/v/{versionId}

authorization: oauth2

Retrieve a version of a dataset. The definition of the dataset will be returned, not its data.

3 Path Parameters

Responses

OK The request has succeeded.

1 Example
Schema
object
accessLevel
string

The level of access the authenticated user is allowed with respect to dataset:

  • NONE Not allowed any access.
  • READ Allowed to know that the dataset exists, view and download data and metadata.
  • WRITE Allowed to update data and metadata, in addition to what READ allows.
  • ADMIN Allowed to delete dataset, in addition to what WRITE allows.
required
created
string

Date and time when the dataset was created.

required
description
string

Short dataset description.

dois
array[object]
created
string

Data and time when this DOI was associated with the dataset or dataset version.

required
required
files
array[object]

Initial set of files. At dataset creation time, file uploads are not supported. However, this property can be used to add files via URL.

uniqueItems: false
created
string

Date and time when file was created.

required
description
string

File description.

labels
array[string]

File labels.

1 validation
name
string

File name. Should include type extension always when possible. Must not include slashes.

required
sizeInBytes
integer
1 validation
source
object
updated
string

Date and time when file was last updated.

required
id
string

Unique identifier of dataset.

required
isProject
boolean

Every data project on data.world comes with a default dataset linked to it. This flag indicates if the dataset is a project’s default dataset.

required
license
string

Dataset license. Find additional info for allowed values here.

owner
string

User name and unique identifier of the creator of the dataset.

required
status
string

Processing status of dataset. This status can be checked periodically after changes are made to the dataset to determine the status of asynchronous processing.

  • NEW: Just created. Not yet processed.
  • INPROGRESS: Currently being processed.
  • LOADED: Successfully processed.
  • SYSTEMERROR: Error state due to processing failure.
required
summary
string

Long-form dataset summary (Markdown supported).

tags
array[string]

Dataset tags. Letters numbers and spaces only (max 25 characters).

uniqueItems: true
title
string

Dataset name.

required
updated
string

Date and time when the dataset was last updated.

required
version
string

Dataset version

required
versionDois
array[object]
created
string

Data and time when this DOI was associated with the dataset or dataset version.

required
required
visibility
string

Dataset visibility. OPEN if the dataset can be seen by any member of data.world. PRIVATE if the dataset can be seen by its owner and authorized collaborators.

required

Send a Test Request

Path Params
3 path params not set
owner
id
versionId
$$.env
1 variable not set
oauth_access_token