NCnceas
User Datasets

Get a user-defined dataset entry

Changed on

Retrieve the catalog entry for a single public user-defined dataset using its ds_code.

get/user-datasets/{ds_code}

Request

Path parameters

ds_codestring required

Query parameters

create_parquetboolean

If true, return data payload in binary Parquet format

Response

Matching user-defined dataset(s)

ds_codestring

VegBank dataset identifier

accession_codestring

Accession code identifying older VegBank datasets

startstring date

Dataset creation date

stopstring date

User-defined dataset expiration date

namestring

Dataset name

descriptionstring

Dataset description

typestring

Dataset type

owner_labelstring

Name of the dataset creator/owner

owner_emailstring

Email address of dataset creator/owner

py_codestring

VegBank party identifier for the dataset creator/owner

obs_countinteger

Number of plot observations associated with this dataset

Example response

{
  "ds_code": "ds.1",
  "accession_code": "VB.ds.196904.27074B058D5FD45",
  "start": "2006-05-30",
  "stop": "2006-05-30",
  "name": "Example dataset 1",
  "description": "Some plots in North Carolina",
  "type": "normal",
  "owner_label": "Mary Smith",
  "owner_email": "msmith@university.edu",
  "py_code": "py.1",
  "obs_count": 17
}

Changes