NCnceas
Community concepts

Upload community concepts

Changed on
post/community-concepts

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.

deactivation'none' | 'by_party'

Which existing concepts to deactivate in VegBank by setting their status stop date to now:

  • none: Don't dactivate any concepts
  • by_party: Deactivate all concepts associated with any party linked to concepts in the uploaded data

Request body multipart/form-data

community_conceptsstring binary required

Parquet file containing community concepts as community names associated with references, along with with status details and taxonomic parents (required).

community_namesstring binary

Parquet file containing community name usages associated with specific classification systems for new community concepts (optional).

community_correlationsstring binary

Parquet file defining correlations between community concepts (optional).

partiesstring binary

Parquet file containing new parties (optional).

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

      added the new optional query request parameter deactivation

    • info

      added the new optional query request parameter dry_run

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • 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