Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-138386226.8 KB
User Datasets

Create a user dataset

post/user-datasets

Query parameters

dry_runboolean

If true, validates and previews the upload without persisting any data. The response will be wrapped in a dry_run_data envelope.

Request body

namestring required

Display name for the dataset.

descriptionstring

Optional human-readable description of the dataset.

Example request

{
  "name": "Test Dataset 001",
  "description": "A test dataset containing 3 observations.",
  "data": {
    "observation": [
      "ob.2948",
      "ob.2949",
      "ob.2950"
    ]
  }
}

Response

Successful dataset creation. When dry_run=false (default), returns a summary of what was inserted. When dry_run=true, the same summary is nested under dry_run_data and the dataset is not actually created in VegBank.

OR

Example response

{
  "counts": {
    "xx": {
      "inserted": 1
    },
    "yy": {
      "inserted": 2
    },
    "ds": {
      "inserted": 1
    }
  },
  "resources": {
    "xx": [
      {
        "action": "INSERT",
        "user_xx_code": "my_xx_code",
        "vb_xx_code": "xx.123"
      }
    ],
    "yy": [
      {
        "action": "INSERT",
        "user_yy_code": "my_yy_code_1",
        "vb_yy_code": "yy.123"
      }
    ],
    "ds": [
      {
        "action": "INSERT",
        "user_ds_code": "upload_dataset_20260325110254",
        "vb_ds_code": "ds.123"
      }
    ]
  }
}