NCnceas
Stratum methods

Upload stratum methods

Changed on
post/stratum-methods

Request

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 multipart/form-data

stratum_methodsstring binary required

Parquet file containing stratum methods and their associated component stratum types (required).

referencesstring binary

Parquet file containing new references (optional).

Response

Upload accepted. When dry_run=false (default), returns an upload summary. When dry_run=true, the same summary is nested under dry_run_data and the data is not actually inserted into 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"
      }
    ]
  }
}

Changes

  • 4c741713474dRevision changes
    • breaking

      added the new required request property

    • breaking

      request body became required

    • breaking

      the request's body type changed from array to object

    • breaking

      added subschema #2: DryRunSummary to the response body oneOf list for the response status

    • breaking

      the response's body type changed from array to no type for status

    • info

      the security scope vegbank:admin was added to the endpoint's security scheme oauth2

    • info

      the security scope vegbank:contributor was removed from the endpoint's security scheme oauth2

    • info

      added the new optional query request parameter dry_run

    • info

      added the new optional request property

  • 31e82224728bRevision changes
    • breaking

      the request property type changed from no type to object

    • info

      the endpoint scheme security oauth2 was added to the API